Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

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

## Logical Model: Medication Dispense

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:

- Use this Logical Model: Immunization Activity and Medication Activity

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

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

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Supply.code | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.3.1312

#### Constraints

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

#### Terminology Bindings

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

#### Constraints

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()) |

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
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:templateId1 |  | 1..1 | II | templateId
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (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
id |  | 1..* | II |
code |  | 1..1 | CD | Binding: VSAC 2.16.840.1.113883.4.642.3.1312 (required)
text |  | 0..1 | ED |
statusCode |  | 1..1 | CS | Binding: ActStatus (required)
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (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 (extensible)
repeatNumber |  | 0..1 | IVL_INT |
independentInd |  | 0..1 | BL |
quantity |  | 0..1 | PQ |
expectedUseTime |  | 0..1 | IVL_TS |
product |  | 0..1 | InfrastructureRoot |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD
manufacturedProduct |  | 1..1 | MedicationInformation | Base for all types and resources
subject |  | 0..1 | Subject |
specimen |  | 0..* | Specimen |
performer |  | 0..1 | Performer2 |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@typeCode |  | 0..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
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 |  | 1..1 | AssignedEntity |
@classCode |  | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED
templateId |  | 0..* | II |
id |  | 1..* | II |
sdtcIdentifiedBy |  | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code |  | 0..1 | CE | Binding: v3 Code System RoleCode (extensible)
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).
telecom |  | 0..* | TEL |
assignedPerson |  | 0..1 | Person |
representedOrganization |  | 0..1 | Organization |
author |  | 0..* | Author |
informant |  | 0..* | Informant |
participant |  | 0..* | Participant2 |
Slices for entryRelationship |  | 0..* | EntryRelationship | Slice: Unordered, Open by value:supply, value:typeCode
entryRelationship:entryRelationship1 |  | 0..1 | EntryRelationship | entryRelationship
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
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 |  | 1..1 | MedicationSupplyOrder | Base for all types and resources
reference |  | 0..* | Reference |
precondition |  | 0..* | Precondition |
Documentation for this format

#### Terminology Bindings

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

#### Constraints

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:

- Medication Information (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationInformation)
- US Realm Address (AD.US.FIELDED) (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED)
- Medication Supply Order (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationSupplyOrder)

Slices

This structure defines the following Slices:

- The element Supply.templateId is sliced based on the values of value:root, value:extension
- The element Supply.entryRelationship is sliced based on the values of value:supply, value:typeCode

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

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Supply.code | required | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.3.1312

#### Constraints

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

#### Terminology Bindings

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

#### Constraints

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

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
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:templateId1 |  | 1..1 | II | templateId
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (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
id |  | 1..* | II |
code |  | 1..1 | CD | Binding: VSAC 2.16.840.1.113883.4.642.3.1312 (required)
text |  | 0..1 | ED |
statusCode |  | 1..1 | CS | Binding: ActStatus (required)
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (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 (extensible)
repeatNumber |  | 0..1 | IVL_INT |
independentInd |  | 0..1 | BL |
quantity |  | 0..1 | PQ |
expectedUseTime |  | 0..1 | IVL_TS |
product |  | 0..1 | InfrastructureRoot |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD
manufacturedProduct |  | 1..1 | MedicationInformation | Base for all types and resources
subject |  | 0..1 | Subject |
specimen |  | 0..* | Specimen |
performer |  | 0..1 | Performer2 |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@typeCode |  | 0..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
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 |  | 1..1 | AssignedEntity |
@classCode |  | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED
templateId |  | 0..* | II |
id |  | 1..* | II |
sdtcIdentifiedBy |  | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code |  | 0..1 | CE | Binding: v3 Code System RoleCode (extensible)
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).
telecom |  | 0..* | TEL |
assignedPerson |  | 0..1 | Person |
representedOrganization |  | 0..1 | Organization |
author |  | 0..* | Author |
informant |  | 0..* | Informant |
participant |  | 0..* | Participant2 |
Slices for entryRelationship |  | 0..* | EntryRelationship | Slice: Unordered, Open by value:supply, value:typeCode
entryRelationship:entryRelationship1 |  | 0..1 | EntryRelationship | entryRelationship
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
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 |  | 1..1 | MedicationSupplyOrder | Base for all types and resources
reference |  | 0..* | Reference |
precondition |  | 0..* | Precondition |
Documentation for this format

#### Terminology Bindings

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

#### Constraints

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:

- Medication Information (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationInformation)
- US Realm Address (AD.US.FIELDED) (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED)
- Medication Supply Order (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationSupplyOrder)

Slices

This structure defines the following Slices:

- The element Supply.templateId is sliced based on the values of value:root, value:extension
- The element Supply.entryRelationship is sliced based on the values of value:supply, value:typeCode

Other representations of profile: CSV, Excel