Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/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.1
Active as of 2023-10-03 Computable Name: CDAR2.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 Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... code 0..1CEBinding: ActEncounterCode (extensible)
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (extensible)
... 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 / Code
EncompassingEncounter.classCoderequiredFixed Value: ENC
EncompassingEncounter.moodCoderequiredFixed Value: EVN
EncompassingEncounter.codeextensibleActEncounterCode
EncompassingEncounter.dischargeDispositionCodeextensibleUSEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC
NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... code 0..1CEBinding: ActEncounterCode (extensible)
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (extensible)
... 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 / Code
EncompassingEncounter.classCoderequiredFixed Value: ENC
EncompassingEncounter.moodCoderequiredFixed Value: EVN
EncompassingEncounter.codeextensibleActEncounterCode
EncompassingEncounter.dischargeDispositionCodeextensibleUSEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... code 0..1CEBinding: ActEncounterCode (extensible)
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (extensible)
... responsibleParty 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1AssignedEntity
... encounterParticipant 0..*EncounterParticipant
... location 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1HealthCareFacility

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
EncompassingEncounter.classCoderequiredFixed Value: ENC
EncompassingEncounter.moodCoderequiredFixed Value: EVN
EncompassingEncounter.codeextensibleActEncounterCode
EncompassingEncounter.dischargeDispositionCodeextensibleUSEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.nullFlavorrequiredNullFlavor
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
EncompassingEncounter.location.nullFlavorrequiredNullFlavor
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Base

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 Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... code 0..1CEBinding: ActEncounterCode (extensible)
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (extensible)
... 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 / Code
EncompassingEncounter.classCoderequiredFixed Value: ENC
EncompassingEncounter.moodCoderequiredFixed Value: EVN
EncompassingEncounter.codeextensibleActEncounterCode
EncompassingEncounter.dischargeDispositionCodeextensibleUSEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... code 0..1CEBinding: ActEncounterCode (extensible)
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (extensible)
... 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 / Code
EncompassingEncounter.classCoderequiredFixed Value: ENC
EncompassingEncounter.moodCoderequiredFixed Value: EVN
EncompassingEncounter.codeextensibleActEncounterCode
EncompassingEncounter.dischargeDispositionCodeextensibleUSEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EncompassingEncounter 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... code 0..1CEBinding: ActEncounterCode (extensible)
... effectiveTime 1..1IVL_TS
... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (extensible)
... responsibleParty 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
.... assignedEntity 1..1AssignedEntity
... encounterParticipant 0..*EncounterParticipant
... location 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
.... healthCareFacility 1..1HealthCareFacility

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
EncompassingEncounter.classCoderequiredFixed Value: ENC
EncompassingEncounter.moodCoderequiredFixed Value: EVN
EncompassingEncounter.codeextensibleActEncounterCode
EncompassingEncounter.dischargeDispositionCodeextensibleUSEncounterDischargeDisposition
EncompassingEncounter.responsibleParty.nullFlavorrequiredNullFlavor
EncompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
EncompassingEncounter.location.nullFlavorrequiredNullFlavor
EncompassingEncounter.location.typeCoderequiredFixed Value: LOC

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Base

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