Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration | Version: 1.0.0 | |||
| Active as of 2025-08-28 | Maturity Level: 1 | Computable Name: au-SubstanceAdministration | ||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
Australian adaptation of the HL7 International CDA SubstanceAdministration class.
This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  SubstanceAdministration |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA SubstanceAdministration class Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
 realmCode |
0..* | CS | ||
 typeId |
C | 0..1 | II | Constraints: II-1 |
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
 @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: ActClass (2.0.0) (required) Fixed Value: SBADM | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: CDAActSubstanceAdministrationCode (example) | |
| @negationInd |
0..1 | bl | ||
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
 effectiveTime |
0..* | |||
 effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| repeatNumber |
0..1 | IVL_INT | ||
| methodCode |
0..1 | CD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent method code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| routeCode |
0..1 | CE | Binding: RouteOfAdministration (example) | |
| approachSiteCode |
0..* | CD | Binding: v3 Value Set ActSite (example) | |
| doseQuantity |
0..1 | IVL_PQ | ||
| rateQuantity |
0..1 | IVL_PQ | ||
| maxDoseQuantity |
0..1 | RTO_PQ_PQ | ||
| administrationUnitCode |
0..1 | CE | Binding: AdministrableDrugForm (example) | |
| consumable |
1..1 | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CSM | |
| manufacturedProduct |
1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | Australian-adapted Specimen class | |
| performer |
0..* | Performer2 | Australian-adapted Performer class | |
| author |
0..* | Author | Australian-adapted Author class | |
| informant |
0..* | Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | Reference | Australian-adapted Reference class | |
| precondition |
0..* | Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf1 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubstanceAdministration.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.classCode | required | Fixed Value: SBADMhttp://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0 | |
| SubstanceAdministration.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| SubstanceAdministration.code | example | CDAActSubstanceAdministrationCodehttp://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCodeFrom this IG | |
| SubstanceAdministration.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| SubstanceAdministration.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| SubstanceAdministration.routeCode | example | RouteOfAdministrationhttp://terminology.hl7.org/ValueSet/v3-RouteOfAdministration | |
| SubstanceAdministration.approachSiteCode | example | ActSitehttp://terminology.hl7.org/ValueSet/v3-ActSite | |
| SubstanceAdministration.administrationUnitCode | example | AdministrableDrugFormhttp://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm | |
| SubstanceAdministration.consumable.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.consumable.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSMhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypeFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SubstanceAdministration |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA SubstanceAdministration class Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @classCode |
1..1 | cs | Binding: ActClass (2.0.0) (required) Fixed Value: SBADM | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: CDAActSubstanceAdministrationCode (example) | |
| @negationInd |
0..1 | bl | ||
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..* | |||
| effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| repeatNumber |
0..1 | IVL_INT | ||
| methodCode |
0..1 | CD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent method code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| routeCode |
0..1 | CE | Binding: RouteOfAdministration (example) | |
| approachSiteCode |
0..* | CD | Binding: v3 Value Set ActSite (example) | |
| doseQuantity |
0..1 | IVL_PQ | ||
| rateQuantity |
0..1 | IVL_PQ | ||
| maxDoseQuantity |
0..1 | RTO_PQ_PQ | ||
| administrationUnitCode |
0..1 | CE | Binding: AdministrableDrugForm (example) | |
| consumable |
1..1 | InfrastructureRoot | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CSM | |
| manufacturedProduct |
1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | Australian-adapted Specimen class | |
| performer |
0..* | Performer2 | Australian-adapted Performer class | |
| author |
0..* | Author | Australian-adapted Author class | |
| informant |
0..* | Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | Reference | Australian-adapted Reference class | |
| precondition |
0..* | Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf1 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubstanceAdministration.classCode | required | Fixed Value: SBADMhttp://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0 | |
| SubstanceAdministration.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| SubstanceAdministration.code | example | CDAActSubstanceAdministrationCodehttp://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCodeFrom this IG | |
| SubstanceAdministration.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| SubstanceAdministration.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| SubstanceAdministration.routeCode | example | RouteOfAdministrationhttp://terminology.hl7.org/ValueSet/v3-RouteOfAdministration | |
| SubstanceAdministration.approachSiteCode | example | ActSitehttp://terminology.hl7.org/ValueSet/v3-ActSite | |
| SubstanceAdministration.administrationUnitCode | example | AdministrableDrugFormhttp://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm | |
| SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSMhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypeFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SubstanceAdministration |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA SubstanceAdministration class Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: ActClass (2.0.0) (required) Fixed Value: SBADM | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: CDAActSubstanceAdministrationCode (example) | |
| @negationInd |
0..1 | bl | ||
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..* | |||
| effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| repeatNumber |
0..1 | IVL_INT | ||
| methodCode |
0..1 | CD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent method code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| routeCode |
0..1 | CE | Binding: RouteOfAdministration (example) | |
| approachSiteCode |
0..* | CD | Binding: v3 Value Set ActSite (example) | |
| doseQuantity |
0..1 | IVL_PQ | ||
| rateQuantity |
0..1 | IVL_PQ | ||
| maxDoseQuantity |
0..1 | RTO_PQ_PQ | ||
| administrationUnitCode |
0..1 | CE | Binding: AdministrableDrugForm (example) | |
| consumable |
1..1 | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CSM | |
| manufacturedProduct |
1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | Australian-adapted Specimen class | |
| performer |
0..* | Performer2 | Australian-adapted Performer class | |
| author |
0..* | Author | Australian-adapted Author class | |
| informant |
0..* | Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | Reference | Australian-adapted Reference class | |
| precondition |
0..* | Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf1 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubstanceAdministration.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.classCode | required | Fixed Value: SBADMhttp://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0 | |
| SubstanceAdministration.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| SubstanceAdministration.code | example | CDAActSubstanceAdministrationCodehttp://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCodeFrom this IG | |
| SubstanceAdministration.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| SubstanceAdministration.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| SubstanceAdministration.routeCode | example | RouteOfAdministrationhttp://terminology.hl7.org/ValueSet/v3-RouteOfAdministration | |
| SubstanceAdministration.approachSiteCode | example | ActSitehttp://terminology.hl7.org/ValueSet/v3-ActSite | |
| SubstanceAdministration.administrationUnitCode | example | AdministrableDrugFormhttp://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm | |
| SubstanceAdministration.consumable.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.consumable.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSMhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypeFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SubstanceAdministration |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA SubstanceAdministration class Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: ActClass (2.0.0) (required) Fixed Value: SBADM | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: CDAActSubstanceAdministrationCode (example) | |
| @negationInd |
0..1 | bl | ||
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..* | |||
| effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| repeatNumber |
0..1 | IVL_INT | ||
| methodCode |
0..1 | CD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent method code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| routeCode |
0..1 | CE | Binding: RouteOfAdministration (example) | |
| approachSiteCode |
0..* | CD | Binding: v3 Value Set ActSite (example) | |
| doseQuantity |
0..1 | IVL_PQ | ||
| rateQuantity |
0..1 | IVL_PQ | ||
| maxDoseQuantity |
0..1 | RTO_PQ_PQ | ||
| administrationUnitCode |
0..1 | CE | Binding: AdministrableDrugForm (example) | |
| consumable |
1..1 | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CSM | |
| manufacturedProduct |
1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | Australian-adapted Specimen class | |
| performer |
0..* | Performer2 | Australian-adapted Performer class | |
| author |
0..* | Author | Australian-adapted Author class | |
| informant |
0..* | Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | Reference | Australian-adapted Reference class | |
| precondition |
0..* | Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf1 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubstanceAdministration.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.classCode | required | Fixed Value: SBADMhttp://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0 | |
| SubstanceAdministration.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| SubstanceAdministration.code | example | CDAActSubstanceAdministrationCodehttp://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCodeFrom this IG | |
| SubstanceAdministration.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| SubstanceAdministration.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| SubstanceAdministration.routeCode | example | RouteOfAdministrationhttp://terminology.hl7.org/ValueSet/v3-RouteOfAdministration | |
| SubstanceAdministration.approachSiteCode | example | ActSitehttp://terminology.hl7.org/ValueSet/v3-ActSite | |
| SubstanceAdministration.administrationUnitCode | example | AdministrableDrugFormhttp://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm | |
| SubstanceAdministration.consumable.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.consumable.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSMhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypeFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SubstanceAdministration |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA SubstanceAdministration class Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @classCode |
1..1 | cs | Binding: ActClass (2.0.0) (required) Fixed Value: SBADM | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: CDAActSubstanceAdministrationCode (example) | |
| @negationInd |
0..1 | bl | ||
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..* | |||
| effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| repeatNumber |
0..1 | IVL_INT | ||
| methodCode |
0..1 | CD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent method code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| routeCode |
0..1 | CE | Binding: RouteOfAdministration (example) | |
| approachSiteCode |
0..* | CD | Binding: v3 Value Set ActSite (example) | |
| doseQuantity |
0..1 | IVL_PQ | ||
| rateQuantity |
0..1 | IVL_PQ | ||
| maxDoseQuantity |
0..1 | RTO_PQ_PQ | ||
| administrationUnitCode |
0..1 | CE | Binding: AdministrableDrugForm (example) | |
| consumable |
1..1 | InfrastructureRoot | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CSM | |
| manufacturedProduct |
1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | Australian-adapted Specimen class | |
| performer |
0..* | Performer2 | Australian-adapted Performer class | |
| author |
0..* | Author | Australian-adapted Author class | |
| informant |
0..* | Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | Reference | Australian-adapted Reference class | |
| precondition |
0..* | Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf1 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubstanceAdministration.classCode | required | Fixed Value: SBADMhttp://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0 | |
| SubstanceAdministration.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| SubstanceAdministration.code | example | CDAActSubstanceAdministrationCodehttp://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCodeFrom this IG | |
| SubstanceAdministration.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| SubstanceAdministration.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| SubstanceAdministration.routeCode | example | RouteOfAdministrationhttp://terminology.hl7.org/ValueSet/v3-RouteOfAdministration | |
| SubstanceAdministration.approachSiteCode | example | ActSitehttp://terminology.hl7.org/ValueSet/v3-ActSite | |
| SubstanceAdministration.administrationUnitCode | example | AdministrableDrugFormhttp://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm | |
| SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSMhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypeFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SubstanceAdministration |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA SubstanceAdministration class Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: ActClass (2.0.0) (required) Fixed Value: SBADM | |
| @moodCode |
1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: CDAActSubstanceAdministrationCode (example) | |
| @negationInd |
0..1 | bl | ||
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..* | |||
| effectiveTime |
SXCM_TS | |||
| effectiveTime |
IVL_TS | |||
| effectiveTime |
EIVL_TS | |||
| effectiveTime |
PIVL_TS | |||
| effectiveTime |
SXPR_TS | |||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| repeatNumber |
0..1 | IVL_INT | ||
| methodCode |
0..1 | CD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent method code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| routeCode |
0..1 | CE | Binding: RouteOfAdministration (example) | |
| approachSiteCode |
0..* | CD | Binding: v3 Value Set ActSite (example) | |
| doseQuantity |
0..1 | IVL_PQ | ||
| rateQuantity |
0..1 | IVL_PQ | ||
| maxDoseQuantity |
0..1 | RTO_PQ_PQ | ||
| administrationUnitCode |
0..1 | CE | Binding: AdministrableDrugForm (example) | |
| consumable |
1..1 | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CSM | |
| manufacturedProduct |
1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | Australian-adapted Specimen class | |
| performer |
0..* | Performer2 | Australian-adapted Performer class | |
| author |
0..* | Author | Australian-adapted Author class | |
| informant |
0..* | Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | Reference | Australian-adapted Reference class | |
| precondition |
0..* | Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf1 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubstanceAdministration.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.classCode | required | Fixed Value: SBADMhttp://terminology.hl7.org/ValueSet/v3-ActClass|2.0.0 | |
| SubstanceAdministration.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
| SubstanceAdministration.code | example | CDAActSubstanceAdministrationCodehttp://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCodeFrom this IG | |
| SubstanceAdministration.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| SubstanceAdministration.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| SubstanceAdministration.routeCode | example | RouteOfAdministrationhttp://terminology.hl7.org/ValueSet/v3-RouteOfAdministration | |
| SubstanceAdministration.approachSiteCode | example | ActSitehttp://terminology.hl7.org/ValueSet/v3-ActSite | |
| SubstanceAdministration.administrationUnitCode | example | AdministrableDrugFormhttp://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm | |
| SubstanceAdministration.consumable.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.consumable.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSMhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypeFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2025-08-28
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
