Clinical Document Architecture
2.0.0-sd-ballot - ballot

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: EncompassingEncounter (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter Version: 2.0.0-sd-ballot
Active as of 2024-03-04 Computable Name: EncompassingEncounter

This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can’t, and writes a Progress Note. In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is “Diabetes Clinic Progress Note”. The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply “Clinic Progress Note” and the value of HealthCareFacility.code is “cardiology clinic”), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation. EncompassingEncounter.dischargeDispositionCode can be used to depict the disposition of the patient at the time of hospital discharge (e.g., discharged to home, expired, against medical advice, etc.).

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..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (example)
... responsibleParty 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1AssignedEntity
... encounterParticipant 0..*EncounterParticipant
... location 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1HealthCareFacility

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://terminology.hl7.org/ValueSet/v3-ActClass
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://terminology.hl7.org/ValueSet/v3-ParticipationType
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation
NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (example)
... responsibleParty 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1AssignedEntity
... encounterParticipant 0..*EncounterParticipant
... location 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1HealthCareFacility

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://terminology.hl7.org/ValueSet/v3-ActClass
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://terminology.hl7.org/ValueSet/v3-ParticipationType
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation
NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... code 0..1CEBinding: ActEncounterCode (example)
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (example)
... responsibleParty 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1AssignedEntity
... encounterParticipant 0..*EncounterParticipant
... location 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1HealthCareFacility

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://terminology.hl7.org/ValueSet/v3-ActClass
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
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://terminology.hl7.org/ValueSet/v3-ParticipationType
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

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (example)
... responsibleParty 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1AssignedEntity
... encounterParticipant 0..*EncounterParticipant
... location 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1HealthCareFacility

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://terminology.hl7.org/ValueSet/v3-ActClass
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://terminology.hl7.org/ValueSet/v3-ParticipationType
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (example)
... responsibleParty 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1AssignedEntity
... encounterParticipant 0..*EncounterParticipant
... location 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1HealthCareFacility

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EncompassingEncounter.classCoderequiredFixed Value: ENC
http://terminology.hl7.org/ValueSet/v3-ActClass
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
EncompassingEncounter.codeexampleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
EncompassingEncounter.dischargeDispositionCodeexampleUSEncounterDischargeDisposition
http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
http://terminology.hl7.org/ValueSet/v3-ParticipationType
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... code 0..1CEBinding: ActEncounterCode (example)
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (example)
... responsibleParty 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1AssignedEntity
... encounterParticipant 0..*EncounterParticipant
... location 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1HealthCareFacility

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://terminology.hl7.org/ValueSet/v3-ActClass
EncompassingEncounter.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
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://terminology.hl7.org/ValueSet/v3-ParticipationType
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

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel