Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity | Version: 4.0.0 | |||
Draft as of 2025-10-02 | Computable Name: EncounterActivity | |||
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01 |
This clinical statement describes an interaction between a patient and clinician. Interactions may include in-person encounters, telephone conversations, and email exchanges.
Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:
Optional EntryRelationships: EncounterDiagnosis, Indication, InterpreterNeededObservation
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 3.0.0:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.49 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2015-08-01 | |
![]() ![]() ![]() |
1..1 | cs | ||
![]() ![]() ![]() |
1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | 𝗨𝗦𝗖𝗗𝗜: Identifier | |
![]() ![]() ![]() |
C | 1..1 | CD | 𝗨𝗦𝗖𝗗𝗜: Type Binding: Encounter Type ![]() Constraints: should-otext-ref-value |
![]() ![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of narrative corresponding to this code | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
1..1 | IVL_TS | 𝗨𝗦𝗖𝗗𝗜: Time | |
![]() ![]() ![]() |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc 𝗨𝗦𝗖𝗗𝗜: Disposition XML: dischargeDispositionCode (urn:hl7-org:sdtc) Binding: USEncounterDischargeDisposition (preferred) | |
![]() ![]() ![]() |
0..* | Performer2 | ||
![]() ![]() ![]() ![]() |
1..1 | AssignedEntity | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: Healthcare Provider Taxonomy ![]() | |
![]() ![]() ![]() |
0..* | Participant2 | Slice: Unordered, Open by profile:participantRole, value:typeCode | |
![]() ![]() ![]() ![]() |
0..* | Participant2 | 𝗨𝗦𝗖𝗗𝗜: Location | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: LOC | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ServiceDeliveryLocation | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by profile:act, profile:observation | |
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: RSON | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Indication | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: Diagnosis | |
![]() ![]() ![]() ![]() ![]() |
1..1 | EncounterDiagnosis | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation | |
![]() ![]() ![]() ![]() ![]() |
1..1 | InterpreterNeededObservation | ||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Encounter.code | Base | preferred |
Encounter Type
![]() |
📦20250510 | VSAC v0.23 |
Encounter.sdtcDischargeDispositionCode | Base | preferred | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.code | Base | preferred |
Healthcare Provider Taxonomy
![]() |
📦20240606 | VSAC v0.23 |
Id | Grade | Path(s) | Description | Expression |
should-otext-ref-value | warning | Encounter.code | SHOULD contain originalText/reference/@value |
originalText.reference.value.exists()
|
should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Encounter.code.originalText.reference, Encounter.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Path | Status | Usage | ValueSet | Version | Source |
Encounter.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.templateId:encounter-activity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.moodCode | Base | required | x_DocumentEncounterMood | 📍2.0.0 | THO v5.2 |
Encounter.code | Base | preferred |
Encounter Type
![]() |
📦20250510 | VSAC v0.23 |
Encounter.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Encounter.code.originalText.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Encounter.code.originalText.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Encounter.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Encounter.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
Encounter.sdtcDischargeDispositionCode | Base | preferred | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
Encounter.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
Encounter.performer.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.assignedEntity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.code | Base | preferred |
Healthcare Provider Taxonomy
![]() |
📦20240606 | VSAC v0.23 |
Encounter.participant:location.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Encounter.entryRelationship:diagnosis.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:diagnosis.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:diagnosis.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Encounter.entryRelationship:observation.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:observation.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:observation.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Id | Grade | Path(s) | Description | Expression |
II-1 | error | Encounter.typeId, Encounter.performer.typeId, Encounter.performer.assignedEntity.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:diagnosis.typeId, Encounter.entryRelationship:observation.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
should-otext-ref-value | warning | Encounter.code | SHOULD contain originalText/reference/@value |
originalText.reference.value.exists()
|
should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Encounter.code.originalText.reference, Encounter.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Path | Status | Usage | ValueSet | Version | Source |
Encounter.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.templateId:encounter-activity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.moodCode | Base | required | x_DocumentEncounterMood | 📍2.0.0 | THO v5.2 |
Encounter.code | Base | preferred |
Encounter Type
![]() |
📦20250510 | VSAC v0.23 |
Encounter.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Encounter.code.originalText.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Encounter.code.originalText.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Encounter.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Encounter.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
Encounter.sdtcDischargeDispositionCode | Base | preferred | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
Encounter.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
Encounter.performer.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.assignedEntity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.code | Base | preferred |
Healthcare Provider Taxonomy
![]() |
📦20240606 | VSAC v0.23 |
Encounter.participant:location.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Encounter.entryRelationship:diagnosis.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:diagnosis.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:diagnosis.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Encounter.entryRelationship:observation.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:observation.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:observation.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Id | Grade | Path(s) | Description | Expression |
II-1 | error | Encounter.typeId, Encounter.performer.typeId, Encounter.performer.assignedEntity.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:diagnosis.typeId, Encounter.entryRelationship:observation.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
should-otext-ref-value | warning | Encounter.code | SHOULD contain originalText/reference/@value |
originalText.reference.value.exists()
|
should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Encounter.code.originalText.reference, Encounter.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Encounter
Summary
Mandatory: 7 elements(3 nested mandatory elements)
Fixed: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.49 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2015-08-01 | |
![]() ![]() ![]() |
1..1 | cs | ||
![]() ![]() ![]() |
1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | 𝗨𝗦𝗖𝗗𝗜: Identifier | |
![]() ![]() ![]() |
C | 1..1 | CD | 𝗨𝗦𝗖𝗗𝗜: Type Binding: Encounter Type ![]() Constraints: should-otext-ref-value |
![]() ![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of narrative corresponding to this code | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
1..1 | IVL_TS | 𝗨𝗦𝗖𝗗𝗜: Time | |
![]() ![]() ![]() |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc 𝗨𝗦𝗖𝗗𝗜: Disposition XML: dischargeDispositionCode (urn:hl7-org:sdtc) Binding: USEncounterDischargeDisposition (preferred) | |
![]() ![]() ![]() |
0..* | Performer2 | ||
![]() ![]() ![]() ![]() |
1..1 | AssignedEntity | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: Healthcare Provider Taxonomy ![]() | |
![]() ![]() ![]() |
0..* | Participant2 | Slice: Unordered, Open by profile:participantRole, value:typeCode | |
![]() ![]() ![]() ![]() |
0..* | Participant2 | 𝗨𝗦𝗖𝗗𝗜: Location | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: LOC | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ServiceDeliveryLocation | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by profile:act, profile:observation | |
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: RSON | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Indication | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: Diagnosis | |
![]() ![]() ![]() ![]() ![]() |
1..1 | EncounterDiagnosis | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation | |
![]() ![]() ![]() ![]() ![]() |
1..1 | InterpreterNeededObservation | ||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Encounter.code | Base | preferred |
Encounter Type
![]() |
📦20250510 | VSAC v0.23 |
Encounter.sdtcDischargeDispositionCode | Base | preferred | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.code | Base | preferred |
Healthcare Provider Taxonomy
![]() |
📦20240606 | VSAC v0.23 |
Id | Grade | Path(s) | Description | Expression |
should-otext-ref-value | warning | Encounter.code | SHOULD contain originalText/reference/@value |
originalText.reference.value.exists()
|
should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Encounter.code.originalText.reference, Encounter.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Key Elements View
Path | Status | Usage | ValueSet | Version | Source |
Encounter.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.templateId:encounter-activity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.moodCode | Base | required | x_DocumentEncounterMood | 📍2.0.0 | THO v5.2 |
Encounter.code | Base | preferred |
Encounter Type
![]() |
📦20250510 | VSAC v0.23 |
Encounter.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Encounter.code.originalText.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Encounter.code.originalText.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Encounter.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Encounter.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
Encounter.sdtcDischargeDispositionCode | Base | preferred | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
Encounter.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
Encounter.performer.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.assignedEntity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.code | Base | preferred |
Healthcare Provider Taxonomy
![]() |
📦20240606 | VSAC v0.23 |
Encounter.participant:location.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Encounter.entryRelationship:diagnosis.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:diagnosis.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:diagnosis.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Encounter.entryRelationship:observation.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:observation.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:observation.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Id | Grade | Path(s) | Description | Expression |
II-1 | error | Encounter.typeId, Encounter.performer.typeId, Encounter.performer.assignedEntity.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:diagnosis.typeId, Encounter.entryRelationship:observation.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
should-otext-ref-value | warning | Encounter.code | SHOULD contain originalText/reference/@value |
originalText.reference.value.exists()
|
should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Encounter.code.originalText.reference, Encounter.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Snapshot View
Path | Status | Usage | ValueSet | Version | Source |
Encounter.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.templateId:encounter-activity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.moodCode | Base | required | x_DocumentEncounterMood | 📍2.0.0 | THO v5.2 |
Encounter.code | Base | preferred |
Encounter Type
![]() |
📦20250510 | VSAC v0.23 |
Encounter.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.code.originalText.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Encounter.code.originalText.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Encounter.code.originalText.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Encounter.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Encounter.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
Encounter.sdtcDischargeDispositionCode | Base | preferred | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
Encounter.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
Encounter.performer.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.assignedEntity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.performer.assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
Encounter.performer.assignedEntity.code | Base | preferred |
Healthcare Provider Taxonomy
![]() |
📦20240606 | VSAC v0.23 |
Encounter.participant:location.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.participant:location.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:indication.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Encounter.entryRelationship:diagnosis.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:diagnosis.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:diagnosis.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Encounter.entryRelationship:observation.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:observation.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Encounter.entryRelationship:observation.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Id | Grade | Path(s) | Description | Expression |
II-1 | error | Encounter.typeId, Encounter.performer.typeId, Encounter.performer.assignedEntity.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:diagnosis.typeId, Encounter.entryRelationship:observation.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
should-otext-ref-value | warning | Encounter.code | SHOULD contain originalText/reference/@value |
originalText.reference.value.exists()
|
should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Encounter.code.originalText.reference, Encounter.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Encounter
Summary
Mandatory: 7 elements(3 nested mandatory elements)
Fixed: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: