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

Logical Model: ADHA Encounter (CDA Class)

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter Version: 1.0.0
Active as of 2024-12-18 Computable Name: au-Encounter

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 Encounter 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

Usage:

Formal Views of Profile Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA Encounter class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: XDocumentEncounterMood (2.0.0) (required)
... id 0..* II
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..1 IVL_TS
... admissionReferralSourceCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent admission referral source code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... dischargeDispositionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent discharge disposition code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* au-Performer2 Australian-adapted Performer class
... author 0..* au-Author Australian-adapted Author class
... informant 0..* au-Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* au-Reference Australian-adapted Reference class
... precondition 0..* au-Precondition Australian-adapted Precondition class
... InFulfillmentOf 0..* au-InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent InFulfillmentOf
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
Encounter.moodCoderequiredXDocumentEncounterMood
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA Encounter class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: XDocumentEncounterMood (2.0.0) (required)
... id 0..* II
... code 0..1 CD Binding: ActEncounterCode (example)
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..1 IVL_TS
... admissionReferralSourceCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent admission referral source code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... dischargeDispositionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent discharge disposition code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* au-Performer2 Australian-adapted Performer class
... author 0..* au-Author Australian-adapted Author class
... informant 0..* au-Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* au-Reference Australian-adapted Reference class
... precondition 0..* au-Precondition Australian-adapted Precondition class
... InFulfillmentOf 0..* au-InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent InFulfillmentOf
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
Encounter.moodCoderequiredXDocumentEncounterMood
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEncounter.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA Encounter class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: XDocumentEncounterMood (2.0.0) (required)
... id 0..* II
... code 0..1 CD Binding: ActEncounterCode (example)
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..1 IVL_TS
... admissionReferralSourceCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent admission referral source code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... dischargeDispositionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent discharge disposition code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* au-Performer2 Australian-adapted Performer class
... author 0..* au-Author Australian-adapted Author class
... informant 0..* au-Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* au-Reference Australian-adapted Reference class
... precondition 0..* au-Precondition Australian-adapted Precondition class
... InFulfillmentOf 0..* au-InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent InFulfillmentOf
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
Encounter.moodCoderequiredXDocumentEncounterMood
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEncounter.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA Encounter class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: XDocumentEncounterMood (2.0.0) (required)
... id 0..* II
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..1 IVL_TS
... admissionReferralSourceCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent admission referral source code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... dischargeDispositionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent discharge disposition code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* au-Performer2 Australian-adapted Performer class
... author 0..* au-Author Australian-adapted Author class
... informant 0..* au-Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* au-Reference Australian-adapted Reference class
... precondition 0..* au-Precondition Australian-adapted Precondition class
... InFulfillmentOf 0..* au-InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent InFulfillmentOf
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
Encounter.moodCoderequiredXDocumentEncounterMood
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA Encounter class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: XDocumentEncounterMood (2.0.0) (required)
... id 0..* II
... code 0..1 CD Binding: ActEncounterCode (example)
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..1 IVL_TS
... admissionReferralSourceCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent admission referral source code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... dischargeDispositionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent discharge disposition code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* au-Performer2 Australian-adapted Performer class
... author 0..* au-Author Australian-adapted Author class
... informant 0..* au-Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* au-Reference Australian-adapted Reference class
... precondition 0..* au-Precondition Australian-adapted Precondition class
... InFulfillmentOf 0..* au-InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent InFulfillmentOf
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
Encounter.moodCoderequiredXDocumentEncounterMood
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEncounter.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA Encounter class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: XDocumentEncounterMood (2.0.0) (required)
... id 0..* II
... code 0..1 CD Binding: ActEncounterCode (example)
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..1 IVL_TS
... admissionReferralSourceCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent admission referral source code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... dischargeDispositionCode 0..1 CE XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent discharge disposition code
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* au-Performer2 Australian-adapted Performer class
... author 0..* au-Author Australian-adapted Author class
... informant 0..* au-Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* au-Reference Australian-adapted Reference class
... precondition 0..* au-Precondition Australian-adapted Precondition class
... InFulfillmentOf 0..* au-InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent InFulfillmentOf
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
Encounter.moodCoderequiredXDocumentEncounterMood
http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0
Encounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEncounter.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

 

Other representations of profile: CSV, Excel