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: Planned Encounter

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedEncounter Version: 2.1
Draft as of 2023-09-29 Computable Name: PlannedEncounter
Other Identifiers: id: 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:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter CDAR2.EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1cs
... moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... extension 1..1stRequired Pattern: 2014-06-09
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TS
... Slices for performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
.... performer:performer 0..*Performer2
..... assignedEntity 1..1AssignedEntity
... author 0..*AuthorParticipationThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
... Slices for participant 0..*Participant2This 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..1csFixed Value: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationship
..... typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Encounter.moodCoderequiredPlanned moodCode (Act/Encounter/Procedure)
Encounter.codepreferredEncounter Planned
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1CDAR2.EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1stRequired Pattern: 2014-06-09
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TS
... Slices for performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
.... performer:performer 0..*Performer2
..... assignedEntity 1..1AssignedEntity
... author 0..*AuthorParticipationThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
... Slices for participant 0..*Participant2This 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..1csBinding: ParticipationType (required)
Fixed Value: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation 1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.classCoderequiredFixed Value: ENC
Encounter.moodCoderequiredPlanned moodCode (Act/Encounter/Procedure)
Encounter.codepreferredEncounter Planned
Encounter.statusCoderequiredActStatus
Encounter.participant:location.typeCoderequiredFixed Value: LOC
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1CDAR2.EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... realmCode 0..*CS
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... sdtcDischargeDispositionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1CEBinding: ActPriority (extensible)
... subject 0..1Subject
... specimen 0..*Specimen
... Slices for performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
.... performer:performer 0..*Performer2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... modeCode 0..1CE
..... assignedEntity 1..1AssignedEntity
... author 0..*AuthorParticipationThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
... informant 0..*Informant
... Slices for participant 0..*Participant2This location participation captures where the planned or ordered encounter may take place.
Slice: Unordered, Open by value:typeCode, value:participantRole
.... participant:location 0..*Participant2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: LOC
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.classCoderequiredFixed Value: ENC
Encounter.moodCoderequiredPlanned moodCode (Act/Encounter/Procedure)
Encounter.templateId:primary.nullFlavorrequiredNullFlavor
Encounter.codepreferredEncounter Planned
Encounter.statusCoderequiredActStatus
Encounter.statusCode.nullFlavorrequiredNullFlavor
Encounter.priorityCodeextensibleActPriority
Encounter.performer:performer.nullFlavorrequiredNullFlavor
Encounter.performer:performer.typeCoderequiredFixed Value: PRF
Encounter.participant:location.nullFlavorrequiredNullFlavor
Encounter.participant:location.typeCoderequiredFixed Value: LOC
Encounter.participant:location.contextControlCoderequiredFixed Value: OP
Encounter.entryRelationship:priorityPreference.nullFlavorrequiredNullFlavor
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Encounter.entryRelationship:indication.nullFlavorrequiredNullFlavor
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Encounter

Summary

Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Encounter.templateId is sliced based on the values of value:root, value:extension
  • The element Encounter.performer is sliced based on the value of value:Encounter.assignedEntity
  • The element Encounter.participant is sliced based on the values of value:typeCode, value:participantRole
  • The element Encounter.entryRelationship is sliced based on the value of profile:observation

Differential View

This structure is derived from CDAR2.Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter CDAR2.EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1cs
... moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... extension 1..1stRequired Pattern: 2014-06-09
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TS
... Slices for performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
.... performer:performer 0..*Performer2
..... assignedEntity 1..1AssignedEntity
... author 0..*AuthorParticipationThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
... Slices for participant 0..*Participant2This 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..1csFixed Value: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationship
..... typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Encounter.moodCoderequiredPlanned moodCode (Act/Encounter/Procedure)
Encounter.codepreferredEncounter Planned

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1CDAR2.EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1stRequired Pattern: 2014-06-09
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TS
... Slices for performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
.... performer:performer 0..*Performer2
..... assignedEntity 1..1AssignedEntity
... author 0..*AuthorParticipationThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
... Slices for participant 0..*Participant2This 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..1csBinding: ParticipationType (required)
Fixed Value: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation 1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.classCoderequiredFixed Value: ENC
Encounter.moodCoderequiredPlanned moodCode (Act/Encounter/Procedure)
Encounter.codepreferredEncounter Planned
Encounter.statusCoderequiredActStatus
Encounter.participant:location.typeCoderequiredFixed Value: LOC
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1CDAR2.EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: ENC
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... realmCode 0..*CS
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... sdtcDischargeDispositionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1CEBinding: ActPriority (extensible)
... subject 0..1Subject
... specimen 0..*Specimen
... Slices for performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
.... performer:performer 0..*Performer2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... modeCode 0..1CE
..... assignedEntity 1..1AssignedEntity
... author 0..*AuthorParticipationThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
... informant 0..*Informant
... Slices for participant 0..*Participant2This location participation captures where the planned or ordered encounter may take place.
Slice: Unordered, Open by value:typeCode, value:participantRole
.... participant:location 0..*Participant2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: LOC
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.classCoderequiredFixed Value: ENC
Encounter.moodCoderequiredPlanned moodCode (Act/Encounter/Procedure)
Encounter.templateId:primary.nullFlavorrequiredNullFlavor
Encounter.codepreferredEncounter Planned
Encounter.statusCoderequiredActStatus
Encounter.statusCode.nullFlavorrequiredNullFlavor
Encounter.priorityCodeextensibleActPriority
Encounter.performer:performer.nullFlavorrequiredNullFlavor
Encounter.performer:performer.typeCoderequiredFixed Value: PRF
Encounter.participant:location.nullFlavorrequiredNullFlavor
Encounter.participant:location.typeCoderequiredFixed Value: LOC
Encounter.participant:location.contextControlCoderequiredFixed Value: OP
Encounter.entryRelationship:priorityPreference.nullFlavorrequiredNullFlavor
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Encounter.entryRelationship:indication.nullFlavorrequiredNullFlavor
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Encounter

Summary

Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Encounter.templateId is sliced based on the values of value:root, value:extension
  • The element Encounter.performer is sliced based on the value of value:Encounter.assignedEntity
  • The element Encounter.participant is sliced based on the values of value:typeCode, value:participantRole
  • The element Encounter.entryRelationship is sliced based on the value of profile:observation

 

Other representations of profile: CSV, Excel