Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Planned Encounter

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.40 Version: 2.1.0-draft1
Active as of 2023-01-16 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 1..1CDAR2.EncounterBase for all types and resources
... classCode 1..1codeRequired Pattern: ENC
... moodCode 1..1codeBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: active
... effectiveTime 0..1IVL_TS
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
... 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..1codeRequired Pattern: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*ElementThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1ElementThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... typeCode 1..1codeRequired Pattern: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*Element
..... typeCode 1..1codeRequired Pattern: 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.EncounterBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: ENC
... moodCode 1..1codeBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... extension 1..1stringRequired 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..1stringRequired Pattern: active
... effectiveTime 0..1IVL_TS
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
... 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..1codeBinding: ParticipationType (required)
Required Pattern: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship C0..*ElementThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:priorityPreference C0..1ElementThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... typeCode 1..1codeRequired Pattern: REFR
..... contextConductionInd 1..1boolean
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication C0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... 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.typeCoderequiredPattern: LOC

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
enc-er-1errorEncounter.entryRelationship, Encounter.entryRelationship:priorityPreference, Encounter.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1CDAR2.EncounterBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: ENC
... moodCode 1..1codeBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... extension 1..1stringRequired 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..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: active
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... dischargeDispositionCode 0..1CEsdtc:dischargeDispositionCode
XML Namespace: urn:hl7-org:sdtc
... priorityCode 0..1CEBinding: ActPriority (extensible)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
... performer 0..*Performer2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CEXML Namespace: 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..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... 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..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: LOC
..... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship C0..*ElementThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:priorityPreference C0..1ElementThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1IndicationBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... 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.subject.typeCoderequiredFixed Value: SBJ
Encounter.subject.contextControlCoderequiredFixed Value: OP
Encounter.subject.awarenessCodeextensibleTargetAwareness
Encounter.performer.nullFlavorrequiredNullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
Encounter.informant.typeCoderequiredFixed Value: INF
Encounter.informant.contextControlCoderequiredFixed Value: OP
Encounter.participant:location.nullFlavorrequiredNullFlavor
Encounter.participant:location.typeCoderequiredPattern: LOC
Encounter.participant:location.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
enc-er-1errorEncounter.entryRelationship, Encounter.entryRelationship:priorityPreference, Encounter.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

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:

  • 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 1..1CDAR2.EncounterBase for all types and resources
... classCode 1..1codeRequired Pattern: ENC
... moodCode 1..1codeBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: active
... effectiveTime 0..1IVL_TS
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
... 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..1codeRequired Pattern: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship 0..*ElementThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1ElementThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... typeCode 1..1codeRequired Pattern: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*Element
..... typeCode 1..1codeRequired Pattern: 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.EncounterBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: ENC
... moodCode 1..1codeBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... extension 1..1stringRequired 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..1stringRequired Pattern: active
... effectiveTime 0..1IVL_TS
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
... 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..1codeBinding: ParticipationType (required)
Required Pattern: LOC
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship C0..*ElementThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:priorityPreference C0..1ElementThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... typeCode 1..1codeRequired Pattern: REFR
..... contextConductionInd 1..1boolean
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication C0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... 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.typeCoderequiredPattern: LOC

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
enc-er-1errorEncounter.entryRelationship, Encounter.entryRelationship:priorityPreference, Encounter.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1CDAR2.EncounterBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: ENC
... moodCode 1..1codeBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.40
..... extension 1..1stringRequired 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..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: active
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... dischargeDispositionCode 0..1CEsdtc:dischargeDispositionCode
XML Namespace: urn:hl7-org:sdtc
... priorityCode 0..1CEBinding: ActPriority (extensible)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
Slice: Unordered, Open by value:Encounter.assignedEntity
... performer 0..*Performer2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CEXML Namespace: 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..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... 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..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: LOC
..... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ServiceDeliveryLocationBase for all types and resources
... Slices for entryRelationship C0..*ElementThe following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:priorityPreference C0..1ElementThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1IndicationBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... 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.subject.typeCoderequiredFixed Value: SBJ
Encounter.subject.contextControlCoderequiredFixed Value: OP
Encounter.subject.awarenessCodeextensibleTargetAwareness
Encounter.performer.nullFlavorrequiredNullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
Encounter.informant.typeCoderequiredFixed Value: INF
Encounter.informant.contextControlCoderequiredFixed Value: OP
Encounter.participant:location.nullFlavorrequiredNullFlavor
Encounter.participant:location.typeCoderequiredPattern: LOC
Encounter.participant:location.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
enc-er-1errorEncounter.entryRelationship, Encounter.entryRelationship:priorityPreference, Encounter.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

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:

  • 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, Schematron