description: This Immunization Resource describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
package_name: NHSDigital.FHIR.STU3
derivation: constraint
name: CareConnect-ITK-DM-Immunization-1
type: Immunization
elements:
  patient:
    type: Reference
    refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1']
    index: 12
  explanation:
    elements:
      reason: {index: 43}
      reasonNotGiven: {index: 44}
  site:
    elements:
      coding:
        index: 18
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: system, type: value}
          min: null
          slices:
            snomedCT:
              match: {system: 'http://snomed.info/sct'}
              schema:
                index: 19
                extensions:
                  snomedCTDescriptionID:
                    url: h
                    type: Extension
                    index: 21
                    elements:
                      url:
                        pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                        index: 22
                elements:
                  extension:
                    index: 20
                    slicing:
                      rules: open
                      discriminator:
                      - {path: url, type: value}
                      min: null
                      slices:
                        snomedCTDescriptionID:
                          match: {url: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                          schema:
                            type: Extension
                            url: h
                            index: 21
                            elements:
                              url:
                                pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                                index: 22
                  system:
                    pattern: {type: Uri, value: 'http://snomed.info/sct'}
                    index: 23
                  version: {index: 24}
                  code: {index: 25}
                  display: {index: 26}
                required: [display, system, code]
  encounter:
    type: Reference
    refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1']
    index: 13
  vaccineCode: {index: 11}
  vaccinationProtocol:
    elements:
      doseSequence: {index: 46}
      authority:
        type: Reference
        refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1']
        index: 47
      targetDisease:
        elements:
          coding:
            index: 48
            slicing:
              rules: open
              ordered: false
              discriminator:
              - {path: system, type: value}
              min: null
              slices:
                snomedCT:
                  match: {system: 'http://snomed.info/sct'}
                  schema:
                    index: 49
                    extensions:
                      snomedCTDescriptionID:
                        url: h
                        type: Extension
                        index: 51
                        elements:
                          url:
                            pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                            index: 52
                    elements:
                      extension:
                        index: 50
                        slicing:
                          rules: open
                          discriminator:
                          - {path: url, type: value}
                          min: null
                          slices:
                            snomedCTDescriptionID:
                              match: {url: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                              schema:
                                type: Extension
                                url: h
                                index: 51
                                elements:
                                  url:
                                    pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                                    index: 52
                      system:
                        pattern: {type: Uri, value: 'http://snomed.info/sct'}
                        index: 53
                      version: {index: 54}
                      code: {index: 55}
                      display: {index: 56}
                    required: [display, system, code]
      doseStatus:
        elements:
          coding:
            elements:
              system: {index: 57}
              code: {index: 58}
              display: {index: 59}
            required: [display, system, code]
    required: [doseSequence]
  route:
    elements:
      coding:
        index: 27
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: system, type: value}
          min: null
          slices:
            snomedCT:
              match: {system: 'http://snomed.info/sct'}
              schema:
                index: 28
                extensions:
                  snomedCTDescriptionID:
                    url: h
                    type: Extension
                    index: 30
                    elements:
                      url:
                        pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                        index: 31
                elements:
                  extension:
                    index: 29
                    slicing:
                      rules: open
                      discriminator:
                      - {path: url, type: value}
                      min: null
                      slices:
                        snomedCTDescriptionID:
                          match: {url: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                          schema:
                            type: Extension
                            url: h
                            index: 30
                            elements:
                              url:
                                pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid'}
                                index: 31
                  system:
                    pattern: {type: Uri, value: 'http://snomed.info/sct'}
                    index: 32
                  version: {index: 33}
                  code: {index: 34}
                  display: {index: 35}
                required: [display, system, code]
  note:
    elements:
      author:
        choices: [authorReference, authorString, authorReference, authorReference]
        index: 38
      authorReference:
        type: Reference
        choiceOf: author
        refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1']
        index: 41
      authorString: {type: string, choiceOf: author, index: 40}
  extension:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        parentPresent:
          match: {url: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1'}
          schema:
            type: Extension
            url: h
            index: 1
            elements:
              url:
                pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1'}
                index: 2
        recordedDate:
          match: {url: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1'}
          schema:
            type: Extension
            short: The date that the Vaccination was recorded
            url: h
            index: 3
            elements:
              url:
                pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1'}
                index: 4
        vaccinationProcedure:
          match: {url: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1'}
          schema:
            type: Extension
            url: h
            index: 5
            elements:
              url:
                pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1'}
                index: 6
  primarySource: {defaultValueBoolean: true, index: 14}
  status: {short: completed, index: 10}
  lotNumber: {mustSupport: true, index: 17}
  identifier:
    elements:
      system: {index: 7}
      value: {index: 8}
      assigner:
        type: Reference
        refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1']
        index: 9
    required: [value, system]
  practitioner:
    elements:
      actor:
        type: Reference
        refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1']
        index: 36
  manufacturer:
    type: Reference
    mustSupport: false
    refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1']
    index: 16
  reaction:
    elements:
      detail:
        type: Reference
        refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1']
        index: 45
  location:
    type: Reference
    refers: ['https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1']
    index: 15
package_version: 1.0.0
extensions:
  parentPresent:
    url: h
    type: Extension
    index: 1
    elements:
      url:
        pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1'}
        index: 2
  recordedDate:
    url: h
    type: Extension
    short: The date that the Vaccination was recorded
    index: 3
    elements:
      url:
        pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1'}
        index: 4
  vaccinationProcedure:
    url: h
    type: Extension
    index: 5
    elements:
      url:
        pattern: {type: Uri, value: 'https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1'}
        index: 6
class: profile
kind: resource
url: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-ITK-DM-Immunization-1
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 1.1.0