Clinical Document Architecture with Australian Schema
1.0.1 - active
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.1 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-Reference | Version: 1.0.1 | |||
| Active as of 2025-10-09 | Maturity Level: 1 | Computable Name: au-Reference | ||
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 Reference 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:   |
|---|---|---|---|---|
  Reference |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Reference class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: reference-external |
  @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 |
1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd |
0..1 | BL | ||
  (Choice of one) |
1..1 | |||
  externalAct |
0..1 | ExternalAct | Australian-adapted ExternalAct class | |
| externalObservation |
0..1 | ExternalObservation | ||
| externalProcedure |
0..1 | ExternalProcedure | ||
 externalDocument |
0..1 | ExternalDocument | Australian-adapted ExternalDocument class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Reference.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Reference.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Reference.typeCode | Base | required | x_ActRelationshipExternalReference | 📦2.0.0 | THO v5.2 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Reference.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| reference-external | error | Reference | Must contain one (and only one) external reference |
(externalAct | externalObservation | externalProcedure | externalDocument).count() = 1
|
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Reference |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Reference class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: reference-external |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| externalAct |
0..1 | ExternalAct | Australian-adapted ExternalAct class | |
| externalObservation |
0..1 | ExternalObservation | ||
| externalProcedure |
0..1 | ExternalProcedure | ||
| externalDocument |
0..1 | ExternalDocument | Australian-adapted ExternalDocument class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Reference.typeCode | Base | required | x_ActRelationshipExternalReference | 📦2.0.0 | THO v5.2 |
| Id | Grade | Path(s) | Description | Expression |
| reference-external | error | Reference | Must contain one (and only one) external reference |
(externalAct | externalObservation | externalProcedure | externalDocument).count() = 1
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Reference |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Reference class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: reference-external |
| @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 |
1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| externalAct |
0..1 | ExternalAct | Australian-adapted ExternalAct class | |
| externalObservation |
0..1 | ExternalObservation | ||
| externalProcedure |
0..1 | ExternalProcedure | ||
| externalDocument |
0..1 | ExternalDocument | Australian-adapted ExternalDocument class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Reference.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Reference.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Reference.typeCode | Base | required | x_ActRelationshipExternalReference | 📦2.0.0 | THO v5.2 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Reference.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| reference-external | error | Reference | Must contain one (and only one) external reference |
(externalAct | externalObservation | externalProcedure | externalDocument).count() = 1
|
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(1 nested mandatory element)
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Reference |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Reference class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: reference-external |
| @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 |
1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| externalAct |
0..1 | ExternalAct | Australian-adapted ExternalAct class | |
| externalObservation |
0..1 | ExternalObservation | ||
| externalProcedure |
0..1 | ExternalProcedure | ||
| externalDocument |
0..1 | ExternalDocument | Australian-adapted ExternalDocument class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Reference.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Reference.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Reference.typeCode | Base | required | x_ActRelationshipExternalReference | 📦2.0.0 | THO v5.2 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Reference.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| reference-external | error | Reference | Must contain one (and only one) external reference |
(externalAct | externalObservation | externalProcedure | externalDocument).count() = 1
|
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Reference |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Reference class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: reference-external |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| externalAct |
0..1 | ExternalAct | Australian-adapted ExternalAct class | |
| externalObservation |
0..1 | ExternalObservation | ||
| externalProcedure |
0..1 | ExternalProcedure | ||
| externalDocument |
0..1 | ExternalDocument | Australian-adapted ExternalDocument class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Reference.typeCode | Base | required | x_ActRelationshipExternalReference | 📦2.0.0 | THO v5.2 |
| Id | Grade | Path(s) | Description | Expression |
| reference-external | error | Reference | Must contain one (and only one) external reference |
(externalAct | externalObservation | externalProcedure | externalDocument).count() = 1
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Reference |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Reference class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: reference-external |
| @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 |
1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| externalAct |
0..1 | ExternalAct | Australian-adapted ExternalAct class | |
| externalObservation |
0..1 | ExternalObservation | ||
| externalProcedure |
0..1 | ExternalProcedure | ||
| externalDocument |
0..1 | ExternalDocument | Australian-adapted ExternalDocument class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Reference.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Reference.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Reference.typeCode | Base | required | x_ActRelationshipExternalReference | 📦2.0.0 | THO v5.2 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Reference.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| reference-external | error | Reference | Must contain one (and only one) external reference |
(externalAct | externalObservation | externalProcedure | externalDocument).count() = 1
|
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(1 nested mandatory element)
Structures
This structure refers to these other structures:
Maturity: 1
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.1 based on FHIR 5.0.0. Generated 2025-10-09
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
