Supply (CDA Class) - Definitions - Clinical Document Architecture v2.0.0-sd

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: Supply - Detailed Descriptions

Active as of 2024-10-25

Definitions for the Supply 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
Control	1..1
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`.
2. Supply.classCode
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`
4. Supply.moodCode
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.
6. Supply.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
8. Supply.code
Control	0..1
Binding	For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
10. Supply.text
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
12. Supply.statusCode
Control	0..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
14. Supply.effectiveTime
Control	0..*
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.
16. 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
18. Supply.repeatNumber
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
20. Supply.independentInd
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/BL
22. Supply.quantity
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/PQ
24. Supply.expectedUseTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
26. Supply.product
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
28. 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`
30. Supply.product.manufacturedProduct
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
32. Supply.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
34. Supply.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
36. Supply.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
38. Supply.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
40. Supply.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
42. Supply.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
44. Supply.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
46. Supply.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
48. Supply.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition
50. 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`.

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`.
2. Supply.classCode
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`
4. Supply.moodCode
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.
6. Supply.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
8. Supply.code
Control	0..1
Binding	For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
10. Supply.text
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
12. Supply.statusCode
Control	0..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
14. Supply.effectiveTime
Control	0..*
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.
16. 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
18. Supply.repeatNumber
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
20. Supply.independentInd
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/BL
22. Supply.quantity
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/PQ
24. Supply.expectedUseTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
26. Supply.product
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
28. 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`
30. Supply.product.manufacturedProduct
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
32. Supply.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
34. Supply.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
36. Supply.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
38. Supply.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
40. Supply.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
42. Supply.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
44. Supply.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
46. Supply.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
48. Supply.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition
50. 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`.

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`.
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	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
20. Supply.classCode
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`
22. Supply.moodCode
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.
24. Supply.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
26. Supply.code
Control	0..1
Binding	For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
28. Supply.text
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
30. Supply.statusCode
Control	0..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
32. Supply.effectiveTime
Control	0..*
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.
34. 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
36. Supply.repeatNumber
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
38. Supply.independentInd
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/BL
40. Supply.quantity
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/PQ
42. Supply.expectedUseTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
44. Supply.product
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
46. 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
48. 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
50. 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
52. 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
54. 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
56. 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
58. 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`
60. 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
62. 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
64. 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`
66. Supply.product.manufacturedProduct
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
68. Supply.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
70. Supply.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
72. Supply.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
74. Supply.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
76. Supply.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
78. Supply.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
80. Supply.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
82. Supply.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
84. Supply.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition
86. 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`.