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

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: Planned Encounter

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedEncounter Version: 4.0.0
Draft as of 2025-10-02 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.

Templates Used

Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:

Optional EntryRelationships: Indication, InterpreterNeededObservation, PriorityPreference

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 3.0.0:

  • New Content

    • Formal Views of Template Content

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

    This structure is derived from Encounter

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Encounter C 1..1 Encounter XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-code, should-effectiveTime, should-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 Constraints: value-starts-octothorpe
    ... 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)

    Path Status Usage ValueSet Version Source
    Encounter.moodCode Base required Planned moodCode (Act/Encounter/Procedure) . 📦20240606 VSAC v0.23
    Encounter.code Base preferred Encounter Type . 📦20250510 VSAC v0.23

    Constraints

    Id Grade Path(s) Description Expression
    should-author warning Encounter SHOULD contain author author.exists()
    should-code warning Encounter SHOULD contain code code.exists()
    should-effectiveTime warning Encounter SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Encounter SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Encounter.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Encounter C 1..1 Encounter XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-code, should-effectiveTime, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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 Constraints: value-starts-octothorpe
    .... 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 Constraints: II-1
    ..... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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

    Path Status Usage ValueSet Version Source
    Encounter.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.templateId:planned-enc.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.classCode Base required CDAActClass 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.moodCode Base required Planned moodCode (Act/Encounter/Procedure) . 📦20240606 VSAC v0.23
    Encounter.code Base preferred Encounter Type . 📦20250510 VSAC v0.23
    Encounter.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Encounter.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Encounter.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Encounter.statusCode.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Encounter.performer.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.performer.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.performer.​typeCode Base required ParticipationPhysicalPerformer 📦3.0.0 THO v6.5
    Encounter.participant:location.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    Encounter.entryRelationship:indication.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:indication.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:indication.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    Encounter.entryRelationship:observation.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:observation.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:observation.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Encounter.typeId, Encounter.performer.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:priorityPreference.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:observation.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Encounter SHOULD contain author author.exists()
    should-code warning Encounter SHOULD contain code code.exists()
    should-effectiveTime warning Encounter SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Encounter SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Encounter.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Encounter C 1..1 Encounter XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-code, should-effectiveTime, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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 Constraints: value-starts-octothorpe
    .... 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 Constraints: II-1
    ..... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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

    Path Status Usage ValueSet Version Source
    Encounter.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.templateId:planned-enc.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.classCode Base required CDAActClass 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.moodCode Base required Planned moodCode (Act/Encounter/Procedure) . 📦20240606 VSAC v0.23
    Encounter.code Base preferred Encounter Type . 📦20250510 VSAC v0.23
    Encounter.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Encounter.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Encounter.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Encounter.statusCode.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Encounter.performer.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.performer.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.performer.​typeCode Base required ParticipationPhysicalPerformer 📦3.0.0 THO v6.5
    Encounter.participant:location.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    Encounter.entryRelationship:indication.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:indication.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:indication.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    Encounter.entryRelationship:observation.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:observation.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:observation.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Encounter.typeId, Encounter.performer.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:priorityPreference.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:observation.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Encounter SHOULD contain author author.exists()
    should-code warning Encounter SHOULD contain code code.exists()
    should-effectiveTime warning Encounter SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Encounter SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Encounter.text.reference If 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 & Constraints    Filter: Filtersdoco
    .. Encounter C 1..1 Encounter XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-code, should-effectiveTime, should-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 Constraints: value-starts-octothorpe
    ... 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)

    Path Status Usage ValueSet Version Source
    Encounter.moodCode Base required Planned moodCode (Act/Encounter/Procedure) . 📦20240606 VSAC v0.23
    Encounter.code Base preferred Encounter Type . 📦20250510 VSAC v0.23

    Constraints

    Id Grade Path(s) Description Expression
    should-author warning Encounter SHOULD contain author author.exists()
    should-code warning Encounter SHOULD contain code code.exists()
    should-effectiveTime warning Encounter SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Encounter SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Encounter.text.reference If 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 & Constraints    Filter: Filtersdoco
    .. Encounter C 1..1 Encounter XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-code, should-effectiveTime, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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 Constraints: value-starts-octothorpe
    .... 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 Constraints: II-1
    ..... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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

    Path Status Usage ValueSet Version Source
    Encounter.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.templateId:planned-enc.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.classCode Base required CDAActClass 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.moodCode Base required Planned moodCode (Act/Encounter/Procedure) . 📦20240606 VSAC v0.23
    Encounter.code Base preferred Encounter Type . 📦20250510 VSAC v0.23
    Encounter.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Encounter.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Encounter.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Encounter.statusCode.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Encounter.performer.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.performer.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.performer.​typeCode Base required ParticipationPhysicalPerformer 📦3.0.0 THO v6.5
    Encounter.participant:location.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    Encounter.entryRelationship:indication.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:indication.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:indication.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    Encounter.entryRelationship:observation.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:observation.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:observation.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Encounter.typeId, Encounter.performer.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:priorityPreference.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:observation.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Encounter SHOULD contain author author.exists()
    should-code warning Encounter SHOULD contain code code.exists()
    should-effectiveTime warning Encounter SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Encounter SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Encounter.text.reference If 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 & Constraints    Filter: Filtersdoco
    .. Encounter C 1..1 Encounter XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-code, should-effectiveTime, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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 Constraints: value-starts-octothorpe
    .... 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 Constraints: II-1
    ..... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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 Constraints: II-1
    ...... @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

    Path Status Usage ValueSet Version Source
    Encounter.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.templateId:planned-enc.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.classCode Base required CDAActClass 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.moodCode Base required Planned moodCode (Act/Encounter/Procedure) . 📦20240606 VSAC v0.23
    Encounter.code Base preferred Encounter Type . 📦20250510 VSAC v0.23
    Encounter.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Encounter.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Encounter.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Encounter.statusCode.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Encounter.performer.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.performer.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.performer.​typeCode Base required ParticipationPhysicalPerformer 📦3.0.0 THO v6.5
    Encounter.participant:location.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.participant:location.​contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:priorityPreference.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    Encounter.entryRelationship:indication.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:indication.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:indication.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    Encounter.entryRelationship:observation.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:observation.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Encounter.entryRelationship:observation.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Encounter.typeId, Encounter.performer.typeId, Encounter.participant:location.typeId, Encounter.entryRelationship:priorityPreference.typeId, Encounter.entryRelationship:indication.typeId, Encounter.entryRelationship:observation.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Encounter SHOULD contain author author.exists()
    should-code warning Encounter SHOULD contain code code.exists()
    should-effectiveTime warning Encounter SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Encounter SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Encounter.text.reference If 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