Clinical Document Architecture
2.0.0-sd-ballot - ballot

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-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: SubstanceAdministration - Detailed Descriptions

Active as of 2024-03-04

Definitions for the SubstanceAdministration logical model.

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

0. SubstanceAdministration
Control1..1
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. SubstanceAdministration.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSBADM
4. SubstanceAdministration.moodCode
Control1..1
BindingThe codes SHALL be taken from XDocumentSubstanceMood (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
6. SubstanceAdministration.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. SubstanceAdministration.code
Control0..1
BindingFor example codes, see ActSubstanceAdministrationCode
(example to http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdministrationCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
10. SubstanceAdministration.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
12. SubstanceAdministration.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
14. SubstanceAdministration.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
16. SubstanceAdministration.effectiveTime
Control0..*
TypeChoice 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 Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
18. SubstanceAdministration.priorityCode
Control0..1
BindingFor example codes, see ActPriority
(example to http://terminology.hl7.org/ValueSet/v3-ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
20. SubstanceAdministration.repeatNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
22. SubstanceAdministration.routeCode
Control0..1
BindingFor example codes, see RouteOfAdministration
(example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
24. SubstanceAdministration.approachSiteCode
Control0..*
BindingFor example codes, see v3 Value Set ActSite
(example to http://terminology.hl7.org/ValueSet/v3-ActSite
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
26. SubstanceAdministration.doseQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
28. SubstanceAdministration.rateQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
30. SubstanceAdministration.maxDoseQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
32. SubstanceAdministration.administrationUnitCode
Control0..1
BindingFor example codes, see AdministrableDrugForm
(example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
34. SubstanceAdministration.consumable
Definition

The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
36. SubstanceAdministration.consumable.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
(required to http://terminology.hl7.org/ValueSet/v3-ParticipationType
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCSM
38. SubstanceAdministration.consumable.manufacturedProduct
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
40. SubstanceAdministration.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
42. SubstanceAdministration.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
44. SubstanceAdministration.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
46. SubstanceAdministration.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
48. SubstanceAdministration.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
50. SubstanceAdministration.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
52. SubstanceAdministration.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
54. SubstanceAdministration.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
56. SubstanceAdministration.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
58. SubstanceAdministration.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.

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

0. SubstanceAdministration
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.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. SubstanceAdministration.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSBADM
4. SubstanceAdministration.moodCode
Control1..1
BindingThe codes SHALL be taken from XDocumentSubstanceMood (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
6. SubstanceAdministration.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. SubstanceAdministration.code
Control0..1
BindingFor example codes, see ActSubstanceAdministrationCode
(example to http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdministrationCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
10. SubstanceAdministration.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
12. SubstanceAdministration.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
14. SubstanceAdministration.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
16. SubstanceAdministration.effectiveTime
Control0..*
TypeChoice 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 Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
18. SubstanceAdministration.priorityCode
Control0..1
BindingFor example codes, see ActPriority
(example to http://terminology.hl7.org/ValueSet/v3-ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
20. SubstanceAdministration.repeatNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
22. SubstanceAdministration.routeCode
Control0..1
BindingFor example codes, see RouteOfAdministration
(example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
24. SubstanceAdministration.approachSiteCode
Control0..*
BindingFor example codes, see v3 Value Set ActSite
(example to http://terminology.hl7.org/ValueSet/v3-ActSite
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
26. SubstanceAdministration.doseQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
28. SubstanceAdministration.rateQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
30. SubstanceAdministration.maxDoseQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
32. SubstanceAdministration.administrationUnitCode
Control0..1
BindingFor example codes, see AdministrableDrugForm
(example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
34. SubstanceAdministration.consumable
Definition

The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
36. SubstanceAdministration.consumable.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
(required to http://terminology.hl7.org/ValueSet/v3-ParticipationType
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCSM
38. SubstanceAdministration.consumable.manufacturedProduct
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
40. SubstanceAdministration.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
42. SubstanceAdministration.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
44. SubstanceAdministration.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
46. SubstanceAdministration.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
48. SubstanceAdministration.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
50. SubstanceAdministration.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
52. SubstanceAdministration.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
54. SubstanceAdministration.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
56. SubstanceAdministration.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
58. SubstanceAdministration.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.

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

0. SubstanceAdministration
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.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. SubstanceAdministration.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. SubstanceAdministration.realmCode
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
6. SubstanceAdministration.typeId
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. SubstanceAdministration.typeId.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
10. SubstanceAdministration.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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
12. SubstanceAdministration.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).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. SubstanceAdministration.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. SubstanceAdministration.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
18. SubstanceAdministration.templateId
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
20. SubstanceAdministration.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSBADM
22. SubstanceAdministration.moodCode
Control1..1
BindingThe codes SHALL be taken from XDocumentSubstanceMood (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
24. SubstanceAdministration.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. SubstanceAdministration.code
Control0..1
BindingFor example codes, see ActSubstanceAdministrationCode
(example to http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdministrationCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
28. SubstanceAdministration.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
30. SubstanceAdministration.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
32. SubstanceAdministration.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
34. SubstanceAdministration.effectiveTime
Control0..*
TypeChoice 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 Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
36. SubstanceAdministration.priorityCode
Control0..1
BindingFor example codes, see ActPriority
(example to http://terminology.hl7.org/ValueSet/v3-ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
38. SubstanceAdministration.repeatNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
40. SubstanceAdministration.routeCode
Control0..1
BindingFor example codes, see RouteOfAdministration
(example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
42. SubstanceAdministration.approachSiteCode
Control0..*
BindingFor example codes, see v3 Value Set ActSite
(example to http://terminology.hl7.org/ValueSet/v3-ActSite
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
44. SubstanceAdministration.doseQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
46. SubstanceAdministration.rateQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
48. SubstanceAdministration.maxDoseQuantity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
50. SubstanceAdministration.administrationUnitCode
Control0..1
BindingFor example codes, see AdministrableDrugForm
(example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
52. SubstanceAdministration.consumable
Definition

The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
54. SubstanceAdministration.consumable.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
56. SubstanceAdministration.consumable.realmCode
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
58. SubstanceAdministration.consumable.typeId
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
60. SubstanceAdministration.consumable.typeId.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
62. SubstanceAdministration.consumable.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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
64. SubstanceAdministration.consumable.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).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
66. SubstanceAdministration.consumable.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
68. SubstanceAdministration.consumable.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
70. SubstanceAdministration.consumable.templateId
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
72. SubstanceAdministration.consumable.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
(required to http://terminology.hl7.org/ValueSet/v3-ParticipationType
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueCSM
74. SubstanceAdministration.consumable.manufacturedProduct
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
76. SubstanceAdministration.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
78. SubstanceAdministration.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
80. SubstanceAdministration.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
82. SubstanceAdministration.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
84. SubstanceAdministration.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
86. SubstanceAdministration.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
88. SubstanceAdministration.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
90. SubstanceAdministration.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
92. SubstanceAdministration.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
94. SubstanceAdministration.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.