Medication Dispense - Definitions - Consolidated CDA (C-CDA) v3.0.0

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: MedicationDispense - Detailed Descriptions

Draft as of 2024-05-18

Definitions for the MedicationDispense logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. Supply
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-effectiveTime: SHOULD contain effectiveTime (`effectiveTime.exists()`) should-repeatNumber: SHOULD contain repeatNumber (`repeatNumber.exists()`) should-quantity: SHOULD contain quantity (`quantity.exists()`)
2. Supply.templateId
Control	1..?
Slicing	This element introduces a set of slices on `Supply.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
4. Supply.templateId:med-dispense
Slice Name	med-dispense
Control	1..1
6. Supply.templateId:med-dispense.root
Control	1..?
Pattern Value	`2.16.840.1.113883.10.20.22.4.18`
8. Supply.templateId:med-dispense.extension
Control	1..?
Pattern Value	`2023-05-01`
10. Supply.classCode
Comments	SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7451).
12. Supply.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-7452).
Fixed Value	`EVN`
14. Supply.id
Comments	SHALL contain at least one [1..*] id (CONF:4537-7454).
Control	1..?
16. Supply.code
Short	The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code.
Comments	SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet MedicationDispense Status Codes urn:oid:2.16.840.1.113883.4.642.3.1312 DYNAMIC (CONF:4537-32974).
Control	1..?
Binding	The codes SHALL be taken from MedicationDispenseStatusCodes (required to `http://hl7.org/fhir/ValueSet/medicationdispense-status`)
18. Supply.text
Short	SHOULD reference the portion of section narrative text corresponding to this entry
20. Supply.text.reference
Invariants	value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (`value.exists() implies value.startsWith('#')`)
22. Supply.statusCode
Comments	SHALL contain exactly one [1..1] statusCode (CONF:4537-7455).
Control	1..?
24. Supply.statusCode.code
Comments	This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-32361).
Control	1..?
Fixed Value	`completed`
26. Supply.effectiveTime
Comments	SHOULD contain zero or one [0..1] effectiveTime (CONF:4537-7456).
Control	0..1
28. Supply.repeatNumber
Short	In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
Comments	SHOULD contain zero or one [0..1] repeatNumber (CONF:4537-7457).
30. Supply.quantity
Comments	SHOULD contain zero or one [0..1] quantity (CONF:4537-7458).
32. Supply.product
Control	1..?
34. Supply.product.manufacturedProduct
Comments	The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:4537-15607).
Type	http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
36. Supply.performer
Comments	MAY contain zero or one [0..1] performer (CONF:4537-7461).
Control	0..1
38. Supply.performer.assignedEntity
Comments	The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-7467).
Invariants	should-addr: SHOULD contain addr (`addr.exists()`)
40. Supply.performer.assignedEntity.addr
Comments	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:4537-7468).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
42. Supply.entryRelationship
Comments	MAY contain zero or one [0..1] entryRelationship (CONF:4537-7473) such that it
Slicing	This element introduces a set of slices on `Supply.entryRelationship`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ supply value @ typeCode
44. Supply.entryRelationship:entryRelationship1
Slice Name	entryRelationship1
Short	entryRelationship
Control	0..1
46. Supply.entryRelationship:entryRelationship1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-7474).
Fixed Value	`REFR`
48. Supply.entryRelationship:entryRelationship1.supply
Comments	SHALL contain exactly one [1..1] Medication Supply Order (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:4537-15606).
Control	1..?
Type	http://hl7.org/cda/stds/core/StructureDefinition/Supply(Medication Supply Order)

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

0. Supply
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..1*
Is Modifier	false
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-effectiveTime: SHOULD contain effectiveTime (`effectiveTime.exists()`) should-repeatNumber: SHOULD contain repeatNumber (`repeatNumber.exists()`) should-quantity: SHOULD contain quantity (`quantity.exists()`)
2. 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	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Supply.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
4. Supply.templateId:med-dispense
Slice Name	med-dispense
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/cda/stds/core/StructureDefinition/II
6. Supply.templateId:med-dispense.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	`2.16.840.1.113883.10.20.22.4.18`
8. Supply.templateId:med-dispense.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
Pattern Value	`2023-05-01`
10. Supply.classCode
Comments	SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7451).
Control	1..1
Binding	The codes SHALL be taken from ActClassSupply (required to `http://terminology.hl7.org/ValueSet/v3-ActClassSupply`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	`SPLY`
Fixed Value	`SPLY`
12. Supply.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-7452).
Control	1..1
Binding	The codes SHALL be taken from XDocumentSubstanceMood (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood\|2.0.0`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`EVN`
14. Supply.id
Comments	SHALL contain at least one [1..*] id (CONF:4537-7454).
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
16. Supply.code
Short	The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code.
Comments	SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet MedicationDispense Status Codes urn:oid:2.16.840.1.113883.4.642.3.1312 DYNAMIC (CONF:4537-32974).
Control	1..1
Binding	The codes SHALL be taken from MedicationDispenseStatusCodes (required to `http://hl7.org/fhir/ValueSet/medicationdispense-status`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
18. Supply.text
Short	SHOULD reference the portion of section narrative text corresponding to this entry
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
20. Supply.text.reference
Definition	A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
Label	Reference
Invariants	value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (`value.exists() implies value.startsWith('#')`)
22. Supply.statusCode
Comments	SHALL contain exactly one [1..1] statusCode (CONF:4537-7455).
Control	1..1
Binding	The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
24. 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.
Comments	This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-32361).
Control	1..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code
Fixed Value	`completed`
26. Supply.statusCode.codeSystem
Definition	Specifies the code system that defines the code.
Control	0..0
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System
28. Supply.statusCode.codeSystemName
Definition	The common name of the coding system.
Control	0..0
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Name
30. Supply.statusCode.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..0
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Version
32. 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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Display Name
34. Supply.statusCode.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Original Text
36. Supply.statusCode.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier
38. 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/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the " `xsi:type`attribute.
Label	Translation
40. Supply.effectiveTime
Comments	SHOULD contain zero or one [0..1] effectiveTime (CONF:4537-7456).
Control	0..1
Type	Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type	http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
XML Format	The type of this property is determined using the " `xsi:type`attribute.
42. Supply.repeatNumber
Short	In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
Comments	SHOULD contain zero or one [0..1] repeatNumber (CONF:4537-7457).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
44. Supply.quantity
Comments	SHOULD contain zero or one [0..1] quantity (CONF:4537-7458).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/PQ
46. Supply.product
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
48. Supply.product.manufacturedProduct
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Comments	The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:4537-15607).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
Is Modifier	false
Invariants	product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) (`(manufacturedLabeledDrug \| manufacturedMaterial).count() = 1`)
50. Supply.performer
Comments	MAY contain zero or one [0..1] performer (CONF:4537-7461).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
52. Supply.performer.assignedEntity
Comments	The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-7467).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants	should-addr: SHOULD contain addr (`addr.exists()`)
54. Supply.performer.assignedEntity.id
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
56. 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.
Short	Base for all types and resources
Comments	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:4537-7468).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifier	false
Invariants	shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (`nullFlavor.exists() or item.city.count() = 1`) shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (`nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)`) should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`) should-country: SHOULD contain country (`nullFlavor.exists() or item.country.exists()`) 81-7296: SHALL NOT have mixed content except for white space (CONF:81-7296) (`item.xmlText.empty()`) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (`nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))`) 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (`nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))`) shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country (`(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)`)
58. Supply.entryRelationship
Comments	MAY contain zero or one [0..1] entryRelationship (CONF:4537-7473) such that it
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing	This element introduces a set of slices on `Supply.entryRelationship`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ supply value @ typeCode
60. Supply.entryRelationship:entryRelationship1
Slice Name	entryRelationship1
Short	entryRelationship
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
62. Supply.entryRelationship:entryRelationship1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-7474).
Control	1..1
Binding	The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`REFR`
64. Supply.entryRelationship:entryRelationship1.supply
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Comments	SHALL contain exactly one [1..1] Medication Supply Order (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:4537-15606).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Supply(Medication Supply Order)
Is Modifier	false
Invariants	should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-repeatNumber: SHOULD contain repeatNumber (`repeatNumber.exists()`) should-quantity: SHOULD contain quantity (`quantity.exists()`)

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

0. Supply
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Control	1..1
Is Modifier	false
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-effectiveTime: SHOULD contain effectiveTime (`effectiveTime.exists()`) should-repeatNumber: SHOULD contain repeatNumber (`repeatNumber.exists()`) should-quantity: SHOULD contain quantity (`quantity.exists()`)
2. Supply.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. Supply.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/cda/stds/core/StructureDefinition/CS
6. Supply.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/cda/stds/core/StructureDefinition/II
8. Supply.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
10. Supply.typeId.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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
12. Supply.typeId.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(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
14. Supply.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
16. Supply.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
18. 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	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Supply.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. Supply.templateId:med-dispense
Slice Name	med-dispense
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/cda/stds/core/StructureDefinition/II
22. Supply.templateId:med-dispense.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
24. Supply.templateId:med-dispense.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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
26. Supply.templateId:med-dispense.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(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
28. Supply.templateId:med-dispense.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	`2.16.840.1.113883.10.20.22.4.18`
30. Supply.templateId:med-dispense.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
Pattern Value	`2023-05-01`
32. Supply.classCode
Comments	SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7451).
Control	1..1
Binding	The codes SHALL be taken from ActClassSupply (required to `http://terminology.hl7.org/ValueSet/v3-ActClassSupply`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	`SPLY`
Fixed Value	`SPLY`
34. Supply.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-7452).
Control	1..1
Binding	The codes SHALL be taken from XDocumentSubstanceMood (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood\|2.0.0`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`EVN`
36. Supply.id
Comments	SHALL contain at least one [1..*] id (CONF:4537-7454).
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
38. Supply.code
Short	The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code.
Comments	SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet MedicationDispense Status Codes urn:oid:2.16.840.1.113883.4.642.3.1312 DYNAMIC (CONF:4537-32974).
Control	1..1
Binding	The codes SHALL be taken from MedicationDispenseStatusCodes (required to `http://hl7.org/fhir/ValueSet/medicationdispense-status`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
40. Supply.text
Short	SHOULD reference the portion of section narrative text corresponding to this entry
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
42. Supply.text.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
44. Supply.text.compression
Definition	Indicates whether the raw byte data is compressed, and what compression algorithm was used.
Control	0..1
Binding	The codes SHALL be taken from CDACompressionAlgorithm (required to `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Compression
46. Supply.text.integrityCheck
Definition	The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.
Control	0..1
Type	base64Binary(bin: Binary Data)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Integrity Check
48. Supply.text.integrityCheckAlgorithm
Definition	Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.
Control	0..1
Binding	The codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm\|2.0.0`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Integrity Check Algorithm
50. Supply.text.language
Definition	For character based information the language property specifies the human language of the text.
Control	0..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Language
52. Supply.text.mediaType
Definition	Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control	0..1
Binding	For example codes, see MediaType (example to `http://terminology.hl7.org/ValueSet/v3-MediaType`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Media Type
54. Supply.text.representation
Control	0..1
Binding	The codes SHALL be taken from CDABinaryDataEncoding (required to `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
56. Supply.text.xmlText
Definition	Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
Short	Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments	This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as unadorned text.
58. Supply.text.reference
Definition	A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
Label	Reference
Invariants	value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (`value.exists() implies value.startsWith('#')`)
60. Supply.text.thumbnail
Definition	An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Thumbnail
62. Supply.statusCode
Comments	SHALL contain exactly one [1..1] statusCode (CONF:4537-7455).
Control	1..1
Binding	The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
64. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
66. 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.
Comments	This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-32361).
Control	1..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code
Fixed Value	`completed`
68. Supply.statusCode.codeSystem
Definition	Specifies the code system that defines the code.
Control	0..0
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System
70. Supply.statusCode.codeSystemName
Definition	The common name of the coding system.
Control	0..0
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Name
72. Supply.statusCode.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..0
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Version
74. 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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Display Name
76. 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(oid: ISO Object Identifier)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	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`.
78. 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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	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`.
80. Supply.statusCode.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Original Text
82. Supply.statusCode.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier
84. 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/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the " `xsi:type`attribute.
Label	Translation
86. Supply.effectiveTime
Comments	SHOULD contain zero or one [0..1] effectiveTime (CONF:4537-7456).
Control	0..1
Type	Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type	http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
XML Format	The type of this property is determined using the " `xsi:type`attribute.
88. Supply.priorityCode
Control	0..*
Binding	For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
90. Supply.repeatNumber
Short	In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
Comments	SHOULD contain zero or one [0..1] repeatNumber (CONF:4537-7457).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
92. Supply.independentInd
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/BL
94. Supply.quantity
Comments	SHOULD contain zero or one [0..1] quantity (CONF:4537-7458).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/PQ
96. Supply.expectedUseTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
98. Supply.product
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
100. Supply.product.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
102. Supply.product.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/cda/stds/core/StructureDefinition/CS
104. Supply.product.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/cda/stds/core/StructureDefinition/II
106. Supply.product.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
108. Supply.product.typeId.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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
110. Supply.product.typeId.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(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
112. Supply.product.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
114. Supply.product.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
116. Supply.product.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/cda/stds/core/StructureDefinition/II
118. Supply.product.typeCode
Control	0..1
Binding	The codes SHALL be taken from ParticipationTargetDirect (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`PRD`
120. Supply.product.manufacturedProduct
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Comments	The product, if present, SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:4537-15607).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information, Immunization Medication Information)
Is Modifier	false
Invariants	product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) (`(manufacturedLabeledDrug \| manufacturedMaterial).count() = 1`)
122. Supply.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
124. Supply.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
126. Supply.performer
Comments	MAY contain zero or one [0..1] performer (CONF:4537-7461).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
128. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
130. 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/cda/stds/core/StructureDefinition/CS
132. 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/cda/stds/core/StructureDefinition/II
134. Supply.performer.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
136. Supply.performer.typeId.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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
138. Supply.performer.typeId.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(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
140. Supply.performer.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
142. Supply.performer.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
144. 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/cda/stds/core/StructureDefinition/II
146. Supply.performer.typeCode
Control	0..1
Binding	The codes SHALL be taken from ParticipationPhysicalPerformer (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`PRF`
148. Supply.performer.sdtcFunctionCode
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`functionCode`.
150. Supply.performer.time
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
152. Supply.performer.modeCode
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
154. Supply.performer.assignedEntity
Comments	The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-7467).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants	should-addr: SHOULD contain addr (`addr.exists()`)
156. Supply.performer.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
158. Supply.performer.assignedEntity.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/cda/stds/core/StructureDefinition/CS
160. Supply.performer.assignedEntity.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/cda/stds/core/StructureDefinition/II
162. Supply.performer.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
164. Supply.performer.assignedEntity.typeId.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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
166. Supply.performer.assignedEntity.typeId.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(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
168. Supply.performer.assignedEntity.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
170. Supply.performer.assignedEntity.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
172. 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/cda/stds/core/StructureDefinition/II
174. Supply.performer.assignedEntity.classCode
Control	0..1
Binding	The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`ASSIGNED`
176. Supply.performer.assignedEntity.id
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
178. Supply.performer.assignedEntity.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
180. Supply.performer.assignedEntity.code
Control	0..1
Binding	For example codes, see CDARoleCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
182. 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.
Short	Base for all types and resources
Comments	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:4537-7468).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifier	false
Invariants	shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (`nullFlavor.exists() or item.city.count() = 1`) shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (`nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)`) should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`) should-country: SHOULD contain country (`nullFlavor.exists() or item.country.exists()`) 81-7296: SHALL NOT have mixed content except for white space (CONF:81-7296) (`item.xmlText.empty()`) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (`nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))`) 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (`nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))`) shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country (`(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)`)
184. Supply.performer.assignedEntity.telecom
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
186. Supply.performer.assignedEntity.assignedPerson
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Person
188. Supply.performer.assignedEntity.representedOrganization
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Organization
190. Supply.performer.assignedEntity.sdtcPatient
Control	0..1
Type	http://hl7.org/fhir/StructureDefinition/Base
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`patient`.
192. Supply.performer.assignedEntity.sdtcPatient.id
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
194. Supply.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
196. Supply.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
198. Supply.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
200. Supply.entryRelationship
Comments	MAY contain zero or one [0..1] entryRelationship (CONF:4537-7473) such that it
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing	This element introduces a set of slices on `Supply.entryRelationship`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ supply value @ typeCode
202. Supply.entryRelationship:entryRelationship1
Slice Name	entryRelationship1
Short	entryRelationship
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
204. Supply.entryRelationship:entryRelationship1.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
206. Supply.entryRelationship:entryRelationship1.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/cda/stds/core/StructureDefinition/CS
208. Supply.entryRelationship:entryRelationship1.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/cda/stds/core/StructureDefinition/II
210. Supply.entryRelationship:entryRelationship1.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
212. Supply.entryRelationship:entryRelationship1.typeId.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(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
214. Supply.entryRelationship:entryRelationship1.typeId.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(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
216. Supply.entryRelationship:entryRelationship1.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
218. Supply.entryRelationship:entryRelationship1.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
220. Supply.entryRelationship:entryRelationship1.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/cda/stds/core/StructureDefinition/II
222. Supply.entryRelationship:entryRelationship1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-7474).
Control	1..1
Binding	The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`REFR`
224. Supply.entryRelationship:entryRelationship1.inversionInd
Definition	The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
226. Supply.entryRelationship:entryRelationship1.contextConductionInd
Definition	The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	`true`
228. Supply.entryRelationship:entryRelationship1.negationInd
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
230. Supply.entryRelationship:entryRelationship1.sequenceNumber
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
232. Supply.entryRelationship:entryRelationship1.seperatableInd
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/BL
234. Supply.entryRelationship:entryRelationship1.act
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Act
236. Supply.entryRelationship:entryRelationship1.encounter
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Encounter
238. Supply.entryRelationship:entryRelationship1.observation
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Observation
240. Supply.entryRelationship:entryRelationship1.observationMedia
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
242. Supply.entryRelationship:entryRelationship1.organizer
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Organizer
244. Supply.entryRelationship:entryRelationship1.procedure
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Procedure
246. Supply.entryRelationship:entryRelationship1.regionOfInterest
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
248. Supply.entryRelationship:entryRelationship1.substanceAdministration
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
250. Supply.entryRelationship:entryRelationship1.supply
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Comments	SHALL contain exactly one [1..1] Medication Supply Order (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:4537-15606).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Supply(Medication Supply Order)
Is Modifier	false
Invariants	should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-repeatNumber: SHOULD contain repeatNumber (`repeatNumber.exists()`) should-quantity: SHOULD contain quantity (`quantity.exists()`)
252. Supply.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
254. Supply.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition
256. Supply.sdtcInFulfillmentOf1
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`inFulfillmentOf1`.