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: CDAR2.Encounter - Detailed Descriptions

Active as of 2023-10-03

Definitions for the Encounter logical model.

Guidance on how to interpret the contents of this table can be found here

0. Encounter
Control1..1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Encounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueENC
4. Encounter.moodCode
Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
6. Encounter.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. Encounter.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Encounter.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Encounter.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
14. Encounter.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
16. Encounter.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
18. Encounter.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
20. Encounter.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
22. Encounter.sdtcDischargeDispositionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedischargeDispositionCode.
24. Encounter.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
26. Encounter.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
28. Encounter.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
30. Encounter.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
32. Encounter.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
34. Encounter.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
36. Encounter.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
38. Encounter.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
40. Encounter.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
42. Encounter.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition

Guidance on how to interpret the contents of this table can be found here

0. Encounter
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Encounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueENC
4. Encounter.moodCode
Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
6. Encounter.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. Encounter.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Encounter.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Encounter.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..*1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
14. Encounter.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
16. Encounter.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EDNarrative
Is Modifierfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Encounter.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
20. Encounter.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
22. Encounter.sdtcDischargeDispositionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedischargeDispositionCode.
24. Encounter.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
26. Encounter.subject
Definition

The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.

ShortThe patient or group related to this encounter
Comments

While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubjectReference(Patient, Group)
Is Modifierfalse
Alternate Namespatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Encounter.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
30. Encounter.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
32. Encounter.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
34. Encounter.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
36. Encounter.participant
Definition

The list of people responsible for providing the service.

ShortList of participants involved in the encounter
Comments

Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2BackboneElement
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
enc-1: A type must be provided when no explicit actor is specified (actor.exists() or type.exists())
enc-2: A type cannot be provided for a patient or group participant (actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not())
38. Encounter.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
40. Encounter.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
42. Encounter.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition

Guidance on how to interpret the contents of this table can be found here

0. Encounter
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Encounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueENC
4. Encounter.moodCode
Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
6. Encounter.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. Encounter.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Encounter.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Encounter.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
14. Encounter.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
16. Encounter.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
18. Encounter.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
20. Encounter.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
22. Encounter.sdtcDischargeDispositionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedischargeDispositionCode.
24. Encounter.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
26. Encounter.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
28. Encounter.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
30. Encounter.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
32. Encounter.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
34. Encounter.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
36. Encounter.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
38. Encounter.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
40. Encounter.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
42. Encounter.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition