Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Medication Dispense

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.18 Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: MedicationDispense
Other Identifiers: id: 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:

Formal Views of Profile Content

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

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C1..1CDAR2SupplyBase for all types and resources
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
... classCode 1..1code
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringBinding: Medication Fill Status (required)
... effectiveTime 0..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... repeatNumber 0..1IVL_INTIn "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..1PQ
... product 0..1Element
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... performer 0..1Performer2
.... assignedEntity 1..1AssignedEntity
..... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
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..*ElementSlice: Unordered, Open by profile:supply
.... entryRelationship:supplyOrder 0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... supply 1..1MedicationSupplyOrderBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.statusCode.coderequiredMedication Fill Status

Constraints

IdGradePath(s)DetailsRequirements
1098-9333errorSupplyA supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
:
1098-10565errorSupply.performer.assignedEntity.addrThe 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).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C1..1CDAR2SupplyBase for all types and resources
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringBinding: Medication Fill Status (required)
... effectiveTime 0..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... repeatNumber 0..1IVL_INTIn "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..1PQ
... product 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... performer 0..1Performer2
.... assignedEntity 1..1AssignedEntity
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... id 1..*II
..... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
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 C0..*ElementSlice: Unordered, Open by profile:supply
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:supplyOrder C0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... contextConductionInd 1..1boolean
..... supply 1..1MedicationSupplyOrderBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.statusCoderequiredActStatus
Supply.statusCode.coderequiredMedication Fill Status
Supply.product.typeCoderequiredFixed Value: PRD
Supply.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED

Constraints

IdGradePath(s)DetailsRequirements
1098-9333errorSupplyA supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
:
1098-10565errorSupply.performer.assignedEntity.addrThe 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).
:
81-7296errorSupply.performer.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
sup-er-1errorSupply.entryRelationship, Supply.entryRelationship:supplyOrderOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C1..1CDAR2SupplyBase for all types and resources
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeRequired Pattern: EVN
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringBinding: Medication Fill Status (required)
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn "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.
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..1Performer2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
.... time 0..1IVL_TS
.... modeCode 0..1CE
.... assignedEntity 1..1AssignedEntity
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
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).
..... telecom 0..*TEL
..... assignedPerson 0..1Person
..... representedOrganization 0..1Organization
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:supply
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:supplyOrder C0..1Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... supply 1..1MedicationSupplyOrderBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.templateId:primary.nullFlavorrequiredNullFlavor
Supply.codeextensibleActCode
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredNullFlavor
Supply.statusCode.coderequiredMedication Fill Status
Supply.priorityCodeextensibleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.performer.nullFlavorrequiredNullFlavor
Supply.performer.typeCoderequiredFixed Value: PRF
Supply.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
Supply.performer.assignedEntity.codeextensibleRoleCode
Supply.informant.typeCoderequiredFixed Value: INF
Supply.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1098-10565errorSupply.performer.assignedEntity.addrThe 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).
:
81-7296errorSupply.performer.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sup-er-1errorSupply.entryRelationship, Supply.entryRelationship:supplyOrderOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

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:

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

Differential View

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C1..1CDAR2SupplyBase for all types and resources
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
... classCode 1..1code
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringBinding: Medication Fill Status (required)
... effectiveTime 0..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... repeatNumber 0..1IVL_INTIn "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..1PQ
... product 0..1Element
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... performer 0..1Performer2
.... assignedEntity 1..1AssignedEntity
..... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
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..*ElementSlice: Unordered, Open by profile:supply
.... entryRelationship:supplyOrder 0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... supply 1..1MedicationSupplyOrderBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.statusCode.coderequiredMedication Fill Status

Constraints

IdGradePath(s)DetailsRequirements
1098-9333errorSupplyA supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
:
1098-10565errorSupply.performer.assignedEntity.addrThe 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).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C1..1CDAR2SupplyBase for all types and resources
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringBinding: Medication Fill Status (required)
... effectiveTime 0..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... repeatNumber 0..1IVL_INTIn "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..1PQ
... product 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... performer 0..1Performer2
.... assignedEntity 1..1AssignedEntity
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... id 1..*II
..... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
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 C0..*ElementSlice: Unordered, Open by profile:supply
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:supplyOrder C0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... contextConductionInd 1..1boolean
..... supply 1..1MedicationSupplyOrderBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.statusCoderequiredActStatus
Supply.statusCode.coderequiredMedication Fill Status
Supply.product.typeCoderequiredFixed Value: PRD
Supply.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED

Constraints

IdGradePath(s)DetailsRequirements
1098-9333errorSupplyA supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
:
1098-10565errorSupply.performer.assignedEntity.addrThe 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).
:
81-7296errorSupply.performer.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
sup-er-1errorSupply.entryRelationship, Supply.entryRelationship:supplyOrderOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C1..1CDAR2SupplyBase for all types and resources
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeRequired Pattern: EVN
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringBinding: Medication Fill Status (required)
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn "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.
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..1Performer2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
.... time 0..1IVL_TS
.... modeCode 0..1CE
.... assignedEntity 1..1AssignedEntity
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
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).
..... telecom 0..*TEL
..... assignedPerson 0..1Person
..... representedOrganization 0..1Organization
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:supply
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:supplyOrder C0..1Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... supply 1..1MedicationSupplyOrderBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.templateId:primary.nullFlavorrequiredNullFlavor
Supply.codeextensibleActCode
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredNullFlavor
Supply.statusCode.coderequiredMedication Fill Status
Supply.priorityCodeextensibleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.performer.nullFlavorrequiredNullFlavor
Supply.performer.typeCoderequiredFixed Value: PRF
Supply.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
Supply.performer.assignedEntity.codeextensibleRoleCode
Supply.informant.typeCoderequiredFixed Value: INF
Supply.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1098-10565errorSupply.performer.assignedEntity.addrThe 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).
:
81-7296errorSupply.performer.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sup-er-1errorSupply.entryRelationship, Supply.entryRelationship:supplyOrderOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

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:

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

 

​Other representations of profile: CSV, Excel, Schematron