Clinical Document Architecture with Australian Schema
1.0.0 - current Australia flag

Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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.0
Active as of 2024-08-29 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

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
.. EncompassingEncounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA EncompassingEncounter class
Instance of this type are validated by templateId
Logical Container: ADHA 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)

PathConformanceValueSet / CodeURI
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation
NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA EncompassingEncounter class
Instance of this type are validated by templateId
Logical Container: ADHA 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

PathConformanceValueSet / CodeURI
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation
NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA EncompassingEncounter 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 0..1 II
.... @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 0..1 II
..... @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 0..1 II
..... @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

PathConformanceValueSet / CodeURI
EncompassingEncounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.responsibleParty.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
EncompassingEncounter.location.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.location.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA EncompassingEncounter class
Instance of this type are validated by templateId
Logical Container: ADHA 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)

PathConformanceValueSet / CodeURI
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA EncompassingEncounter class
Instance of this type are validated by templateId
Logical Container: ADHA 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

PathConformanceValueSet / CodeURI
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA EncompassingEncounter 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 0..1 II
.... @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 0..1 II
..... @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 0..1 II
..... @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

PathConformanceValueSet / CodeURI
EncompassingEncounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.responsibleParty.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
from this IG
EncompassingEncounter.location.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.location.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation

 

Other representations of profile: CSV, Excel