Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationDispense | Version: 2.1 | |||
Draft as of 2023-09-29 | Computable Name: MedicationDispense | |||
Other Identifiers: id: 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 Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2Supply
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | C | 1..1 | CDAR2Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources 4537-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). |
classCode | 1..1 | cs | ||
moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
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 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: VSAC 2.16.840.1.113883.4.642.3.1312 (required) | |
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 | ||
quantity | 0..1 | PQ | ||
product | 0..1 | InfrastructureRoot | ||
manufacturedProduct | 1..1 | MedicationInformation | Base for all types and resources | |
performer | 0..1 | Performer2 | ||
assignedEntity | 1..1 | AssignedEntity | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources 4537-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:4537-10565). |
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value: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 |
Supply.code | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.3.1312 |
Id | Grade | Path(s) | Details | Requirements |
4537-9333 | error | Supply | A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). : | |
4537-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:4537-10565). : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | C | 1..1 | CDAR2Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources 4537-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). |
@classCode | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
@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 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: VSAC 2.16.840.1.113883.4.642.3.1312 (required) | |
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 | ||
quantity | 0..1 | PQ | ||
product | 0..1 | InfrastructureRoot | ||
manufacturedProduct | 1..1 | MedicationInformation | Base for all types and resources | |
performer | 0..1 | Performer2 | ||
assignedEntity | 1..1 | AssignedEntity | ||
id | 1..* | II | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources 4537-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:4537-10565). |
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:supply, value:typeCode | |
entryRelationship:entryRelationship1 | 0..1 | EntryRelationship | entryRelationship | |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
supply | 1..1 | MedicationSupplyOrder | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.code | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.3.1312 |
Supply.statusCode | required | ActStatus |
Supply.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
Id | Grade | Path(s) | Details | Requirements |
4537-9333 | error | Supply | A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). : | |
4537-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:4537-10565). : | |
81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.templateId:templateId1.nullFlavor | required | NullFlavor |
Supply.code | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.3.1312 |
Supply.statusCode | required | ActStatus |
Supply.statusCode.nullFlavor | required | NullFlavor |
Supply.priorityCode | extensible | ActPriority |
Supply.product.nullFlavor | required | NullFlavor |
Supply.product.typeCode | required | Fixed Value: PRD |
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.entryRelationship:entryRelationship1.nullFlavor | required | NullFlavor |
Supply.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
Id | Grade | Path(s) | Details | Requirements |
4537-9333 | error | Supply | A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). : | |
4537-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:4537-10565). : | |
81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2Supply
Summary
Mandatory: 8 elements (1 nested mandatory element)
Fixed Value: 3 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 | C | 1..1 | CDAR2Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources 4537-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). |
classCode | 1..1 | cs | ||
moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
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 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: VSAC 2.16.840.1.113883.4.642.3.1312 (required) | |
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 | ||
quantity | 0..1 | PQ | ||
product | 0..1 | InfrastructureRoot | ||
manufacturedProduct | 1..1 | MedicationInformation | Base for all types and resources | |
performer | 0..1 | Performer2 | ||
assignedEntity | 1..1 | AssignedEntity | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources 4537-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:4537-10565). |
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value: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 |
Supply.code | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.3.1312 |
Id | Grade | Path(s) | Details | Requirements |
4537-9333 | error | Supply | A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). : | |
4537-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:4537-10565). : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | C | 1..1 | CDAR2Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources 4537-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). |
@classCode | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
@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 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: VSAC 2.16.840.1.113883.4.642.3.1312 (required) | |
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 | ||
quantity | 0..1 | PQ | ||
product | 0..1 | InfrastructureRoot | ||
manufacturedProduct | 1..1 | MedicationInformation | Base for all types and resources | |
performer | 0..1 | Performer2 | ||
assignedEntity | 1..1 | AssignedEntity | ||
id | 1..* | II | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources 4537-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:4537-10565). |
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:supply, value:typeCode | |
entryRelationship:entryRelationship1 | 0..1 | EntryRelationship | entryRelationship | |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
supply | 1..1 | MedicationSupplyOrder | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.code | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.3.1312 |
Supply.statusCode | required | ActStatus |
Supply.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
Id | Grade | Path(s) | Details | Requirements |
4537-9333 | error | Supply | A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). : | |
4537-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:4537-10565). : | |
81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.templateId:templateId1.nullFlavor | required | NullFlavor |
Supply.code | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.3.1312 |
Supply.statusCode | required | ActStatus |
Supply.statusCode.nullFlavor | required | NullFlavor |
Supply.priorityCode | extensible | ActPriority |
Supply.product.nullFlavor | required | NullFlavor |
Supply.product.typeCode | required | Fixed Value: PRD |
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.entryRelationship:entryRelationship1.nullFlavor | required | NullFlavor |
Supply.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
Id | Grade | Path(s) | Details | Requirements |
4537-9333 | error | Supply | A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:4537-9333). : | |
4537-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:4537-10565). : | |
81-7296 | error | Supply.performer.assignedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2Supply
Summary
Mandatory: 8 elements (1 nested mandatory element)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: