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 EncompassingEncounter (CDA Class)

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

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

Formal Views of Profile Content

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

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

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... @classCode 0..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CE Binding: ActEncounterCode (example)
... effectiveTime 1..1 IVL_TS
... dischargeDispositionCode 0..1 CE Binding: USEncounterDischargeDisposition (example)
... responsibleParty 0..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: RESP
.... assignedEntity 1..1 au-AssignedEntity Australian-adapted AssignedEntity class
... encounterParticipant 0..* au-EncounterParticipant
... location 0..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: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1 au-HealthCareFacility Australian-adapted HealthCareFacility class

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EncompassingEncounter.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​classCode Base required CDAActClass 📦1.0.1 This IG
EncompassingEncounter.​moodCode Base required CDAActMood 📦1.0.1 This IG
EncompassingEncounter.​code Base example ActEncounterCode 📦2.0.0 THO v5.2
EncompassingEncounter.​dischargeDispositionCode Base example USEncounterDischargeDisposition 📦2.0.0 THO v5.2
EncompassingEncounter.​responsibleParty.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​responsibleParty.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​responsibleParty.typeCode Base required CDAParticipationType 📦1.0.1 This IG
EncompassingEncounter.​location.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​location.typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​location.typeCode Base required ParticipationTargetLocation 📦2.0.0 THO v5.2

Constraints

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

This structure is derived from InfrastructureRoot

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

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... effectiveTime 1..1 IVL_TS
... dischargeDispositionCode 0..1 CE Binding: USEncounterDischargeDisposition (example)
... responsibleParty 0..1 InfrastructureRoot
.... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1 au-AssignedEntity Australian-adapted AssignedEntity class
... encounterParticipant 0..* au-EncounterParticipant
... location 0..1 InfrastructureRoot
.... @typeCode 0..1 cs Binding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1 au-HealthCareFacility Australian-adapted HealthCareFacility class

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
EncompassingEncounter.​classCode Base required CDAActClass 📦1.0.1 This IG
EncompassingEncounter.​moodCode Base required CDAActMood 📦1.0.1 This IG
EncompassingEncounter.​code Base example ActEncounterCode 📦2.0.0 THO v5.2
EncompassingEncounter.​dischargeDispositionCode Base example USEncounterDischargeDisposition 📦2.0.0 THO v5.2
EncompassingEncounter.​responsibleParty.typeCode Base required CDAParticipationType 📦1.0.1 This IG
EncompassingEncounter.​location.typeCode Base required ParticipationTargetLocation 📦2.0.0 THO v5.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EncompassingEncounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Australian adaptation of the HL7 International CDA EncompassingEncounter class

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... @classCode 0..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CE Binding: ActEncounterCode (example)
... effectiveTime 1..1 IVL_TS
... dischargeDispositionCode 0..1 CE Binding: USEncounterDischargeDisposition (example)
... responsibleParty 0..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: RESP
.... assignedEntity 1..1 au-AssignedEntity Australian-adapted AssignedEntity class
... encounterParticipant 0..* au-EncounterParticipant
... location 0..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: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1 au-HealthCareFacility Australian-adapted HealthCareFacility class

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EncompassingEncounter.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​classCode Base required CDAActClass 📦1.0.1 This IG
EncompassingEncounter.​moodCode Base required CDAActMood 📦1.0.1 This IG
EncompassingEncounter.​code Base example ActEncounterCode 📦2.0.0 THO v5.2
EncompassingEncounter.​dischargeDispositionCode Base example USEncounterDischargeDisposition 📦2.0.0 THO v5.2
EncompassingEncounter.​responsibleParty.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​responsibleParty.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​responsibleParty.typeCode Base required CDAParticipationType 📦1.0.1 This IG
EncompassingEncounter.​location.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​location.typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​location.typeCode Base required ParticipationTargetLocation 📦2.0.0 THO v5.2

Constraints

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

Key Elements View

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

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... @classCode 0..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CE Binding: ActEncounterCode (example)
... effectiveTime 1..1 IVL_TS
... dischargeDispositionCode 0..1 CE Binding: USEncounterDischargeDisposition (example)
... responsibleParty 0..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: RESP
.... assignedEntity 1..1 au-AssignedEntity Australian-adapted AssignedEntity class
... encounterParticipant 0..* au-EncounterParticipant
... location 0..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: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1 au-HealthCareFacility Australian-adapted HealthCareFacility class

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EncompassingEncounter.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​classCode Base required CDAActClass 📦1.0.1 This IG
EncompassingEncounter.​moodCode Base required CDAActMood 📦1.0.1 This IG
EncompassingEncounter.​code Base example ActEncounterCode 📦2.0.0 THO v5.2
EncompassingEncounter.​dischargeDispositionCode Base example USEncounterDischargeDisposition 📦2.0.0 THO v5.2
EncompassingEncounter.​responsibleParty.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​responsibleParty.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​responsibleParty.typeCode Base required CDAParticipationType 📦1.0.1 This IG
EncompassingEncounter.​location.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​location.typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​location.typeCode Base required ParticipationTargetLocation 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error EncompassingEncounter.typeId, EncompassingEncounter.responsibleParty.typeId, EncompassingEncounter.location.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

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

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... effectiveTime 1..1 IVL_TS
... dischargeDispositionCode 0..1 CE Binding: USEncounterDischargeDisposition (example)
... responsibleParty 0..1 InfrastructureRoot
.... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1 au-AssignedEntity Australian-adapted AssignedEntity class
... encounterParticipant 0..* au-EncounterParticipant
... location 0..1 InfrastructureRoot
.... @typeCode 0..1 cs Binding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1 au-HealthCareFacility Australian-adapted HealthCareFacility class

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
EncompassingEncounter.​classCode Base required CDAActClass 📦1.0.1 This IG
EncompassingEncounter.​moodCode Base required CDAActMood 📦1.0.1 This IG
EncompassingEncounter.​code Base example ActEncounterCode 📦2.0.0 THO v5.2
EncompassingEncounter.​dischargeDispositionCode Base example USEncounterDischargeDisposition 📦2.0.0 THO v5.2
EncompassingEncounter.​responsibleParty.typeCode Base required CDAParticipationType 📦1.0.1 This IG
EncompassingEncounter.​location.typeCode Base required ParticipationTargetLocation 📦2.0.0 THO v5.2

Snapshot View

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

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... @classCode 0..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CE Binding: ActEncounterCode (example)
... effectiveTime 1..1 IVL_TS
... dischargeDispositionCode 0..1 CE Binding: USEncounterDischargeDisposition (example)
... responsibleParty 0..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: RESP
.... assignedEntity 1..1 au-AssignedEntity Australian-adapted AssignedEntity class
... encounterParticipant 0..* au-EncounterParticipant
... location 0..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: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1 au-HealthCareFacility Australian-adapted HealthCareFacility class

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EncompassingEncounter.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​classCode Base required CDAActClass 📦1.0.1 This IG
EncompassingEncounter.​moodCode Base required CDAActMood 📦1.0.1 This IG
EncompassingEncounter.​code Base example ActEncounterCode 📦2.0.0 THO v5.2
EncompassingEncounter.​dischargeDispositionCode Base example USEncounterDischargeDisposition 📦2.0.0 THO v5.2
EncompassingEncounter.​responsibleParty.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​responsibleParty.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​responsibleParty.typeCode Base required CDAParticipationType 📦1.0.1 This IG
EncompassingEncounter.​location.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​location.typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
EncompassingEncounter.​location.typeCode Base required ParticipationTargetLocation 📦2.0.0 THO v5.2

Constraints

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

 

Other representations of profile: CSV, Excel