Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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 Supply Order

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationSupplyOrder Version: 2.1
Draft as of 2023-09-29 Computable Name: MedicationSupplyOrder
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09

This template records the intent to supply a patient with medications.

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 CDAR2SupplyXML 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
... classCode 1..1cs
... moodCode 1..1csFixed Value: INT
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.17
..... extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1csBinding: ActStatus (required)
... Slices for effectiveTime 0..*SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TSSlice: Unordered, Open by value:high
.... effectiveTime:when 0..1IVL_TS
..... high 1..1IVXB_TS
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
... quantity 0..1PQ
... product 0..1InfrastructureRoot
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... author 0..1Author
... entryRelationship 0..1EntryRelationship
.... typeCode 1..1csFixed Value: SUBJ
.... inversionInd 1..1blFixed Value: true
.... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.statusCode.coderequiredActStatus
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML 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
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csFixed Value: INT
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.17
..... @extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: ActStatus (required)
... Slices for effectiveTime 0..*Slice: Unordered, Open by value:high
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
.... effectiveTime:when 0..1IVL_TS
..... high 1..1IVXB_TS
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
... quantity 0..1PQ
... product 0..1InfrastructureRoot
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... author 0..1Author
... entryRelationship 0..1EntryRelationship
.... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
.... @inversionInd 1..1blFixed Value: true
.... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.statusCoderequiredActStatus
Supply.statusCode.coderequiredActStatus
Supply.entryRelationship.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML 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
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csFixed Value: INT
... realmCode 0..*CS
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.17
..... @extension 1..1stRequired 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..1csBinding: NullFlavor (required)
.... @code 1..1csBinding: ActStatus (required)
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... Slices for effectiveTime 0..*Slice: Unordered, Open by value:high
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
.... effectiveTime:when 0..1IVL_TS
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
..... @operator 0..1csBinding: SetOperator (required)
..... low 0..1IVXB_TS
..... center 0..1TS
..... width 0..1PQ
..... high 1..1IVXB_TS
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..1Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..1EntryRelationship
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
.... @inversionInd 1..1blFixed Value: true
.... @contextConductionInd 0..1bl
.... @negationInd 0..1bl
.... sequenceNumber 0..1INT
.... seperatableInd 0..1BL
.... act 1..1InstructionBase for all types and resources
.... encounter 0..1Encounter
.... observation 0..1Observation
.... observationMedia 0..1ObservationMedia
.... organizer 0..1Organizer
.... procedure 0..1Procedure
.... regionOfInterest 0..1RegionOfInterest
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
... reference 0..*Reference
... 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.coderequiredActStatus
Supply.effectiveTime:when.nullFlavorrequiredNullFlavor
Supply.effectiveTime:when.operatorrequiredSetOperator
Supply.priorityCodeextensibleActPriority
Supply.product.nullFlavorrequiredNullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.entryRelationship.nullFlavorrequiredNullFlavor
Supply.entryRelationship.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2Supply

Summary

Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 3 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.effectiveTime is sliced based on the value of value:high

Differential View

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply CDAR2SupplyXML 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
... classCode 1..1cs
... moodCode 1..1csFixed Value: INT
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.17
..... extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1csBinding: ActStatus (required)
... Slices for effectiveTime 0..*SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TSSlice: Unordered, Open by value:high
.... effectiveTime:when 0..1IVL_TS
..... high 1..1IVXB_TS
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
... quantity 0..1PQ
... product 0..1InfrastructureRoot
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... author 0..1Author
... entryRelationship 0..1EntryRelationship
.... typeCode 1..1csFixed Value: SUBJ
.... inversionInd 1..1blFixed Value: true
.... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.statusCode.coderequiredActStatus

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML 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
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csFixed Value: INT
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.17
..... @extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: ActStatus (required)
... Slices for effectiveTime 0..*Slice: Unordered, Open by value:high
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
.... effectiveTime:when 0..1IVL_TS
..... high 1..1IVXB_TS
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
... quantity 0..1PQ
... product 0..1InfrastructureRoot
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... author 0..1Author
... entryRelationship 0..1EntryRelationship
.... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
.... @inversionInd 1..1blFixed Value: true
.... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.statusCoderequiredActStatus
Supply.statusCode.coderequiredActStatus
Supply.entryRelationship.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML 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
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csFixed Value: INT
... realmCode 0..*CS
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.17
..... @extension 1..1stRequired 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..1csBinding: NullFlavor (required)
.... @code 1..1csBinding: ActStatus (required)
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... Slices for effectiveTime 0..*Slice: Unordered, Open by value:high
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
.... effectiveTime:when 0..1IVL_TS
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
..... @operator 0..1csBinding: SetOperator (required)
..... low 0..1IVXB_TS
..... center 0..1TS
..... width 0..1PQ
..... high 1..1IVXB_TS
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..1Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..1EntryRelationship
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
.... @inversionInd 1..1blFixed Value: true
.... @contextConductionInd 0..1bl
.... @negationInd 0..1bl
.... sequenceNumber 0..1INT
.... seperatableInd 0..1BL
.... act 1..1InstructionBase for all types and resources
.... encounter 0..1Encounter
.... observation 0..1Observation
.... observationMedia 0..1ObservationMedia
.... organizer 0..1Organizer
.... procedure 0..1Procedure
.... regionOfInterest 0..1RegionOfInterest
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
... reference 0..*Reference
... 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.coderequiredActStatus
Supply.effectiveTime:when.nullFlavorrequiredNullFlavor
Supply.effectiveTime:when.operatorrequiredSetOperator
Supply.priorityCodeextensibleActPriority
Supply.product.nullFlavorrequiredNullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.entryRelationship.nullFlavorrequiredNullFlavor
Supply.entryRelationship.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2Supply

Summary

Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 3 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.effectiveTime is sliced based on the value of value:high

 

Other representations of profile: CSV, Excel