Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.40 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: PlannedEncounter | |||
Other Identifiers: : urn:hl7ii:2.16.840.1.113883.10.20.22.4.40:2014-06-09 |
This template represents a planned or ordered encounter. The type of encounter (e.g., comprehensive outpatient visit) is represented. Clinicians participating in the encounter and the location of the planned encounter may be captured. The priority that the patient and providers place on the encounter may be represented.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Encounter
Summary
Mandatory: 8 elements (7 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from CDAR2.Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 1..1 | CDAR2.Encounter | ||
classCode | 1..1 | code | Required Pattern: ENC | |
moodCode | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.40 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 0..1 | CD | Records the type of encounter ordered or recommended. Binding: Encounter Planned (preferred) | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
effectiveTime | 0..1 | IVL_TS | ||
performer | 0..* | Performer2 | Performers represent clinicians who are responsible for assessing and treating the patient. Slice: Unordered, Open by value:Encounter.assignedEntity | |
performer | 0..* | Performer2 | ||
assignedEntity | 1..1 | AssignedEntity | ||
author | 0..* | AuthorParticipation | The author in a planned encounter represents the clinician who is requesting or planning the encounter. | |
Slices for participant | 0..* | Participant2 | This location participation captures where the planned or ordered encounter may take place. Slice: Unordered, Open by value:typeCode, value:participantRole | |
participant:location | 0..* | Participant2 | ||
typeCode | 1..1 | code | Required Pattern: LOC | |
participantRole | 1..1 | ServiceDeliveryLocation | ||
Slices for entryRelationship | 0..* | Element | The following entryRelationship captures the reason for the planned or ordered encounter Slice: Unordered, Open by profile:observation | |
entryRelationship:priorityPreference | 0..1 | Element | The following entryRelationship represents the priority that a patient or a provider places on the encounter. | |
typeCode | 1..1 | code | Required Pattern: REFR | |
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
Documentation for this format |
This structure is derived from CDAR2.Encounter
Summary
Mandatory: 8 elements (7 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 1..1 | CDAR2.Encounter | ||
classCode | 1..1 | code | Required Pattern: ENC | |
moodCode | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.40 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 0..1 | CD | Records the type of encounter ordered or recommended. Binding: Encounter Planned (preferred) | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
effectiveTime | 0..1 | IVL_TS | ||
performer | 0..* | Performer2 | Performers represent clinicians who are responsible for assessing and treating the patient. Slice: Unordered, Open by value:Encounter.assignedEntity | |
performer | 0..* | Performer2 | ||
assignedEntity | 1..1 | AssignedEntity | ||
author | 0..* | AuthorParticipation | The author in a planned encounter represents the clinician who is requesting or planning the encounter. | |
Slices for participant | 0..* | Participant2 | This location participation captures where the planned or ordered encounter may take place. Slice: Unordered, Open by value:typeCode, value:participantRole | |
participant:location | 0..* | Participant2 | ||
typeCode | 1..1 | code | Required Pattern: LOC | |
participantRole | 1..1 | ServiceDeliveryLocation | ||
Slices for entryRelationship | 0..* | Element | The following entryRelationship captures the reason for the planned or ordered encounter Slice: Unordered, Open by profile:observation | |
entryRelationship:priorityPreference | 0..1 | Element | The following entryRelationship represents the priority that a patient or a provider places on the encounter. | |
typeCode | 1..1 | code | Required Pattern: REFR | |
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
Documentation for this format |
Snapshot View
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Encounter.classCode | required | Fixed Value: ENC |
Encounter.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
Encounter.templateId:primary.nullFlavor | required | NullFlavor |
Encounter.code | preferred | EncounterPlanned |
Encounter.statusCode | required | ActStatus |
Encounter.statusCode.nullFlavor | required | NullFlavor |
Encounter.priorityCode | extensible | ActPriority |
Encounter.subject.typeCode | required | Fixed Value: SBJ |
Encounter.subject.contextControlCode | required | Fixed Value: OP |
Encounter.subject.awarenessCode | extensible | TargetAwareness |
Encounter.performer.nullFlavor | required | NullFlavor |
Encounter.performer.typeCode | required | Fixed Value: PRF |
Encounter.informant.typeCode | required | Fixed Value: INF |
Encounter.informant.contextControlCode | required | Fixed Value: OP |
Encounter.participant:location.nullFlavor | required | NullFlavor |
Encounter.participant:location.typeCode | required | Pattern: LOC |
Encounter.participant:location.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path | Details | Requirements |
enc-er-1 | error | Encounter.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
enc-er-1 | error | Encounter.entryRelationship:priorityPreference | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
enc-er-1 | error | Encounter.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |