Clinical Document Architecture
2.0.1-sd - release

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

Logical Model: Encounter (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Encounter Version: 2.0.1-sd
Active as of 2025-10-02 Computable Name: Encounter

A derivative of the RIM PatientEncounter class, used to represent related encounters, such as follow-up visits or referenced past encounters.

NOTE: The EncompassingEncounter class in the CDA Header (see Header Relationships (ยง 4.2.3 )) represents the setting of the clinical encounter during which the documented act occurred. The Encounter class in the CDA Body is used to represent other related encounters.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: 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
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.classCode Base required CDAActClass 📦2.0.1-sd This IG
Encounter.moodCode Base required x_DocumentEncounterMood 📍2.0.0 THO v5.2
Encounter.code Base example ActEncounterCode 📦2.0.0 THO v5.2
Encounter.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Encounter.priorityCode Base example ActPriority 📦2.0.0 THO v5.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

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 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
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Encounter.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Encounter.classCode Base required CDAActClass 📦2.0.1-sd This IG
Encounter.moodCode Base required x_DocumentEncounterMood 📍2.0.0 THO v5.2
Encounter.code Base example ActEncounterCode 📦2.0.0 THO v5.2
Encounter.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Encounter.priorityCode Base example ActPriority 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Encounter.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

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 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
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Encounter.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Encounter.classCode Base required CDAActClass 📦2.0.1-sd This IG
Encounter.moodCode Base required x_DocumentEncounterMood 📍2.0.0 THO v5.2
Encounter.code Base example ActEncounterCode 📦2.0.0 THO v5.2
Encounter.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Encounter.priorityCode Base example ActPriority 📦2.0.0 THO v5.2

Constraints

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

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: 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
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.classCode Base required CDAActClass 📦2.0.1-sd This IG
Encounter.moodCode Base required x_DocumentEncounterMood 📍2.0.0 THO v5.2
Encounter.code Base example ActEncounterCode 📦2.0.0 THO v5.2
Encounter.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Encounter.priorityCode Base example ActPriority 📦2.0.0 THO v5.2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

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 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
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Encounter.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Encounter.classCode Base required CDAActClass 📦2.0.1-sd This IG
Encounter.moodCode Base required x_DocumentEncounterMood 📍2.0.0 THO v5.2
Encounter.code Base example ActEncounterCode 📦2.0.0 THO v5.2
Encounter.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Encounter.priorityCode Base example ActPriority 📦2.0.0 THO v5.2

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

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 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
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Encounter.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Encounter.classCode Base required CDAActClass 📦2.0.1-sd This IG
Encounter.moodCode Base required x_DocumentEncounterMood 📍2.0.0 THO v5.2
Encounter.code Base example ActEncounterCode 📦2.0.0 THO v5.2
Encounter.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Encounter.priorityCode Base example ActPriority 📦2.0.0 THO v5.2

Constraints

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

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel