abstractbaseDefinitioncopyrightdate- Values Differ
descriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurlversion- Values Differ
| Left: | Planned Supply (http://hl7.org/cda/us/ccda/StructureDefinition/PlannedSupply) |
| Right: | Planned Supply (http://hl7.org/cda/us/ccda/StructureDefinition/PlannedSupply) |
| Error | StructureDefinition.version | Values for version differ: '3.0.0' vs '4.0.0-ballot' |
| Information | StructureDefinition.date | Values for date differ: '2024-05-18T00:16:25-05:00' vs '2024-12-19T00:36:20+00:00' |
| Information | Supply.typeId | StructureDefinition PlannedSupply has added constraint that is not found in PlannedSupply and it is uncertain whether they are compatible (root.exists() or nullFlavor.exists()) |
| Information | Supply.product.typeId | StructureDefinition PlannedSupply has added constraint that is not found in PlannedSupply and it is uncertain whether they are compatible (root.exists() or nullFlavor.exists()) |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/cda/stds/core/StructureDefinition/Supply | ||
| copyright | |||
| date | 2024-05-18T00:16:25-05:00 | 2024-12-19T00:36:20+00:00 |
|
| description | This template represents both medicinal and non-medicinal supplies ordered, requested, or intended for the patient (e.g., medication prescription, order for wheelchair). The importance of the supply order or request to the patient and provider may be indicated in the Priority Preference. The effectiveTime indicates the time when the supply is intended to take place and author time indicates when the documentation of the plan occurred. The Planned Supply template may also indicate the potential insurance coverage for the procedure. Depending on the type of supply, the product or participant will be either a Medication Information product (medication), an Immunization Medication Information product (immunization), or a Product Instance participant (device/equipment). | ||
| experimental | |||
| fhirVersion | 5.0.0 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | logical | ||
| name | PlannedSupply | ||
| publisher | Health Level Seven | ||
| purpose | |||
| status | draft | ||
| title | Planned Supply | ||
| type | http://hl7.org/cda/stds/core/StructureDefinition/Supply | ||
| url | http://hl7.org/cda/us/ccda/StructureDefinition/PlannedSupply | ||
| version | 3.0.0 | 4.0.0-ballot |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments |
|---|---|---|---|---|---|---|---|---|---|
 Supply | C | 1..1 | Supply | Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') should-author: SHOULD contain author | C | 1..1 | Supply | Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') should-author: SHOULD contain author | |
 nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| realmCode | 0..* | CS | 0..* | CS | |||||
 typeId | 0..1 | II | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| ||
 nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
| displayable | 0..1 | ?? | 0..1 | ?? | |||||
| root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
 st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |||
| classCode | 1..1 | ?? | Binding: ?? (required) Fixed Value: SPLY | 1..1 | ?? | Binding: ?? (required) Fixed Value: SPLY | |||
| moodCode | 1..1 | ?? | Binding: ?? (required) | 1..1 | ?? | Binding: ?? (required) | |||
| id | 1..* | II | 1..* | II | |||||
| code | 0..1 | CD | Binding: ?? (example) | 0..1 | CD | Binding: ?? (example) | |||
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |||
| nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| compression | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| integrityCheck | 0..1 | ?? | 0..1 | ?? | |||||
| integrityCheckAlgorithm | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| language | 0..1 | ?? | 0..1 | ?? | |||||
| mediaType | 0..1 | ?? | Binding: ?? (example) | 0..1 | ?? | Binding: ?? (example) | |||
| representation | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| xmlText | 0..1 | ?? | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | 0..1 | ?? | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |||
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | |
| thumbnail | 0..1 | ED | 0..1 | ED | |||||
| statusCode | 1..1 | CS | Binding: ?? (required) | 1..1 | CS | Binding: ?? (required) | |||
| nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| code | 1..1 | ?? | Fixed Value: active | 1..1 | ?? | Fixed Value: active | |||
| codeSystem | 0..0 | 0..0 | |||||||
| codeSystemName | 0..0 | 0..0 | |||||||
| codeSystemVersion | 0..0 | 0..0 | |||||||
| displayName | 0..0 | 0..0 | |||||||
| sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | |||
| sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | |||
| originalText | 0..0 | 0..0 | |||||||
| qualifier | 0..0 | 0..0 | |||||||
| translation | 0..0 | 0..0 | |||||||
| effectiveTime | 0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | The effectiveTime in a planned supply represents the time that the supply should occur. | 0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | The effectiveTime in a planned supply represents the time that the supply should occur. | |||
| priorityCode | 0..* | CE | Binding: ?? (example) | 0..* | CE | Binding: ?? (example) | |||
| repeatNumber | 0..1 | IVL_INT | In a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4. | 0..1 | IVL_INT | In a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4. | |||
| independentInd | 0..1 | BL | 0..1 | BL | |||||
| quantity | 0..1 | PQ | 0..1 | PQ | |||||
| expectedUseTime | 0..1 | IVL_TS | 0..1 | IVL_TS | |||||
| product | 0..1 | InfrastructureRoot | Represents either a medication or an immunization supply | 0..1 | InfrastructureRoot | Represents either a medication or an immunization supply | |||
| nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| realmCode | 0..* | CS | 0..* | CS | |||||
| typeId | 0..1 | II | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| ||
| nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
| assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
| displayable | 0..1 | ?? | 0..1 | ?? | |||||
| root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
| st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
| templateId | 0..* | II | 0..* | II | |||||
| typeCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: PRD | 0..1 | ?? | Binding: ?? (required) Fixed Value: PRD | |||
| manufacturedProduct | C | 1..1 | ??, ?? | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) | C | 1..1 | ??, ?? | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) | |
| subject | 0..1 | Subject | 0..1 | Subject | |||||
| specimen | 0..* | Specimen | 0..* | Specimen | |||||
| performer | 0..* | Performer2 | The clinician who is expected to perform the supply could be identified using supply/performer. | 0..* | Performer2 | The clinician who is expected to perform the supply could be identified using supply/performer. | |||
| author | 0..1 | ?? | The author in a supply represents the clinician who is requesting or planning the supply. | 0..1 | ?? | The author in a supply represents the clinician who is requesting or planning the supply. | |||
| informant | 0..* | Informant | 0..* | Informant | |||||
| Slices for participant | 0..* | Participant2 | This participant represents a device that is ordered, requested or intended for the patient. Slice: Unordered, Open by value:typeCode | 0..* | Participant2 | This participant represents a device that is ordered, requested or intended for the patient. Slice: Unordered, Open by value:typeCode | |||
| Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation | 0..* | EntryRelationship | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation | |||
| reference | 0..* | Reference | 0..* | Reference | |||||
| precondition | 0..* | Precondition | 0..* | Precondition | |||||
| sdtcInFulfillmentOf1 | 0..* | InFulfillmentOf1 | XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | 0..* | InFulfillmentOf1 | XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |||
| Documentation for this format | |||||||||