Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: PlannedEncounter - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the PlannedEncounter logical model.

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

0. Encounter
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Encounter.classCode
Comments

SHALL contain exactly one [1..1] @classCode="ENC" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8564).

4. Encounter.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-8565).

BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
6. Encounter.templateId
Control1..?
SlicingThis element introduces a set of slices on Encounter.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
8. Encounter.templateId:primary
Slice Nameprimary
Comments

SHALL contain exactly one [1..1] templateId (CONF:1098-30437) such that it

Control1..1
10. Encounter.templateId:primary.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.40" (CONF:1098-30438).

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.40
12. Encounter.templateId:primary.extension
Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32553).

Control1..?
Pattern Value2014-06-09
14. Encounter.id
Comments

SHALL contain at least one [1..*] id (CONF:1098-8567).

Control1..?
16. Encounter.code
ShortRecords the type of encounter ordered or recommended.
Comments

SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Encounter Planned urn:oid:2.16.840.1.113883.11.20.9.52 DYNAMIC (CONF:1098-31032).

BindingThe codes SHOULD be taken from Encounter Planned
18. Encounter.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:1098-30439).

Control1..?
20. Encounter.statusCode.code
Comments

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31880).

Control1..?
Fixed Valueactive
22. Encounter.effectiveTime
Comments

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30440).

24. Encounter.performer
ShortPerformers represent clinicians who are responsible for assessing and treating the patient.
SlicingThis element introduces a set of slices on Encounter.performer. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ Encounter.assignedEntity
26. Encounter.performer:performer
Slice Nameperformer
Comments

MAY contain zero or more [0..*] performer (CONF:1098-30442) such that it

Control0..*
28. Encounter.performer:performer.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:1098-31874).

30. Encounter.author
ShortThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
Comments

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32045).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
32. Encounter.participant
ShortThis location participation captures where the planned or ordered encounter may take place.
SlicingThis element introduces a set of slices on Encounter.participant. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ participantRole
34. Encounter.participant:location
Slice Namelocation
Comments

MAY contain zero or more [0..*] participant (CONF:1098-30443) such that it

Control0..*
36. Encounter.participant:location.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="LOC" Location (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1098-31875).

Control1..?
Fixed ValueLOC
38. Encounter.participant:location.participantRole
Comments

SHALL contain exactly one [1..1] Service Delivery Location (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.32) (CONF:1098-31876).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole(Service Delivery Location)
40. Encounter.entryRelationship
ShortThe following entryRelationship captures the reason for the planned or ordered encounter
SlicingThis element introduces a set of slices on Encounter.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ observation
42. Encounter.entryRelationship:priorityPreference
Slice NamepriorityPreference
ShortThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
Comments

MAY contain zero or one [0..1] entryRelationship (CONF:1098-31033) such that it

Control0..1
44. Encounter.entryRelationship:priorityPreference.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31034).

Fixed ValueREFR
46. Encounter.entryRelationship:priorityPreference.observation
Comments

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31035).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
48. Encounter.entryRelationship:indication
Slice Nameindication
Comments

MAY contain zero or more [0..*] entryRelationship (CONF:1098-31877) such that it

Control0..*
50. Encounter.entryRelationship:indication.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31878).

Fixed ValueRSON
52. Encounter.entryRelationship:indication.observation
Comments

SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-31879).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)