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

Logical Model: ADHA ClinicalDocument (CDA Class)

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-ClinicalDocument Version: 1.0.1
Active as of 2025-10-09 Maturity Level: 1 Computable Name: au-ClinicalDocument

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 ClinicalDocument 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:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Australian adaptation of the HL7 International CDA ClinicalDocument class

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... 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 Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
... code 1..1 CE
... title 0..1 ST
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS
... setId 0..1 II
... versionNumber 0..1 INT
... completionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent document lifecycle codes
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Binding: NCTIS Admin Codes Document Status (required)
... copyTime 0..1 TS
... recordTarget 1..* au-RecordTarget Australian-adapted RecordTarget class
... author 1..* au-Author Australian-adapted Author class
... dataEnterer 0..1 DataEnterer
... informant 0..* au-Informant Australian-adapted Informant class
... custodian 1..1 au-Custodian Australian-adapted Custodian class
... informationRecipient 0..* au-InformationRecipient Australian-adapted InformationRecipient class
... legalAuthenticator 0..1 au-LegalAuthenticator Australian-adapted LegalAuthenticator class
... authenticator 0..* Authenticator
... participant 0..* au-Participant1 Australian-adapted Participant class
... inFulfillmentOf 0..* au-InFulfillmentOf Australian-adapted InFulfillmentOf class
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* au-RelatedDocument Australian-adapted RelatedDocument class
... authorization 0..* Authorization
... componentOf 0..1 au-ComponentOf Australian-adapted ComponentOf class
... component 1..1 au-Component Australian-adapted Component class

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClinicalDocument.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ClinicalDocument.classCode Base example CDAActClass 📦1.0.1 This IG
ClinicalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ClinicalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ClinicalDocument.completionCode Base required NCTIS Admin Codes Document Status 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
II-1 error ClinicalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from ANY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Australian adaptation of the HL7 International CDA ClinicalDocument class

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... realmCode 0..* CS
... typeId 0..1 II
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
... code 1..1 CE
... title 0..1 ST
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS
... setId 0..1 II
... versionNumber 0..1 INT
... completionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent document lifecycle codes
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Binding: NCTIS Admin Codes Document Status (required)
... copyTime 0..1 TS
... recordTarget 1..* au-RecordTarget Australian-adapted RecordTarget class
... author 1..* au-Author Australian-adapted Author class
... dataEnterer 0..1 DataEnterer
... informant 0..* au-Informant Australian-adapted Informant class
... custodian 1..1 au-Custodian Australian-adapted Custodian class
... informationRecipient 0..* au-InformationRecipient Australian-adapted InformationRecipient class
... legalAuthenticator 0..1 au-LegalAuthenticator Australian-adapted LegalAuthenticator class
... authenticator 0..* Authenticator
... participant 0..* au-Participant1 Australian-adapted Participant class
... inFulfillmentOf 0..* au-InFulfillmentOf Australian-adapted InFulfillmentOf class
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* au-RelatedDocument Australian-adapted RelatedDocument class
... authorization 0..* Authorization
... componentOf 0..1 au-ComponentOf Australian-adapted ComponentOf class
... component 1..1 au-Component Australian-adapted Component class

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ClinicalDocument.classCode Base example CDAActClass 📦1.0.1 This IG
ClinicalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ClinicalDocument.completionCode Base required NCTIS Admin Codes Document Status 📦1.0.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Australian adaptation of the HL7 International CDA ClinicalDocument class

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... 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 Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
... code 1..1 CE
... title 0..1 ST
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS
... setId 0..1 II
... versionNumber 0..1 INT
... completionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent document lifecycle codes
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Binding: NCTIS Admin Codes Document Status (required)
... copyTime 0..1 TS
... recordTarget 1..* au-RecordTarget Australian-adapted RecordTarget class
... author 1..* au-Author Australian-adapted Author class
... dataEnterer 0..1 DataEnterer
... informant 0..* au-Informant Australian-adapted Informant class
... custodian 1..1 au-Custodian Australian-adapted Custodian class
... informationRecipient 0..* au-InformationRecipient Australian-adapted InformationRecipient class
... legalAuthenticator 0..1 au-LegalAuthenticator Australian-adapted LegalAuthenticator class
... authenticator 0..* Authenticator
... participant 0..* au-Participant1 Australian-adapted Participant class
... inFulfillmentOf 0..* au-InFulfillmentOf Australian-adapted InFulfillmentOf class
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* au-RelatedDocument Australian-adapted RelatedDocument class
... authorization 0..* Authorization
... componentOf 0..1 au-ComponentOf Australian-adapted ComponentOf class
... component 1..1 au-Component Australian-adapted Component class

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClinicalDocument.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ClinicalDocument.classCode Base example CDAActClass 📦1.0.1 This IG
ClinicalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ClinicalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ClinicalDocument.completionCode Base required NCTIS Admin Codes Document Status 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
II-1 error ClinicalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from ANY

Summary

Mandatory: 0 element(10 nested mandatory elements)
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Australian adaptation of the HL7 International CDA ClinicalDocument class

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... 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 Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
... code 1..1 CE
... title 0..1 ST
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS
... setId 0..1 II
... versionNumber 0..1 INT
... completionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent document lifecycle codes
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Binding: NCTIS Admin Codes Document Status (required)
... copyTime 0..1 TS
... recordTarget 1..* au-RecordTarget Australian-adapted RecordTarget class
... author 1..* au-Author Australian-adapted Author class
... dataEnterer 0..1 DataEnterer
... informant 0..* au-Informant Australian-adapted Informant class
... custodian 1..1 au-Custodian Australian-adapted Custodian class
... informationRecipient 0..* au-InformationRecipient Australian-adapted InformationRecipient class
... legalAuthenticator 0..1 au-LegalAuthenticator Australian-adapted LegalAuthenticator class
... authenticator 0..* Authenticator
... participant 0..* au-Participant1 Australian-adapted Participant class
... inFulfillmentOf 0..* au-InFulfillmentOf Australian-adapted InFulfillmentOf class
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* au-RelatedDocument Australian-adapted RelatedDocument class
... authorization 0..* Authorization
... componentOf 0..1 au-ComponentOf Australian-adapted ComponentOf class
... component 1..1 au-Component Australian-adapted Component class

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClinicalDocument.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ClinicalDocument.classCode Base example CDAActClass 📦1.0.1 This IG
ClinicalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ClinicalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ClinicalDocument.completionCode Base required NCTIS Admin Codes Document Status 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
II-1 error ClinicalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Differential View

This structure is derived from ANY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Australian adaptation of the HL7 International CDA ClinicalDocument class

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... realmCode 0..* CS
... typeId 0..1 II
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
... code 1..1 CE
... title 0..1 ST
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS
... setId 0..1 II
... versionNumber 0..1 INT
... completionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent document lifecycle codes
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Binding: NCTIS Admin Codes Document Status (required)
... copyTime 0..1 TS
... recordTarget 1..* au-RecordTarget Australian-adapted RecordTarget class
... author 1..* au-Author Australian-adapted Author class
... dataEnterer 0..1 DataEnterer
... informant 0..* au-Informant Australian-adapted Informant class
... custodian 1..1 au-Custodian Australian-adapted Custodian class
... informationRecipient 0..* au-InformationRecipient Australian-adapted InformationRecipient class
... legalAuthenticator 0..1 au-LegalAuthenticator Australian-adapted LegalAuthenticator class
... authenticator 0..* Authenticator
... participant 0..* au-Participant1 Australian-adapted Participant class
... inFulfillmentOf 0..* au-InFulfillmentOf Australian-adapted InFulfillmentOf class
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* au-RelatedDocument Australian-adapted RelatedDocument class
... authorization 0..* Authorization
... componentOf 0..1 au-ComponentOf Australian-adapted ComponentOf class
... component 1..1 au-Component Australian-adapted Component class

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ClinicalDocument.classCode Base example CDAActClass 📦1.0.1 This IG
ClinicalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ClinicalDocument.completionCode Base required NCTIS Admin Codes Document Status 📦1.0.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Australian adaptation of the HL7 International CDA ClinicalDocument class

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... 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 Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
... code 1..1 CE
... title 0..1 ST
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS
... setId 0..1 II
... versionNumber 0..1 INT
... completionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent document lifecycle codes
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Binding: NCTIS Admin Codes Document Status (required)
... copyTime 0..1 TS
... recordTarget 1..* au-RecordTarget Australian-adapted RecordTarget class
... author 1..* au-Author Australian-adapted Author class
... dataEnterer 0..1 DataEnterer
... informant 0..* au-Informant Australian-adapted Informant class
... custodian 1..1 au-Custodian Australian-adapted Custodian class
... informationRecipient 0..* au-InformationRecipient Australian-adapted InformationRecipient class
... legalAuthenticator 0..1 au-LegalAuthenticator Australian-adapted LegalAuthenticator class
... authenticator 0..* Authenticator
... participant 0..* au-Participant1 Australian-adapted Participant class
... inFulfillmentOf 0..* au-InFulfillmentOf Australian-adapted InFulfillmentOf class
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* au-RelatedDocument Australian-adapted RelatedDocument class
... authorization 0..* Authorization
... componentOf 0..1 au-ComponentOf Australian-adapted ComponentOf class
... component 1..1 au-Component Australian-adapted Component class

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClinicalDocument.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ClinicalDocument.classCode Base example CDAActClass 📦1.0.1 This IG
ClinicalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ClinicalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ClinicalDocument.completionCode Base required NCTIS Admin Codes Document Status 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
II-1 error ClinicalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from ANY

Summary

Mandatory: 0 element(10 nested mandatory elements)
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 1

 

Other representations of profile: CSV, Excel