description: This profile defines an immunisation structure including core localisation concepts for use in an Australian context.
package_name: rs/hl7.fhir.au.base
derivation: constraint
name: AUBaseImmunisation
type: Immunization
elements:
  patient: {short: Patient immunised, index: 6}
  explanation:
    short: Explanation for (non)vaccination
    index: 31
    elements:
      reason: {short: Reason vaccine was given, index: 32}
      reasonNotGiven: {short: Reason vaccine not given, index: 33}
  site:
    short: Body site vaccine was administered
    index: 9
    elements:
      coding: {index: 10}
  vaccineCode:
    short: Vaccine product for administration
    index: 0
    elements:
      coding:
        index: 1
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: system, type: value}
          min: null
          slices:
            amtVaccineCode:
              match: {system: 'http://snomed.info/sct'}
              schema:
                short: AMT Vaccine
                index: 2
                elements:
                  system:
                    pattern: {type: uri, value: 'http://snomed.info/sct'}
                    type: uri
                    index: 3
                required: [system]
            airVaccineCode:
              match: {system: 'https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats'}
              schema:
                short: AIR Vaccine
                index: 4
                elements:
                  system:
                    pattern: {type: uri, value: 'https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats'}
                    type: uri
                    index: 5
                required: [system]
  vaccinationProtocol:
    short: Vaccination protocol
    index: 34
    elements:
      targetDisease:
        short: Vaccine disease target
        index: 35
        elements:
          coding:
            index: 36
            slicing:
              rules: open
              discriminator:
              - {path: system, type: value}
              min: null
              slices:
                snomedTargetDisease:
                  match: {system: null}
                  schema: {short: Vaccination Target Disease (SNOMED CT), index: 37}
                  max: 1
                targetDiseaseNoInformation:
                  match: {system: null}
                  schema:
                    short: No Information for Target Disease
                    pattern:
                      type: Coding
                      value: {code: NI, system: 'http://hl7.org/fhir/v3/NullFlavor', display: NoInformation}
                    type: Coding
                    index: 38
                  max: 1
      doseStatus:
        short: Vaccine relation to protocol
        index: 39
        elements:
          coding:
            index: 40
            slicing:
              rules: open
              discriminator:
              - {path: coding, type: value}
              min: null
              slices:
                doseStatusNotAvailable:
                  match: {coding: null}
                  schema:
                    short: Dose Status Not Available
                    pattern:
                      type: Coding
                      value: {code: NAVU, system: 'http://hl7.org/fhir/v3/NullFlavor', display: Not available}
                    type: Coding
                    index: 41
                  max: 1
  route:
    short: Route of vaccination
    index: 11
    elements:
      coding:
        index: 12
        slicing:
          rules: open
          discriminator:
          - {path: system, type: value}
          min: null
          slices:
            snomedRoute:
              match: {system: null}
              schema: {short: Immunisation Route of Administration (SNOMED CT), index: 13}
              max: 1
  primarySource: {short: Optional information source, index: 7}
  practitioner:
    short: Immunisation performer(s)
    index: 14
    elements:
      role: {index: 15}
    slicing:
      rules: open
      discriminator:
      - {path: role.coding, type: value}
      min: null
      slices:
        administeredBy:
          match:
            role:
              coding: {code: AP, system: 'http://hl7.org/fhir/v2/0443', display: Administering Provider}
          schema:
            short: Immunisation Administered By
            index: 16
            elements:
              role:
                short: Administering role
                index: 17
                elements:
                  coding:
                    pattern:
                      type: Coding
                      value: {code: AP, system: 'http://hl7.org/fhir/v2/0443', display: Administering Provider}
                    type: Coding
                    index: 18
                  text:
                    pattern: {type: string, value: Administering Provider}
                    type: string
                    index: 19
                required: [coding, text]
              actor: {short: Administering practitioner, index: 20}
            required: [role]
        approvedBy:
          match:
            role:
              coding: {code: OP, system: 'http://hl7.org/fhir/v2/0443', display: Ordering Provider}
          schema:
            short: Immunisation Approved By
            index: 21
            elements:
              role:
                short: Approver role
                index: 22
                elements:
                  coding:
                    pattern:
                      type: Coding
                      value: {code: OP, system: 'http://hl7.org/fhir/v2/0443', display: Ordering Provider}
                    type: Coding
                    index: 23
                  text:
                    pattern: {type: string, value: Ordering Provider}
                    type: string
                    index: 24
                required: [coding, text]
              actor: {short: Approving practitioner, index: 25}
            required: [role]
        witnessedBy:
          match:
            role:
              coding: {code: WIT, system: 'http://hl7.org.au/fhir/v2/0443', display: Witness}
          schema:
            short: Immunisation Witnessed By
            index: 26
            elements:
              role:
                short: Witnessing Role
                index: 27
                elements:
                  coding:
                    pattern:
                      type: Coding
                      value: {code: WIT, system: 'http://hl7.org.au/fhir/v2/0443', display: Witness}
                    type: Coding
                    index: 28
                  text:
                    pattern: {type: string, value: Witness}
                    type: string
                    index: 29
                required: [coding, text]
              actor: {short: Witnessing practitioner, index: 30}
            required: [role]
  manufacturer: {short: Vaccine product manufacturer, index: 8}
package_version: 1.1.1
class: profile
kind: resource
url: http://hl7.org.au/fhir/StructureDefinition/au-immunization
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 1.1.1