Australian Base Implementation Guide (AU Base 1)

This page is part of the Australian Base IG (v1.0.2: AU Base 1 on STU3) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-immunization

AU Base Immunisation [FMM Level 3]

This profile defines an immunisation structure including core localisation concepts for use in an Australian context.

Examples

Administration of a vaccine - record compliant with Australian Immunisation Register (AIR)

Administration of a vaccine with administering provider and protocol

Non-administration of varicella-zoster live vaccine due to refusal

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-immunization

This profile defines an immunisation structure including core localisation concepts for use in an Australian context.

This profile builds on Immunization.

This profile was published on Fri Feb 16 17:10:30 AEDT 2018 as a active by Health Level Seven Australia (Medications WG).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This profile contains the following variations from Immunization:

  1. vaccineCode
    • coding AMT Vaccine
    • coding AIR Vaccine
  2. patient (Reference as: au-patient)
  3. manufacturer Vaccine product manufacturer (Reference as: au-organisation)
  4. site
  5. route
    • coding Immunisation Route of Administration (SNOMED CT)
  6. practitioner Immunisation performer(s) sliced
    • practitioner Immunisation Administered By
    • practitioner Immunisation Approved By
  7. explanation
    • coding Reason Vaccine Administered (SNOMED CT)
    • coding Coded Reason (SNOMED CT)
  8. vaccinationProtocol
    • coding Vaccination Target Disease (SNOMED CT)
    • coding Dose Status Not Available
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*An immunisation statement in an Australian healthcare context
... vaccineCode 1..1CodeableConceptVaccine product for administration
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (extensible)
.... coding 0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
... patient 1..1Reference(Patient)Patient immunised
... manufacturer 0..1Reference(Organization)Vaccine product manufacturer
... site 0..1CodeableConceptBody site vaccine was administered
.... coding 0..1CodingBinding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
... route 0..1CodeableConceptRoute of vaccination
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingImmunisation Route of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required)
... practitioner BackboneElementImmunisation performer(s)
Slice: Unordered, Open by value:role.coding
... practitioner 0..1BackboneElementImmunisation Administered By
.... role 1..1CodeableConceptAdministering role
..... coding 1..*CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"}
..... text 1..1stringFixed Value: Administering Provider
.... actor 1..1Reference(Practitioner)Administering practitioner
... practitioner 0..1BackboneElementImmunisation Approved By
.... role 1..1CodeableConceptApprover role
..... coding 1..*CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"}
..... text 1..1stringFixed Value: Ordering Provider
.... actor 1..1Reference(Practitioner)Approving practitioner
... explanation 0..1BackboneElementExplanation for (non)vaccination
.... reason 0..*CodeableConceptReason vaccine administered
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..1CodingReason Vaccine Administered (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (required)
.... reasonNotGiven 0..*CodeableConceptReason immunisation did not occur
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..*CodingCoded Reason (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (required)
... vaccinationProtocol 0..*BackboneElementVaccination protocol
.... targetDisease 1..*CodeableConceptVaccine disease target
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..1CodingVaccination Target Disease (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required)
..... coding 0..1CodingNo Information for Target Disease
Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NI","display":"NoInformation"}
.... doseStatus 1..1CodeableConceptVaccine relation to protocol
..... coding CodingSlice: Unordered, Open by value:coding
..... coding 0..1CodingDose Status Not Available
Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU","display":"Not available"}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*An immunisation statement in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error
Binding: Immunization Status Codes (required)
... notGiven ?!Σ1..1booleanFlag for whether immunization was given
... vaccineCode 1..1CodeableConceptVaccine product for administration
Binding: Vaccine Administered Value Set (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (extensible)
.... coding Σ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... patient 1..1Reference(Patient)Patient immunised
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date 0..1dateTimeVaccination administration date
... primarySource 1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(Location)Where vaccination occurred
... manufacturer 0..1Reference(Organization)Vaccine product manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Codes for Immunization Site of Administration (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptRoute of vaccination
Binding: Immunization Route Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingImmunisation Route of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner ΣIBackboneElementImmunisation performer(s)
Slice: Unordered, Open by value:role.coding
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor Σ1..1Reference(Practitioner)Individual who was performing
... practitioner ΣI0..1BackboneElementImmunisation Administered By
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ1..1CodeableConceptAdministering role
Binding: Immunization Role Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Administering Provider
.... actor Σ1..1Reference(Practitioner)Administering practitioner
... practitioner ΣI0..1BackboneElementImmunisation Approved By
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ1..1CodeableConceptApprover role
Binding: Immunization Role Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Ordering Provider
.... actor Σ1..1Reference(Practitioner)Approving practitioner
... note Σ0..*AnnotationVaccination notes
... explanation I0..1BackboneElementExplanation for (non)vaccination
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... reason 0..*CodeableConceptReason vaccine administered
Binding: Immunization Reason Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingReason Vaccine Administered (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (required)
..... text Σ0..1stringPlain text representation of the concept
.... reasonNotGiven 0..*CodeableConceptReason immunisation did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..*CodingCoded Reason (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (required)
..... text Σ0..1stringPlain text representation of the concept
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol I0..*BackboneElementVaccination protocol
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence 0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(Organization)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptVaccine disease target
Binding: Vaccination Protocol Dose Target Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingVaccination Target Disease (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required)
..... coding Σ0..1CodingNo Information for Target Disease

Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NI","display":"NoInformation"}
..... text Σ0..1stringPlain text representation of the concept
.... doseStatus 1..1CodeableConceptVaccine relation to protocol
Binding: Vaccination Protocol Dose Status codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:coding
..... coding Σ0..1CodingDose Status Not Available

Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU","display":"Not available"}
..... text Σ0..1stringPlain text representation of the concept
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

This profile contains the following variations from Immunization:

  1. vaccineCode
    • coding AMT Vaccine
    • coding AIR Vaccine
  2. patient (Reference as: au-patient)
  3. manufacturer Vaccine product manufacturer (Reference as: au-organisation)
  4. site
  5. route
    • coding Immunisation Route of Administration (SNOMED CT)
  6. practitioner Immunisation performer(s) sliced
    • practitioner Immunisation Administered By
    • practitioner Immunisation Approved By
  7. explanation
    • coding Reason Vaccine Administered (SNOMED CT)
    • coding Coded Reason (SNOMED CT)
  8. vaccinationProtocol
    • coding Vaccination Target Disease (SNOMED CT)
    • coding Dose Status Not Available

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*An immunisation statement in an Australian healthcare context
... vaccineCode 1..1CodeableConceptVaccine product for administration
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (extensible)
.... coding 0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
... patient 1..1Reference(Patient)Patient immunised
... manufacturer 0..1Reference(Organization)Vaccine product manufacturer
... site 0..1CodeableConceptBody site vaccine was administered
.... coding 0..1CodingBinding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
... route 0..1CodeableConceptRoute of vaccination
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingImmunisation Route of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required)
... practitioner BackboneElementImmunisation performer(s)
Slice: Unordered, Open by value:role.coding
... practitioner 0..1BackboneElementImmunisation Administered By
.... role 1..1CodeableConceptAdministering role
..... coding 1..*CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"}
..... text 1..1stringFixed Value: Administering Provider
.... actor 1..1Reference(Practitioner)Administering practitioner
... practitioner 0..1BackboneElementImmunisation Approved By
.... role 1..1CodeableConceptApprover role
..... coding 1..*CodingFixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"}
..... text 1..1stringFixed Value: Ordering Provider
.... actor 1..1Reference(Practitioner)Approving practitioner
... explanation 0..1BackboneElementExplanation for (non)vaccination
.... reason 0..*CodeableConceptReason vaccine administered
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..1CodingReason Vaccine Administered (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (required)
.... reasonNotGiven 0..*CodeableConceptReason immunisation did not occur
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..*CodingCoded Reason (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (required)
... vaccinationProtocol 0..*BackboneElementVaccination protocol
.... targetDisease 1..*CodeableConceptVaccine disease target
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..1CodingVaccination Target Disease (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required)
..... coding 0..1CodingNo Information for Target Disease
Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NI","display":"NoInformation"}
.... doseStatus 1..1CodeableConceptVaccine relation to protocol
..... coding CodingSlice: Unordered, Open by value:coding
..... coding 0..1CodingDose Status Not Available
Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU","display":"Not available"}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*An immunisation statement in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error
Binding: Immunization Status Codes (required)
... notGiven ?!Σ1..1booleanFlag for whether immunization was given
... vaccineCode 1..1CodeableConceptVaccine product for administration
Binding: Vaccine Administered Value Set (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingAMT Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (extensible)
.... coding Σ0..1CodingAIR Vaccine
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... patient 1..1Reference(Patient)Patient immunised
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date 0..1dateTimeVaccination administration date
... primarySource 1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(Location)Where vaccination occurred
... manufacturer 0..1Reference(Organization)Vaccine product manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Codes for Immunization Site of Administration (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptRoute of vaccination
Binding: Immunization Route Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingImmunisation Route of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner ΣIBackboneElementImmunisation performer(s)
Slice: Unordered, Open by value:role.coding
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor Σ1..1Reference(Practitioner)Individual who was performing
... practitioner ΣI0..1BackboneElementImmunisation Administered By
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ1..1CodeableConceptAdministering role
Binding: Immunization Role Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Administering Provider
.... actor Σ1..1Reference(Practitioner)Administering practitioner
... practitioner ΣI0..1BackboneElementImmunisation Approved By
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ1..1CodeableConceptApprover role
Binding: Immunization Role Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system

Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Ordering Provider
.... actor Σ1..1Reference(Practitioner)Approving practitioner
... note Σ0..*AnnotationVaccination notes
... explanation I0..1BackboneElementExplanation for (non)vaccination
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... reason 0..*CodeableConceptReason vaccine administered
Binding: Immunization Reason Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingReason Vaccine Administered (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (required)
..... text Σ0..1stringPlain text representation of the concept
.... reasonNotGiven 0..*CodeableConceptReason immunisation did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..*CodingCoded Reason (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (required)
..... text Σ0..1stringPlain text representation of the concept
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol I0..*BackboneElementVaccination protocol
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence 0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(Organization)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptVaccine disease target
Binding: Vaccination Protocol Dose Target Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingVaccination Target Disease (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required)
..... coding Σ0..1CodingNo Information for Target Disease

Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NI","display":"NoInformation"}
..... text Σ0..1stringPlain text representation of the concept
.... doseStatus 1..1CodeableConceptVaccine relation to protocol
Binding: Vaccination Protocol Dose Status codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:coding
..... coding Σ0..1CodingDose Status Not Available

Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU","display":"Not available"}
..... text Σ0..1stringPlain text representation of the concept
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-immunization

none defined