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

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.17 Version: 2.1.0-draft1
Active as of 2023-01-16 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 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1code
... moodCode 1..1codeRequired Pattern: INT
... 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.17
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringBinding: 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..1TS
... 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..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... author 0..1Author
... entryRelationship 0..1Element
.... typeCode 1..1codeRequired Pattern: SUBJ
.... inversionInd 1..1booleanRequired Pattern: 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..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeRequired Pattern: INT
... 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.17
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringBinding: 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..1TS
... 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..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... author 0..1Author
... entryRelationship C0..1Element
.... typeCode 1..1codeRequired Pattern: SUBJ
.... inversionInd 1..1booleanRequired Pattern: true
.... contextConductionInd 1..1boolean
.... 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.product.typeCoderequiredFixed Value: PRD

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
sup-er-1errorSupply.entryRelationshipOnly 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 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeRequired Pattern: INT
... 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.17
..... 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: ActStatus (required)
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: 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..1codeBinding: NullFlavor (required)
..... value 0..1dateTime
..... inclusive 0..1boolean
..... operator 0..1code
..... low 0..1TS
..... high 1..1TS
..... width 0..1PQ
..... center 0..1TS
... 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..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... 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..*Performer2
... author 0..1Author
... 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
... entryRelationship 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: SUBJ
.... inversionInd 1..1booleanRequired Pattern: true
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... act 1..1InstructionBase 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.coderequiredActStatus
Supply.effectiveTime:when.nullFlavorrequiredNullFlavor
Supply.priorityCodeextensibleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.informant.typeCoderequiredFixed Value: INF
Supply.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
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.entryRelationshipOnly 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 (5 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.effectiveTime is sliced based on the value of value:high

Differential View

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1code
... moodCode 1..1codeRequired Pattern: INT
... 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.17
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringBinding: 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..1TS
... 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..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... author 0..1Author
... entryRelationship 0..1Element
.... typeCode 1..1codeRequired Pattern: SUBJ
.... inversionInd 1..1booleanRequired Pattern: 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..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeRequired Pattern: INT
... 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.17
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringBinding: 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..1TS
... 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..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... author 0..1Author
... entryRelationship C0..1Element
.... typeCode 1..1codeRequired Pattern: SUBJ
.... inversionInd 1..1booleanRequired Pattern: true
.... contextConductionInd 1..1boolean
.... 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.product.typeCoderequiredFixed Value: PRD

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
sup-er-1errorSupply.entryRelationshipOnly 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 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeRequired Pattern: INT
... 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.17
..... 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: ActStatus (required)
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: 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..1codeBinding: NullFlavor (required)
..... value 0..1dateTime
..... inclusive 0..1boolean
..... operator 0..1code
..... low 0..1TS
..... high 1..1TS
..... width 0..1PQ
..... center 0..1TS
... 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..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... 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..*Performer2
... author 0..1Author
... 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
... entryRelationship 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: SUBJ
.... inversionInd 1..1booleanRequired Pattern: true
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... act 1..1InstructionBase 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.coderequiredActStatus
Supply.effectiveTime:when.nullFlavorrequiredNullFlavor
Supply.priorityCodeextensibleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.informant.typeCoderequiredFixed Value: INF
Supply.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
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.entryRelationshipOnly 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 (5 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.effectiveTime is sliced based on the value of value:high

 

​Other representations of profile: CSV, Excel, Schematron