Clinical Document Architecture with Australian Schema
1.0.0 - current Australia flag

Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: SubstanceAdministration - Detailed Descriptions

Active as of 2024-08-29

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 ContainerADHA ClinicalDocument (CDA Class)
ValidationInstance 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 CDAActClass
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
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 CDAActSubstanceAdministrationCode
(example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode)
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 CDAParticipationType
(required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
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.