Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationDispense | Version: 3.0.0 | |||
| Draft as of 2024-07-23 | Computable Name: MedicationDispense | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.18:2023-05-01 | ||||
This template records the act of supplying medications (i.e., dispensing). The moodCode equaling “EVN” (Event), signals that the “supply” has occurred and thus has been dispensed.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Supply
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 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 should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:med-dispense |
1..1 | II | ||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.18 | |
  @extension |
1..1 | st | Required Pattern: 2023-05-01 | |
 @classCode |
1..1 | cs | ||
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code. Binding: MedicationDispenseStatusCodes (required) | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
 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 |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| effectiveTime |
0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | ||
| repeatNumber |
0..1 | IVL_INT | In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense. | |
| quantity |
0..1 | PQ | ||
| product |
1..1 | InfrastructureRoot | ||
 manufacturedProduct |
1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
| performer |
0..1 | Performer2 | ||
 assignedEntity |
C | 1..1 | AssignedEntity | should-addr: SHOULD contain addr |
| addr |
0..1 | USRealmAddress | Base for all types and resources | |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, value:typeCode | |
| entryRelationship:entryRelationship1 |
0..1 | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| supply |
1..1 | MedicationSupplyOrder | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Supply.code | required | MedicationDispenseStatusCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| should-addr | warning | Supply.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-quantity | warning | Supply | SHOULD contain quantity : quantity.exists() | |
| should-repeatNumber | warning | Supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 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 should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-dispense |
1..1 | II | ||
 @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.18 | |
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |
| @classCode |
1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code. Binding: MedicationDispenseStatusCodes (required) | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| 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 |
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
 effectiveTime |
0..1 | |||
 effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| repeatNumber |
0..1 | IVL_INT | In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense. | |
| quantity |
0..1 | PQ | ||
| product |
1..1 | InfrastructureRoot | ||
| manufacturedProduct |
C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
| performer |
0..1 | Performer2 | ||
| assignedEntity |
C | 1..1 | AssignedEntity | should-addr: SHOULD contain addr |
| id |
1..* | II | ||
| addr |
C | 0..1 | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, value:typeCode | |
| entryRelationship:entryRelationship1 |
0..1 | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| supply |
C | 1..1 | MedicationSupplyOrder | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
| Supply.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| Supply.code | required | MedicationDispenseStatusCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-statusfrom the FHIR Standard | |
| Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Supply.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | Supply.performer.assignedEntity.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | Supply.performer.assignedEntity.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| shall-city | error | Supply.performer.assignedEntity.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | Supply.performer.assignedEntity.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | Supply.performer.assignedEntity.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | Supply.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-country | warning | Supply.performer.assignedEntity.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-quantity | warning | Supply | SHOULD contain quantity : quantity.exists() | |
| should-quantity | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain quantity : quantity.exists() | |
| should-repeatNumber | warning | Supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-repeatNumber | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-use | warning | Supply.performer.assignedEntity.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 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 should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-dispense |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.18 | |
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |
| @classCode |
1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code. Binding: MedicationDispenseStatusCodes (required) | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | 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 |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime |
0..1 | |||
| effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| priorityCode |
0..* | CE | Binding: ActPriority (example) | |
| repeatNumber |
0..1 | IVL_INT | In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense. | |
| independentInd |
0..1 | BL | ||
| quantity |
0..1 | PQ | ||
| expectedUseTime |
0..1 | IVL_TS | ||
| product |
1..1 | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
| manufacturedProduct |
C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..1 | Performer2 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| modeCode |
0..1 | CE | ||
| assignedEntity |
C | 1..1 | AssignedEntity | should-addr: SHOULD contain addr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
C | 0..1 | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| telecom |
0..* | TEL | ||
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, value:typeCode | |
| entryRelationship:entryRelationship1 |
0..1 | EntryRelationship | entryRelationship | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
0..1 | II | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
C | 1..1 | MedicationSupplyOrder | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.templateId:med-dispense.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
| Supply.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| Supply.code | required | MedicationDispenseStatusCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-statusfrom the FHIR Standard | |
| Supply.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Supply.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Supply.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Supply.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Supply.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect | |
| Supply.performer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.performer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.performer.typeCode | required | Fixed Value: PRFhttp://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer | |
| Supply.performer.assignedEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.performer.assignedEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.performer.assignedEntity.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
| Supply.performer.assignedEntity.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
| Supply.entryRelationship:entryRelationship1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:entryRelationship1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | Supply.performer.assignedEntity.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | Supply.performer.assignedEntity.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| shall-city | error | Supply.performer.assignedEntity.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | Supply.performer.assignedEntity.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | Supply.performer.assignedEntity.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | Supply.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-country | warning | Supply.performer.assignedEntity.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-quantity | warning | Supply | SHOULD contain quantity : quantity.exists() | |
| should-quantity | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain quantity : quantity.exists() | |
| should-repeatNumber | warning | Supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-repeatNumber | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-use | warning | Supply.performer.assignedEntity.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Supply
Summary
Mandatory: 9 elements(1 nested mandatory element)
Fixed: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Supply
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 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 should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-dispense |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.18 | |
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |
| @classCode |
1..1 | cs | ||
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code. Binding: MedicationDispenseStatusCodes (required) | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| 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 |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| effectiveTime |
0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | ||
| repeatNumber |
0..1 | IVL_INT | In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense. | |
| quantity |
0..1 | PQ | ||
| product |
1..1 | InfrastructureRoot | ||
| manufacturedProduct |
1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
| performer |
0..1 | Performer2 | ||
| assignedEntity |
C | 1..1 | AssignedEntity | should-addr: SHOULD contain addr |
| addr |
0..1 | USRealmAddress | Base for all types and resources | |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, value:typeCode | |
| entryRelationship:entryRelationship1 |
0..1 | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| supply |
1..1 | MedicationSupplyOrder | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Supply.code | required | MedicationDispenseStatusCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| should-addr | warning | Supply.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-quantity | warning | Supply | SHOULD contain quantity : quantity.exists() | |
| should-repeatNumber | warning | Supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 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 should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-dispense |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.18 | |
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |
| @classCode |
1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code. Binding: MedicationDispenseStatusCodes (required) | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| 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 |
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| effectiveTime |
0..1 | |||
| effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| repeatNumber |
0..1 | IVL_INT | In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense. | |
| quantity |
0..1 | PQ | ||
| product |
1..1 | InfrastructureRoot | ||
| manufacturedProduct |
C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
| performer |
0..1 | Performer2 | ||
| assignedEntity |
C | 1..1 | AssignedEntity | should-addr: SHOULD contain addr |
| id |
1..* | II | ||
| addr |
C | 0..1 | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, value:typeCode | |
| entryRelationship:entryRelationship1 |
0..1 | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| supply |
C | 1..1 | MedicationSupplyOrder | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
| Supply.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| Supply.code | required | MedicationDispenseStatusCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-statusfrom the FHIR Standard | |
| Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Supply.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | Supply.performer.assignedEntity.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | Supply.performer.assignedEntity.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| shall-city | error | Supply.performer.assignedEntity.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | Supply.performer.assignedEntity.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | Supply.performer.assignedEntity.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | Supply.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-country | warning | Supply.performer.assignedEntity.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-quantity | warning | Supply | SHOULD contain quantity : quantity.exists() | |
| should-quantity | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain quantity : quantity.exists() | |
| should-repeatNumber | warning | Supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-repeatNumber | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-use | warning | Supply.performer.assignedEntity.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 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 should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-dispense |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.18 | |
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |
| @classCode |
1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code. Binding: MedicationDispenseStatusCodes (required) | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | 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 |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime |
0..1 | |||
| effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| priorityCode |
0..* | CE | Binding: ActPriority (example) | |
| repeatNumber |
0..1 | IVL_INT | In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense. | |
| independentInd |
0..1 | BL | ||
| quantity |
0..1 | PQ | ||
| expectedUseTime |
0..1 | IVL_TS | ||
| product |
1..1 | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
| manufacturedProduct |
C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..1 | Performer2 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| modeCode |
0..1 | CE | ||
| assignedEntity |
C | 1..1 | AssignedEntity | should-addr: SHOULD contain addr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
C | 0..1 | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| telecom |
0..* | TEL | ||
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, value:typeCode | |
| entryRelationship:entryRelationship1 |
0..1 | EntryRelationship | entryRelationship | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
C | 1..1 | MedicationSupplyOrder | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity |
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.templateId:med-dispense.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
| Supply.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| Supply.code | required | MedicationDispenseStatusCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-statusfrom the FHIR Standard | |
| Supply.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Supply.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Supply.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Supply.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Supply.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect | |
| Supply.performer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.performer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.performer.typeCode | required | Fixed Value: PRFhttp://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer | |
| Supply.performer.assignedEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.performer.assignedEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.performer.assignedEntity.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
| Supply.performer.assignedEntity.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
| Supply.entryRelationship:entryRelationship1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:entryRelationship1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | Supply.performer.assignedEntity.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | Supply.performer.assignedEntity.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| shall-city | error | Supply.performer.assignedEntity.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | Supply.performer.assignedEntity.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | Supply.performer.assignedEntity.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | Supply.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-country | warning | Supply.performer.assignedEntity.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-quantity | warning | Supply | SHOULD contain quantity : quantity.exists() | |
| should-quantity | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain quantity : quantity.exists() | |
| should-repeatNumber | warning | Supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-repeatNumber | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain repeatNumber : repeatNumber.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Supply.entryRelationship:entryRelationship1.supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-use | warning | Supply.performer.assignedEntity.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Supply
Summary
Mandatory: 9 elements(1 nested mandatory element)
Fixed: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0 based on FHIR 5.0.0. Generated 2024-07-23
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change