Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: MedicationDispense - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.18 resource profile.

1. Supply
Control1..1
InvariantsDefined on this element
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333). (: )
2. Supply.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassSupply
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7451).

Default ValueSPLY
Fixed ValueSPLY
3. Supply.moodCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7452).

Pattern ValueEVN
4. Supply.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Supply.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Supply.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
7. Supply.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-7453) such that it

8. Supply.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
9. Supply.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
10. Supply.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
11. Supply.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.18" (CONF:1098-10505).

Pattern Value2.16.840.1.113883.10.20.22.4.18
12. Supply.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32580).

Pattern Value2014-06-09
13. Supply.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-7454).

14. Supply.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
15. Supply.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
16. Supply.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-7455).

17. Supply.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
18. Supply.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
BindingThe codes SHALL be taken from Medication Fill Status
Typestring
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Medication Fill Status urn:oid:2.16.840.1.113883.3.88.12.80.64 STATIC 2014-04-23 (CONF:1098-32361).

19. Supply.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
20. Supply.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
21. Supply.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
22. Supply.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
23. Supply.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
24. Supply.statusCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
25. Supply.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
26. Supply.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
27. Supply.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
28. Supply.effectiveTime
Control0..1
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7456).

29. Supply.priorityCode
Control0..*
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
30. Supply.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
Requirements

SHOULD contain zero or one [0..1] repeatNumber (CONF:1098-7457).

31. Supply.independentInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
32. Supply.quantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
Requirements

SHOULD contain zero or one [0..1] quantity (CONF:1098-7458).

33. Supply.expectedUseTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
34. Supply.product
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] product (CONF:1098-7459).

35. Supply.product.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetDirect
Typecode
Default ValuePRD
Fixed ValuePRD
36. Supply.product.manufacturedProduct
Control1..1
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(MedicationInformation), http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(ImmunizationMedicationInformation)
Requirements

The product, if present, SHALL contain exactly one [1..1] Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-15607).

37. Supply.subject
Control0..1
TypeElement
38. Supply.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
39. Supply.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
40. Supply.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
41. Supply.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
42. Supply.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
43. Supply.performer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or one [0..1] performer (CONF:1098-7461).

44. Supply.performer.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
45. Supply.performer.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationPhysicalPerformer
Typecode(cs)
Fixed ValuePRF
46. Supply.performer.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
47. Supply.performer.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
48. Supply.performer.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
49. Supply.performer.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
50. Supply.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
51. Supply.performer.modeCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
52. Supply.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1098-7467).

53. Supply.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
54. Supply.performer.assignedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
55. Supply.performer.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
56. Supply.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
57. Supply.performer.assignedEntity.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
58. Supply.performer.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

This assignedEntity SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1098-7468).

InvariantsDefined on this element
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). (: )
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
59. Supply.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
60. Supply.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
61. Supply.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
62. Supply.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
63. Supply.informant
Control0..*
TypeElement
64. Supply.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
65. Supply.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
66. Supply.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
67. Supply.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
68. Supply.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
69. Supply.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ supply
70. Supply.entryRelationship.typeCode
Control1..1
Typecode
71. Supply.entryRelationship.inversionInd
Control0..1
Typeboolean
72. Supply.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
73. Supply.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
74. Supply.entryRelationship.negationInd
Control0..1
Typeboolean
75. Supply.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
76. Supply.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
77. Supply.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
78. Supply.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
79. Supply.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
80. Supply.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
81. Supply.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
82. Supply.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
83. Supply.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
84. Supply.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
85. Supply.entryRelationship:supplyOrder
SliceNamesupplyOrder
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-7473) such that it

InvariantsDefined on this element
sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
86. Supply.entryRelationship:supplyOrder.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7474).

Pattern ValueREFR
87. Supply.entryRelationship:supplyOrder.inversionInd
Control0..1
Typeboolean
88. Supply.entryRelationship:supplyOrder.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
89. Supply.entryRelationship:supplyOrder.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
90. Supply.entryRelationship:supplyOrder.negationInd
Control0..1
Typeboolean
91. Supply.entryRelationship:supplyOrder.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
92. Supply.entryRelationship:supplyOrder.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
93. Supply.entryRelationship:supplyOrder.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
94. Supply.entryRelationship:supplyOrder.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
95. Supply.entryRelationship:supplyOrder.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
96. Supply.entryRelationship:supplyOrder.supply
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply(MedicationSupplyOrder)
Requirements

SHALL contain exactly one [1..1] Medication Supply Order (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:1098-15606).

97. Supply.entryRelationship:supplyOrder.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
98. Supply.entryRelationship:supplyOrder.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
99. Supply.entryRelationship:supplyOrder.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
100. Supply.entryRelationship:supplyOrder.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
101. Supply.reference
Control0..*
TypeElement
102. Supply.reference.typeCode
Control1..1
Typecode
103. Supply.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
104. Supply.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
105. Supply.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
106. Supply.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
107. Supply.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
108. Supply.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition