Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0-ballot: CCDA 4.0 Ballot 1) generated with FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 3.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: 4.0.0-ballot
Draft as of 2024-12-20 Computable Name: PlannedEncounter
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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 Template Content

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

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 1..1 Encounter XML 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
Instance 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..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:planned-enc 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... code 0..1 CD Records the type of encounter ordered or recommended.
Binding: Encounter Type . (preferred)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS
... performer 0..* Performer2 Performers represent clinicians who are responsible for assessing and treating the patient.
.... assignedEntity 1..1 AssignedEntity
... author 0..* AuthorParticipation The author in a planned encounter represents the clinician who is requesting or planning the encounter.
... Slices for participant 0..* Participant2 This location participation captures where the planned or ordered encounter may take place.
Slice: Unordered, Open by value:typeCode
.... participant:location 0..* Participant2
..... @typeCode 1..1 cs Fixed Value: LOC
..... participantRole 1..1 ServiceDeliveryLocation
... Slices for entryRelationship 0..* EntryRelationship The following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1 EntryRelationship The following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @typeCode 1..1 cs Fixed Value: REFR
..... observation 1..1 PriorityPreference
.... entryRelationship:indication 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: RSON
..... observation 1..1 Indication
.... entryRelationship:observation 0..* EntryRelationship 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation
..... observation 1..1 InterpreterNeededObservation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Encounter.codepreferredEncounterType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.23

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 C 1..1 Encounter XML 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
Instance 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..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:planned-enc 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... id 1..* II
... code 0..1 CD Records the type of encounter ordered or recommended.
Binding: Encounter Type . (preferred)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: active
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1 IVL_TS
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2 Performers represent clinicians who are responsible for assessing and treating the patient.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... modeCode 0..1 CE
.... assignedEntity 1..1 AssignedEntity
... author 0..* AuthorParticipation The author in a planned encounter represents the clinician who is requesting or planning the encounter.
... informant 0..* Informant
... Slices for participant 0..* Participant2 This location participation captures where the planned or ordered encounter may take place.
Slice: Unordered, Open by value:typeCode
.... participant:location 0..* Participant2
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: LOC
..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1 IVL_TS
..... awarenessCode 0..1 CE
..... participantRole 1..1 ServiceDeliveryLocation
... Slices for entryRelationship 0..* EntryRelationship The following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1 EntryRelationship The following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 PriorityPreference
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:indication 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 Indication
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:observation 0..* EntryRelationship 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 InterpreterNeededObservation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.templateId:planned-enc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Encounter.codepreferredEncounterType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.23
Encounter.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Encounter.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Encounter.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Encounter.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.performer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer
Encounter.participant:location.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant:location.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant:location.typeCoderequiredFixed Value: LOC
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Encounter.participant:location.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Encounter.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Encounter.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Encounter.entryRelationship:observation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:observation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:observation.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEncounter.typeId, Encounter.performer.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:priorityPreference.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:observation.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
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 C 1..1 Encounter XML 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
Instance 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..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:planned-enc 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... id 1..* II
... code 0..1 CD Records the type of encounter ordered or recommended.
Binding: Encounter Type . (preferred)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: active
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1 IVL_TS
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2 Performers represent clinicians who are responsible for assessing and treating the patient.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... modeCode 0..1 CE
.... assignedEntity 1..1 AssignedEntity
... author 0..* AuthorParticipation The author in a planned encounter represents the clinician who is requesting or planning the encounter.
... informant 0..* Informant
... Slices for participant 0..* Participant2 This location participation captures where the planned or ordered encounter may take place.
Slice: Unordered, Open by value:typeCode
.... participant:location 0..* Participant2
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: LOC
..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1 IVL_TS
..... awarenessCode 0..1 CE
..... participantRole 1..1 ServiceDeliveryLocation
... Slices for entryRelationship 0..* EntryRelationship The following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1 EntryRelationship The following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 PriorityPreference
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:indication 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 Indication
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:observation 0..* EntryRelationship 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 InterpreterNeededObservation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.templateId:planned-enc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Encounter.codepreferredEncounterType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.23
Encounter.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Encounter.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Encounter.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Encounter.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.performer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer
Encounter.participant:location.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant:location.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant:location.typeCoderequiredFixed Value: LOC
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Encounter.participant:location.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Encounter.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Encounter.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Encounter.entryRelationship:observation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:observation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:observation.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEncounter.typeId, Encounter.performer.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:priorityPreference.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:observation.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
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('#')

This structure is derived from Encounter

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Encounter.templateId
  • The element 1 is sliced based on the value of Encounter.participant
  • The element 1 is sliced based on the value of Encounter.entryRelationship

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 1..1 Encounter XML 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
Instance 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..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:planned-enc 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... code 0..1 CD Records the type of encounter ordered or recommended.
Binding: Encounter Type . (preferred)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS
... performer 0..* Performer2 Performers represent clinicians who are responsible for assessing and treating the patient.
.... assignedEntity 1..1 AssignedEntity
... author 0..* AuthorParticipation The author in a planned encounter represents the clinician who is requesting or planning the encounter.
... Slices for participant 0..* Participant2 This location participation captures where the planned or ordered encounter may take place.
Slice: Unordered, Open by value:typeCode
.... participant:location 0..* Participant2
..... @typeCode 1..1 cs Fixed Value: LOC
..... participantRole 1..1 ServiceDeliveryLocation
... Slices for entryRelationship 0..* EntryRelationship The following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1 EntryRelationship The following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @typeCode 1..1 cs Fixed Value: REFR
..... observation 1..1 PriorityPreference
.... entryRelationship:indication 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: RSON
..... observation 1..1 Indication
.... entryRelationship:observation 0..* EntryRelationship 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation
..... observation 1..1 InterpreterNeededObservation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Encounter.codepreferredEncounterType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.23

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 C 1..1 Encounter XML 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
Instance 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..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:planned-enc 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... id 1..* II
... code 0..1 CD Records the type of encounter ordered or recommended.
Binding: Encounter Type . (preferred)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: active
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1 IVL_TS
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2 Performers represent clinicians who are responsible for assessing and treating the patient.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... modeCode 0..1 CE
.... assignedEntity 1..1 AssignedEntity
... author 0..* AuthorParticipation The author in a planned encounter represents the clinician who is requesting or planning the encounter.
... informant 0..* Informant
... Slices for participant 0..* Participant2 This location participation captures where the planned or ordered encounter may take place.
Slice: Unordered, Open by value:typeCode
.... participant:location 0..* Participant2
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: LOC
..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1 IVL_TS
..... awarenessCode 0..1 CE
..... participantRole 1..1 ServiceDeliveryLocation
... Slices for entryRelationship 0..* EntryRelationship The following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1 EntryRelationship The following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 PriorityPreference
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:indication 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 Indication
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:observation 0..* EntryRelationship 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 InterpreterNeededObservation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.templateId:planned-enc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Encounter.codepreferredEncounterType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.23
Encounter.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Encounter.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Encounter.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Encounter.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.performer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer
Encounter.participant:location.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant:location.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant:location.typeCoderequiredFixed Value: LOC
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Encounter.participant:location.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Encounter.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Encounter.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Encounter.entryRelationship:observation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:observation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:observation.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEncounter.typeId, Encounter.performer.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:priorityPreference.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:observation.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
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('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 1..1 Encounter XML 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
Instance 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..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:planned-enc 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.40
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs Binding: CDAActClass (required)
Fixed Value: ENC
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... id 1..* II
... code 0..1 CD Records the type of encounter ordered or recommended.
Binding: Encounter Type . (preferred)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: active
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1 IVL_TS
... sdtcDischargeDispositionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: dischargeDispositionCode (urn:hl7-org:sdtc)
... priorityCode 0..1 CE Binding: ActPriority (example)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2 Performers represent clinicians who are responsible for assessing and treating the patient.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... modeCode 0..1 CE
.... assignedEntity 1..1 AssignedEntity
... author 0..* AuthorParticipation The author in a planned encounter represents the clinician who is requesting or planning the encounter.
... informant 0..* Informant
... Slices for participant 0..* Participant2 This location participation captures where the planned or ordered encounter may take place.
Slice: Unordered, Open by value:typeCode
.... participant:location 0..* Participant2
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: LOC
..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1 IVL_TS
..... awarenessCode 0..1 CE
..... participantRole 1..1 ServiceDeliveryLocation
... Slices for entryRelationship 0..* EntryRelationship The following entryRelationship captures the reason for the planned or ordered encounter
Slice: Unordered, Open by profile:observation
.... entryRelationship:priorityPreference 0..1 EntryRelationship The following entryRelationship represents the priority that a patient or a provider places on the encounter.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 PriorityPreference
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:indication 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 Indication
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:observation 0..* EntryRelationship 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 1..1 InterpreterNeededObservation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.templateId:planned-enc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.classCoderequiredFixed Value: ENC
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
Encounter.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Encounter.codepreferredEncounterType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.23
Encounter.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Encounter.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Encounter.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Encounter.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Encounter.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Encounter.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.performer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.performer.typeCoderequiredFixed Value: PRF
http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer
Encounter.participant:location.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant:location.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.participant:location.typeCoderequiredFixed Value: LOC
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Encounter.participant:location.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Encounter.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Encounter.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:indication.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Encounter.entryRelationship:observation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:observation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Encounter.entryRelationship:observation.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEncounter.typeId, Encounter.performer.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:priorityPreference.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:observation.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
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('#')

This structure is derived from Encounter

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Encounter.templateId
  • The element 1 is sliced based on the value of Encounter.participant
  • The element 1 is sliced based on the value of Encounter.entryRelationship

 

Other representations of profile: CSV, Excel