Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.18 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: MedicationDispense | |||
Other Identifiers: : urn:hl7ii:2.16.840.1.113883.10.20.22.4.18:2014-06-09 |
This template records the act of supplying medications (i.e., dispensing).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2Supply
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from CDAR2Supply
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | I | 1..1 | CDAR2Supply | 1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333). |
classCode | 1..1 | code | ||
moodCode | 1..1 | code | Required Pattern: EVN | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.18 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Binding: Medication Fill Status (required) | |
effectiveTime | 0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | ||
repeatNumber | 0..1 | IVL_INT | In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. | |
quantity | 0..1 | PQ | ||
product | 0..1 | Element | ||
manufacturedProduct | 1..1 | |||
manufacturedProduct | ManufacturedProduct(MedicationInformation) | |||
manufacturedProduct | ManufacturedProduct(ImmunizationMedicationInformation) | |||
performer | 0..1 | Performer2 | ||
assignedEntity | 1..1 | AssignedEntity | ||
addr | I | 0..1 | USRealmAddressADUSFIELDED | 1098-10565: The content of addr **SHALL** be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) (CONF:1098-10565). |
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:supply | |
entryRelationship:supplyOrder | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: REFR | |
supply | 1..1 | MedicationSupplyOrder | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | I | 1..1 | CDAR2Supply | 1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333). |
Documentation for this format |
This structure is derived from CDAR2Supply
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2Supply
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | I | 1..1 | CDAR2Supply | 1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333). |
classCode | 1..1 | code | ||
moodCode | 1..1 | code | Required Pattern: EVN | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.18 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Binding: Medication Fill Status (required) | |
effectiveTime | 0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | ||
repeatNumber | 0..1 | IVL_INT | In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. | |
quantity | 0..1 | PQ | ||
product | 0..1 | Element | ||
manufacturedProduct | 1..1 | |||
manufacturedProduct | ManufacturedProduct(MedicationInformation) | |||
manufacturedProduct | ManufacturedProduct(ImmunizationMedicationInformation) | |||
performer | 0..1 | Performer2 | ||
assignedEntity | 1..1 | AssignedEntity | ||
addr | I | 0..1 | USRealmAddressADUSFIELDED | 1098-10565: The content of addr **SHALL** be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) (CONF:1098-10565). |
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:supply | |
entryRelationship:supplyOrder | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: REFR | |
supply | 1..1 | MedicationSupplyOrder | ||
Documentation for this format |
Snapshot View
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.templateId:primary.nullFlavor | required | NullFlavor |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.statusCode.nullFlavor | required | NullFlavor |
Supply.statusCode.code | required | Medication Fill Status |
Supply.priorityCode | extensible | ActPriority |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.subject.typeCode | required | Fixed Value: SBJ |
Supply.subject.contextControlCode | required | Fixed Value: OP |
Supply.subject.awarenessCode | extensible | TargetAwareness |
Supply.performer.nullFlavor | required | NullFlavor |
Supply.performer.typeCode | required | Fixed Value: PRF |
Supply.performer.assignedEntity.classCode | required | Fixed Value: ASSIGNED |
Supply.performer.assignedEntity.code | extensible | RoleCode |
Supply.informant.typeCode | required | Fixed Value: INF |
Supply.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path | Details | Requirements |
1098-9333 | error | Supply | A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333). : | |
81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
1098-10565 | error | Supply.performer.assignedEntity.addr | The content of addr **SHALL** be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) (CONF:1098-10565). : | |
sup-er-1 | error | Supply.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
sup-er-1 | error | Supply.entryRelationship:supplyOrder | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |