description: Defines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine.
package_name: ehealthplatform.be.r4.federalprofiles
derivation: constraint
name: BeVaccination
type: Immunization
elements:
  patient:
    type: Reference
    short: The patient that this received vaccination entry refers to
    mustSupport: true
    refers: ['https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient']
    index: 12
  protocolApplied:
    mustSupport: true
    index: 26
    elements:
      doseNumberString: {type: string, short: Whether this is a first vaccination or a reinforcement, mustSupport: true, index: 27}
      doseNumberPositiveInt: {type: positiveInt, short: 'The numeric/sequential number of the dose, when adequate', mustSupport: true, index: 28}
  site: {mustSupport: true, index: 19}
  vaccineCode: {short: 'The vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa', mustSupport: true, index: 11}
  reasonCode: {short: Why vaccination has occurred or not (code or text), mustSupport: true, index: 23}
  statusReason:
    binding: {strength: required, valueSet: 'https://www.ehealth.fgov.be/standards/fhir/ValueSet/be-vs-vaccination-status-reason'}
    mustSupport: true
    index: 10
  route:
    binding: {strength: required, valueSet: 'https://www.ehealth.fgov.be/standards/fhir/ValueSet/be-vs-vaccination-administration-route'}
    mustSupport: true
    index: 20
  recorded: {short: The date/time when the vaccination event has been recorded, mustSupport: true, index: 15}
  extension:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        vaccination-originalorder:
          match: {url: null}
          schema: {type: Extension, url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder', index: 1}
          max: 1
        administeredProduct:
          match: {url: null}
          schema: {type: Extension, url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct', index: 2}
          max: 1
        vaccination-location:
          match: {url: null}
          schema: {type: Extension, url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-location', index: 3}
          max: 1
        vaccination-confirmationStatus:
          match: {url: null}
          schema: {type: Extension, url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus', index: 4}
          max: 1
        recorder:
          match: {url: null}
          schema: {type: Extension, url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder', index: 5}
          max: 1
  status: {short: The status of this vaccination record entry, mustSupport: true, index: 9}
  lotNumber: {mustSupport: true, index: 17}
  identifier:
    short: A unique business identifier for a vaccination entry
    mustSupport: true
    index: 6
    elements:
      system: {mustSupport: true, index: 7}
      value: {mustSupport: true, index: 8}
    required: [value, system]
  occurrenceString: {type: string, mustSupport: true, index: 14}
  reaction: {mustSupport: true, index: 25}
  location: {mustSupport: false, index: 16}
  occurrenceDateTime: {type: dateTime, mustSupport: true, index: 13}
  expirationDate: {mustSupport: true, index: 18}
  performer:
    mustSupport: true
    index: 21
    elements:
      actor:
        type: Reference
        refers: ['https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-organization', 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner', 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerrole']
        index: 22
  reasonReference: {short: Why vaccination has occurred or not (reference to a finding), mustSupport: true, index: 24}
package_version: 1.1.45-beta
extensions:
  vaccination-originalorder: {url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder', max: 1, type: Extension, index: 1}
  administeredProduct: {url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct', max: 1, type: Extension, index: 2}
  vaccination-location: {url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-location', max: 1, type: Extension, index: 3}
  vaccination-confirmationStatus: {url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus', max: 1, type: Extension, index: 4}
  recorder: {url: 'https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder', max: 1, type: Extension, index: 5}
class: profile
kind: resource
url: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-vaccination
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 1.0.0
required: [recorded]