Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Planned Encounter

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedEncounter Version: 3.0.0-ballot
Draft as of 2023-12-21 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 Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C1..1EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-enc 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
... @classCode 1..1cs
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TS
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
.... 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
.... 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.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Encounter.codepreferredEncounterPlanned

Constraints

IdGradePath(s)DetailsRequirements
should-authorwarningEncounterSHOULD contain author
: author.exists()
should-codewarningEncounterSHOULD contain code
: code.exists()
should-effectiveTimewarningEncounterSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningEncounterSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorEncounter.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C1..1EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-enc 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
... @classCode 1..1csBinding: ActClass (2.0.0) (required)
Fixed Value: ENC
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TS
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
.... 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
.... participant:location 0..*Participant2
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: LOC
..... participantRole C1..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 C1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation C1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.classCoderequiredFixed Value: ENC
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Encounter.codepreferredEncounterPlanned
Encounter.statusCoderequiredActStatus
Encounter.participant:location.typeCoderequiredFixed Value: LOC
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorEncounter.participant:location.participantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-addrwarningEncounter.participant:location.participantRoleSHOULD contain addr
: addr.exists()
should-authorwarningEncounterSHOULD contain author
: author.exists()
should-authorwarningEncounter.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-codewarningEncounterSHOULD contain code
: code.exists()
should-effectiveTimewarningEncounterSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningEncounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-telecomwarningEncounter.participant:location.participantRoleSHOULD contain telecom
: telecom.exists()
should-text-ref-valuewarningEncounterSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningEncounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorEncounter.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C1..1EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:planned-enc 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (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
... @classCode 1..1csBinding: ActClass (2.0.0) (required)
Fixed Value: ENC
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... id 1..*II
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 (example)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... 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
.... participant:location 0..*Participant2
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: LOC
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.nullFlavorrequiredCDANullFlavor
Encounter.typeId.nullFlavorrequiredCDANullFlavor
Encounter.templateId:planned-enc.nullFlavorrequiredCDANullFlavor
Encounter.classCoderequiredFixed Value: ENC
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Encounter.codepreferredEncounterPlanned
Encounter.text.nullFlavorrequiredCDANullFlavor
Encounter.text.compressionrequiredCDACompressionAlgorithm
Encounter.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Encounter.text.mediaTypeexampleMediaType
Encounter.text.representationrequiredBinaryDataEncoding
Encounter.statusCoderequiredActStatus
Encounter.statusCode.nullFlavorrequiredCDANullFlavor
Encounter.priorityCodeexampleActPriority
Encounter.performer.nullFlavorrequiredCDANullFlavor
Encounter.performer.typeId.nullFlavorrequiredCDANullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
Encounter.participant:location.nullFlavorrequiredCDANullFlavor
Encounter.participant:location.typeId.nullFlavorrequiredCDANullFlavor
Encounter.participant:location.typeCoderequiredFixed Value: LOC
Encounter.participant:location.contextControlCoderequiredFixed Value: OP
Encounter.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
Encounter.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Encounter.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
Encounter.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorEncounter.participant:location.participantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-addrwarningEncounter.participant:location.participantRoleSHOULD contain addr
: addr.exists()
should-authorwarningEncounterSHOULD contain author
: author.exists()
should-authorwarningEncounter.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-codewarningEncounterSHOULD contain code
: code.exists()
should-effectiveTimewarningEncounterSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningEncounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-telecomwarningEncounter.participant:location.participantRoleSHOULD contain telecom
: telecom.exists()
should-text-ref-valuewarningEncounterSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningEncounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorEncounter.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Encounter

Summary

Mandatory: 7 elements (2 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.participant is sliced based on the value of value:typeCode
  • The element Encounter.entryRelationship is sliced based on the value of profile:observation

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C1..1EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-enc 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
... @classCode 1..1cs
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TS
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
.... 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
.... 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.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Encounter.codepreferredEncounterPlanned

Constraints

IdGradePath(s)DetailsRequirements
should-authorwarningEncounterSHOULD contain author
: author.exists()
should-codewarningEncounterSHOULD contain code
: code.exists()
should-effectiveTimewarningEncounterSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningEncounterSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorEncounter.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C1..1EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-enc 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
... @classCode 1..1csBinding: ActClass (2.0.0) (required)
Fixed Value: ENC
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TS
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
.... 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
.... participant:location 0..*Participant2
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: LOC
..... participantRole C1..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 C1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation C1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.classCoderequiredFixed Value: ENC
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Encounter.codepreferredEncounterPlanned
Encounter.statusCoderequiredActStatus
Encounter.participant:location.typeCoderequiredFixed Value: LOC
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorEncounter.participant:location.participantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-addrwarningEncounter.participant:location.participantRoleSHOULD contain addr
: addr.exists()
should-authorwarningEncounterSHOULD contain author
: author.exists()
should-authorwarningEncounter.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-codewarningEncounterSHOULD contain code
: code.exists()
should-effectiveTimewarningEncounterSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningEncounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-telecomwarningEncounter.participant:location.participantRoleSHOULD contain telecom
: telecom.exists()
should-text-ref-valuewarningEncounterSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningEncounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorEncounter.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C1..1EncounterXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:planned-enc 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (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
... @classCode 1..1csBinding: ActClass (2.0.0) (required)
Fixed Value: ENC
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... id 1..*II
... code 0..1CDRecords the type of encounter ordered or recommended.
Binding: Encounter Planned (preferred)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 (example)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2Performers represent clinicians who are responsible for assessing and treating the patient.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... 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
.... participant:location 0..*Participant2
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: LOC
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.nullFlavorrequiredCDANullFlavor
Encounter.typeId.nullFlavorrequiredCDANullFlavor
Encounter.templateId:planned-enc.nullFlavorrequiredCDANullFlavor
Encounter.classCoderequiredFixed Value: ENC
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Encounter.codepreferredEncounterPlanned
Encounter.text.nullFlavorrequiredCDANullFlavor
Encounter.text.compressionrequiredCDACompressionAlgorithm
Encounter.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Encounter.text.mediaTypeexampleMediaType
Encounter.text.representationrequiredBinaryDataEncoding
Encounter.statusCoderequiredActStatus
Encounter.statusCode.nullFlavorrequiredCDANullFlavor
Encounter.priorityCodeexampleActPriority
Encounter.performer.nullFlavorrequiredCDANullFlavor
Encounter.performer.typeId.nullFlavorrequiredCDANullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
Encounter.participant:location.nullFlavorrequiredCDANullFlavor
Encounter.participant:location.typeId.nullFlavorrequiredCDANullFlavor
Encounter.participant:location.typeCoderequiredFixed Value: LOC
Encounter.participant:location.contextControlCoderequiredFixed Value: OP
Encounter.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
Encounter.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Encounter.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
Encounter.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorEncounter.participant:location.participantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-addrwarningEncounter.participant:location.participantRoleSHOULD contain addr
: addr.exists()
should-authorwarningEncounterSHOULD contain author
: author.exists()
should-authorwarningEncounter.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-codewarningEncounterSHOULD contain code
: code.exists()
should-effectiveTimewarningEncounterSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningEncounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-telecomwarningEncounter.participant:location.participantRoleSHOULD contain telecom
: telecom.exists()
should-text-ref-valuewarningEncounterSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningEncounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorEncounter.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Encounter

Summary

Mandatory: 7 elements (2 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.participant is sliced based on the value of value:typeCode
  • The element Encounter.entryRelationship is sliced based on the value of profile:observation

 

Other representations of profile: CSV, Excel