HL7.CDA.US.CCDA\Medication Dispense - Definitions

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: MedicationDispense - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.18 resource profile.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. Supply
Invariants	Defined on this element 1098-9333: A supply act SHALL contain one product/Medication Information OR one product/Immunization Medication Information template (CONF:1098-9333). (: null)
2. Supply.classCode
Requirements	SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7451).
3. Supply.moodCode
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 Value	EVN
4. Supply.templateId
Slicing	This 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 @ root,
5. Supply.templateId:primary
SliceName	primary
Control	1..1
Requirements	SHALL contain exactly one [1..1] templateId (CONF:1098-7453) such that it
6. Supply.templateId:primary.root
Control	1..1
Requirements	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.18" (CONF:1098-10505).
Pattern Value	2.16.840.1.113883.10.20.22.4.18
7. Supply.templateId:primary.extension
Control	1..1
Requirements	SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32580).
Pattern Value	2014-06-09
8. Supply.id
Control	10..*
Requirements	SHALL contain at least one [1..*] id (CONF:1098-7454).
9. Supply.statusCode
Control	10..1
Requirements	SHALL contain exactly one [1..1] statusCode (CONF:1098-7455).
10. Supply.statusCode.code
Control	1..1
Binding	The codes SHALL be taken from Medication Fill Status
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).
11. Supply.effectiveTime
Control	0..1*
Requirements	SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7456).
12. Supply.repeatNumber
Requirements	SHOULD contain zero or one [0..1] repeatNumber (CONF:1098-7457).
13. Supply.quantity
Requirements	SHOULD contain zero or one [0..1] quantity (CONF:1098-7458).
14. Supply.product
Requirements	MAY contain zero or one [0..1] product (CONF:1098-7459).
15. Supply.product.manufacturedProduct
Type	Choice of: (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).
16. Supply.performer
Control	0..1*
Requirements	MAY contain zero or one [0..1] performer (CONF:1098-7461).
17. Supply.performer.assignedEntity
Control	1..1
Requirements	The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1098-7467).
18. Supply.performer.assignedEntity.addr
Control	0..1
Type	http://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).
Invariants	Defined 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). (: null)
19. Supply.entryRelationship
Slicing	This 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
20. Supply.entryRelationship:supplyOrder
SliceName	supplyOrder
Control	0..1
Requirements	MAY contain zero or one [0..1] entryRelationship (CONF:1098-7473) such that it
21. Supply.entryRelationship:supplyOrder.typeCode
Control	1..1
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 Value	REFR
22. Supply.entryRelationship:supplyOrder.supply
Control	1..1
Type	http://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).

Guidance on how to interpret the contents of this table can be found here.

1. Supply
Definition	Base definition for all types defined in FHIR type system.
Control	10..1*
Invariants	Defined on this element 1098-9333: A supply act SHALL contain one product/Medication Information OR one product/Immunization Medication Information template (CONF:1098-9333). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Supply.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassSupply
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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 Value	SPLY
Fixed Value	SPLY
3. Supply.moodCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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 Value	EVN
4. 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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Slicing	This 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 @ root,
5. Supply.templateId:primary
SliceName	primary
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
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Requirements	SHALL contain exactly one [1..1] templateId (CONF:1098-7453) such that it
6. 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.
Control	1..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.18" (CONF:1098-10505).
Pattern Value	2.16.840.1.113883.10.20.22.4.18
7. Supply.templateId:primary.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32580).
Pattern Value	2014-06-09
8. Supply.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Requirements	SHALL contain at least one [1..*] id (CONF:1098-7454).
9. Supply.statusCode
Control	1..1
Binding	The codes SHALL be taken from ActStatus
Type	http://hl7.org/fhir/cda/StructureDefinition/CS
Requirements	SHALL contain exactly one [1..1] statusCode (CONF:1098-7455).
10. 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.
Control	1..1
Binding	The codes SHALL be taken from Medication Fill Status
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
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).
11. Supply.statusCode.codeSystem
Definition	Specifies the code system that defines the code.
Control	0..0
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
12. Supply.statusCode.codeSystemName
Definition	The common name of the coding system.
Control	0..0
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
13. Supply.statusCode.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..0
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
14. Supply.statusCode.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Control	0..0
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
15. Supply.statusCode.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/ED
16. Supply.statusCode.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/CR
17. Supply.statusCode.translation
Definition	A set of other concept descriptors that translate this concept descriptor into other code systems.
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/CD
XML Representation	The type of this property is determined using the xsi:type attribute.
18. Supply.effectiveTime
Control	0..1
Type	Choice 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
Default Type	http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS
XML Representation	The type of this property is determined using the xsi:type attribute.
Requirements	SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7456).
19. Supply.repeatNumber
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/IVL-INT
Requirements	SHOULD contain zero or one [0..1] repeatNumber (CONF:1098-7457).
20. Supply.quantity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/PQ
Requirements	SHOULD contain zero or one [0..1] quantity (CONF:1098-7458).
21. Supply.product
Control	0..1
Type	Element
Requirements	MAY contain zero or one [0..1] product (CONF:1098-7459).
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Supply.product.typeCode
Control	1..1
Binding	The codes SHALL be taken from ParticipationTargetDirect
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	PRD
Fixed Value	PRD
23. Supply.product.manufacturedProduct
Control	1..1
Type	Choice 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).
24. Supply.performer
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements	MAY contain zero or one [0..1] performer (CONF:1098-7461).
25. Supply.performer.assignedEntity
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements	The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1098-7467).
26. Supply.performer.assignedEntity.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassAssignedEntity
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	ASSIGNED
Fixed Value	ASSIGNED
27. Supply.performer.assignedEntity.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
28. 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.
Control	0..1
Type	http://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).
Invariants	Defined 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). (: null) 81-7296: SHALL NOT have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Supply.entryRelationship
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) 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)
Slicing	This 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
30. Supply.entryRelationship.typeCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
31. Supply.entryRelationship.contextConductionInd
Control	1..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	true
32. Supply.entryRelationship:supplyOrder
SliceName	supplyOrder
Control	0..1
Type	Element
Requirements	MAY contain zero or one [0..1] entryRelationship (CONF:1098-7473) such that it
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) 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)
33. Supply.entryRelationship:supplyOrder.typeCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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 Value	REFR
34. Supply.entryRelationship:supplyOrder.contextConductionInd
Control	1..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	true
35. Supply.entryRelationship:supplyOrder.observation
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Observation
36. Supply.entryRelationship:supplyOrder.regionOfInterest
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
37. Supply.entryRelationship:supplyOrder.observationMedia
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
38. Supply.entryRelationship:supplyOrder.substanceAdministration
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
39. Supply.entryRelationship:supplyOrder.supply
Definition	Base definition for all types defined in FHIR type system.
Control	1..1
Type	http://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).
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Supply.entryRelationship:supplyOrder.procedure
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Procedure
41. Supply.entryRelationship:supplyOrder.encounter
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Encounter
42. Supply.entryRelationship:supplyOrder.organizer
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Organizer
43. Supply.entryRelationship:supplyOrder.act
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Act

Guidance on how to interpret the contents of this table can be found here.

1. Supply
Definition	Base definition for all types defined in FHIR type system.
Control	1..1
2. Supply.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassSupply
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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 Value	SPLY
Fixed Value	SPLY
3. Supply.moodCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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 Value	EVN
4. Supply.realmCode
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/CS
5. Supply.typeId
Control	0..1
Type	http://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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Slicing	This 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 @ root,
7. Supply.templateId:primary
SliceName	primary
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
Control	1..1
Type	http://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.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
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).
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
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.
Control	1..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.18" (CONF:1098-10505).
Pattern Value	2.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.
Control	1..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32580).
Pattern Value	2014-06-09
13. Supply.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Requirements	SHALL contain at least one [1..*] id (CONF:1098-7454).
14. Supply.code
Control	0..1
Binding	The codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CD
15. Supply.text
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ED
16. Supply.statusCode
Control	1..1
Binding	The codes SHALL be taken from ActStatus
Type	http://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.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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.
Control	1..1
Binding	The codes SHALL be taken from Medication Fill Status
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
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.
Control	0..0
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
20. Supply.statusCode.codeSystemName
Definition	The common name of the coding system.
Control	0..0
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
21. Supply.statusCode.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..0
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
22. Supply.statusCode.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Control	0..0
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
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.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `valueSet`.
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.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `valueSetVersion`.
25. Supply.statusCode.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/ED
26. Supply.statusCode.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://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.
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/CD
XML Representation	The type of this property is determined using the xsi:type attribute.
28. Supply.effectiveTime
Control	0..1
Type	Choice 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
Default Type	http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS
XML Representation	The type of this property is determined using the xsi:type attribute.
Requirements	SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7456).
29. Supply.priorityCode
Control	0..*
Binding	The codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
30. Supply.repeatNumber
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/IVL-INT
Requirements	SHOULD contain zero or one [0..1] repeatNumber (CONF:1098-7457).
31. Supply.independentInd
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/BL
32. Supply.quantity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/PQ
Requirements	SHOULD contain zero or one [0..1] quantity (CONF:1098-7458).
33. Supply.expectedUseTime
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/IVL-TS
34. Supply.product
Control	0..1
Type	Element
Requirements	MAY contain zero or one [0..1] product (CONF:1098-7459).
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Supply.product.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
36. Supply.product.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Supply.product.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
37. Supply.product.typeCode
Control	1..1
Binding	The codes SHALL be taken from ParticipationTargetDirect
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	PRD
Fixed Value	PRD
38. Supply.product.manufacturedProduct
Control	1..1
Type	Choice 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).
39. Supply.subject
Control	0..1
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Supply.subject.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
41. Supply.subject.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Supply.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
42. Supply.subject.typeCode
Control	1..1
Binding	The codes SHALL be taken from ParticipationTargetSubject
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	SBJ
Fixed Value	SBJ
43. Supply.subject.contextControlCode
Control	1..1
Binding	The codes SHALL be taken from ContextControl
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	OP
Fixed Value	OP
44. Supply.subject.awarenessCode
Control	0..1
Binding	The codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
45. Supply.subject.relatedSubject
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
46. Supply.specimen
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Specimen
47. Supply.performer
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements	MAY contain zero or one [0..1] performer (CONF:1098-7461).
48. Supply.performer.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
49. Supply.performer.typeCode
Control	0..1
Binding	The codes SHALL be taken from ParticipationPhysicalPerformer
Type	code(cs)
XML Representation	In the XML format, this property is represented as an attribute.
Fixed Value	PRF
50. 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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/CS
51. 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.
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/II
52. 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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
53. Supply.performer.functionCode
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
54. Supply.performer.time
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/IVL-TS
55. Supply.performer.modeCode
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
56. Supply.performer.assignedEntity
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements	The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1098-7467).
57. Supply.performer.assignedEntity.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassAssignedEntity
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	ASSIGNED
Fixed Value	ASSIGNED
58. 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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
59. Supply.performer.assignedEntity.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
60. Supply.performer.assignedEntity.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `identifiedBy`.
61. Supply.performer.assignedEntity.code
Control	0..1
Binding	The codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
62. 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.
Control	0..1
Type	http://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).
Invariants	Defined 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). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Supply.performer.assignedEntity.telecom
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/TEL
64. Supply.performer.assignedEntity.assignedPerson
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Person
65. Supply.performer.assignedEntity.representedOrganization
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Organization
66. Supply.author
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Author
67. Supply.informant
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Supply.informant.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
69. Supply.informant.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Supply.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
70. Supply.informant.typeCode
Control	1..1
Binding	The codes SHALL be taken from ParticipationInformationGenerator
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	INF
Fixed Value	INF
71. Supply.informant.contextControlCode
Control	1..1
Binding	The codes SHALL be taken from ContextControl
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	OP
Fixed Value	OP
72. Supply.informant.assignedEntity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
73. Supply.informant.relatedEntity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
74. Supply.participant
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Participant2
75. Supply.entryRelationship
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) 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)
Slicing	This 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
76. Supply.entryRelationship.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
77. Supply.entryRelationship.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Supply.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
78. Supply.entryRelationship.typeCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
79. Supply.entryRelationship.inversionInd
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
80. Supply.entryRelationship.contextConductionInd
Control	1..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	true
81. Supply.entryRelationship.sequenceNumber
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/INT
82. Supply.entryRelationship.negationInd
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
83. Supply.entryRelationship.seperatableInd
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/BL
84. Supply.entryRelationship.observation
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Observation
85. Supply.entryRelationship.regionOfInterest
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
86. Supply.entryRelationship.observationMedia
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
87. Supply.entryRelationship.substanceAdministration
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
88. Supply.entryRelationship.supply
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Supply
89. Supply.entryRelationship.procedure
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Procedure
90. Supply.entryRelationship.encounter
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Encounter
91. Supply.entryRelationship.organizer
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Organizer
92. Supply.entryRelationship.act
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Act
93. Supply.entryRelationship:supplyOrder
SliceName	supplyOrder
Control	0..1
Type	Element
Requirements	MAY contain zero or one [0..1] entryRelationship (CONF:1098-7473) such that it
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) 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)
94. Supply.entryRelationship:supplyOrder.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
95. Supply.entryRelationship:supplyOrder.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Supply.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
96. Supply.entryRelationship:supplyOrder.typeCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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 Value	REFR
97. Supply.entryRelationship:supplyOrder.inversionInd
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
98. Supply.entryRelationship:supplyOrder.contextConductionInd
Control	1..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	true
99. Supply.entryRelationship:supplyOrder.sequenceNumber
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/INT
100. Supply.entryRelationship:supplyOrder.negationInd
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
101. Supply.entryRelationship:supplyOrder.seperatableInd
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/BL
102. Supply.entryRelationship:supplyOrder.observation
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Observation
103. Supply.entryRelationship:supplyOrder.regionOfInterest
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
104. Supply.entryRelationship:supplyOrder.observationMedia
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
105. Supply.entryRelationship:supplyOrder.substanceAdministration
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
106. Supply.entryRelationship:supplyOrder.supply
Definition	Base definition for all types defined in FHIR type system.
Control	1..1
Type	http://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).
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
107. Supply.entryRelationship:supplyOrder.procedure
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Procedure
108. Supply.entryRelationship:supplyOrder.encounter
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Encounter
109. Supply.entryRelationship:supplyOrder.organizer
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Organizer
110. Supply.entryRelationship:supplyOrder.act
Control	0..0
Type	http://hl7.org/fhir/cda/StructureDefinition/Act
111. Supply.reference
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
112. Supply.reference.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
113. Supply.reference.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Supply.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
114. Supply.reference.typeCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
115. Supply.reference.seperatableInd
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/BL
116. Supply.reference.externalAct
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ExternalAct
117. Supply.reference.externalObservation
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
118. Supply.reference.externalProcedure
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
119. Supply.reference.externalDocument
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
120. Supply.precondition
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Precondition