description: 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.
package_name: hl7.cda.us.ccda
derivation: constraint
name: PlannedEncounter
type: http://hl7.org/cda/stds/core/StructureDefinition/Encounter
elements:
  entryRelationship:
    short: The following entryRelationship captures the reason for the planned or ordered encounter
    index: 20
    slicing:
      rules: open
      discriminator:
      - {path: observation, type: profile}
      min: null
      slices:
        priorityPreference:
          match: {}
          schema:
            short: The following entryRelationship represents the priority that a patient or a provider places on the encounter.
            index: 21
            elements:
              typeCode:
                pattern: {type: Code, value: REFR}
                index: 22
              observation: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Observation', index: 23}
            required: [observation]
        indication:
          match: {}
          schema:
            array: true
            index: 24
            elements:
              typeCode:
                pattern: {type: Code, value: RSON}
                index: 25
              observation: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Observation', index: 26}
            required: [observation]
  participant:
    short: This location participation captures where the planned or ordered encounter may take place.
    index: 16
    slicing:
      rules: open
      discriminator:
      - {path: typeCode, type: value}
      min: null
      slices:
        location:
          match: {typeCode: LOC}
          schema:
            array: true
            index: 17
            elements:
              typeCode:
                pattern: {type: Code, value: LOC}
                index: 18
              participantRole: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole', index: 19}
  classCode: {index: 4}
  author: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Author', short: The author in a planned encounter represents the clinician who is requesting or planning the encounter., index: 15}
  id: {index: 6}
  code:
    short: Records the type of encounter ordered or recommended.
    binding: {strength: preferred, valueSet: 'http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.52'}
    index: 7
  moodCode:
    binding: {strength: required, valueSet: 'http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23'}
    index: 5
  effectiveTime: {index: 12}
  templateId:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: root, type: value}
      - {path: extension, type: value}
      min: 1
      slices:
        planned-enc:
          match: {root: 2.16.840.1.113883.10.20.22.4.40, extension: '2014-06-09'}
          schema:
            _required: true
            index: 1
            elements:
              root:
                pattern: {type: String, value: 2.16.840.1.113883.10.20.22.4.40}
                index: 2
              extension:
                pattern: {type: String, value: '2014-06-09'}
                index: 3
            required: [root, extension]
            extensions: {}
  statusCode:
    index: 10
    elements:
      code:
        pattern: {type: Code, value: active}
        index: 11
    required: [code]
  performer:
    short: Performers represent clinicians who are responsible for assessing and treating the patient.
    index: 13
    elements:
      assignedEntity: {index: 14}
  text:
    short: SHOULD reference the portion of section narrative text corresponding to this entry
    index: 8
    elements:
      reference:
        constraint:
          value-starts-octothorpe: {human: 'If reference/@value is present, it SHALL begin with a ''#'' and SHALL point to its corresponding narrative', source: 'http://hl7.org/cda/us/ccda/StructureDefinition/PlannedEncounter', severity: error, expression: value.exists() implies value.startsWith('#')}
        index: 9
package_version: 3.0.0-ballot
class: logical
kind: logical
url: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedEncounter
base: http://hl7.org/cda/stds/core/StructureDefinition/Encounter
version: 3.0.0-ballot
required: [id, statusCode, templateId]