This page is part of the Australian Base IG (v0.9.3: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions
AU Base Immunisation [FMM Level 0]
This profile defines an immunisation information structure including core localisation concepts for Australia.
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
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-immunisation
Immunisation record for Australian context
This profile builds on Immunization.
This profile was published on Fri Feb 16 17:10:30 AEDT 2018 as a draft 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:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | An immunisation statement in an Australian healthcare context | ||
vaccineCode | 1..1 | CodeableConcept | Vaccine Administered | |
coding | Coding | Slice: Unordered, Open by value:system | ||
coding | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (required) | |
coding | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | |
patient | 1..1 | Reference(AU Base Patient) | Immunised patient | |
manufacturer | 0..1 | Reference(AU Base Organisation) | Vaccine product manufacturer | |
site | 0..1 | CodeableConcept | ||
coding | 0..1 | Coding | Coded anatomical site Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) | |
route | 0..1 | CodeableConcept | ||
coding | Coding | Slice: Unordered, Open by value:system | ||
coding | 0..1 | Coding | Immunisation Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required) | |
practitioner | BackboneElement | Immunisation performer(s) Slice: Unordered, Open by value:role.coding | ||
practitioner | 0..1 | BackboneElement | Immunisation Administered By | |
role | 1..1 | CodeableConcept | Administering Role | |
coding | 1..* | Coding | Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"} | |
text | 1..1 | string | Fixed Value: Administering Provider | |
actor | 1..1 | Reference(AU Base Practitioner) | Administering practitioner | |
practitioner | 0..1 | BackboneElement | Immunisation Approved By | |
role | 1..1 | CodeableConcept | Approver Role | |
coding | 1..* | Coding | Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"} | |
text | 1..1 | string | Fixed Value: Ordering Provider | |
actor | 1..1 | Reference(AU Base Practitioner) | Approving practitioner | |
explanation | 0..1 | BackboneElement | ||
reasonNotGiven | 0..* | CodeableConcept | Reason immunisation did not occur | |
coding | Coding | Coded reason Slice: Unordered, Open by value:system | ||
coding | 0..* | Coding | Coded reason (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (required) | |
vaccinationProtocol | 0..* | BackboneElement | ||
doseStatus | 1..1 | CodeableConcept | ||
coding | Coding | Slice: Unordered, Open by value:coding | ||
coding | 0..1 | Coding | Dose Status Not Available Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU","display":"Not available"} | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | I | 0..* | An immunisation statement in an Australian healthcare context | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Business identifier | |
status | ?!Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required) |
notGiven | ?!Σ | 1..1 | boolean | Flag for whether immunization was given |
vaccineCode | 1..1 | CodeableConcept | Vaccine Administered Binding: Vaccine Administered Value Set (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding | Σ | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (required) |
coding | Σ | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
patient | 1..1 | Reference(AU Base Patient) | Immunised patient | |
encounter | 0..1 | Reference(Encounter) | Encounter administered as part of | |
date | 0..1 | dateTime | Vaccination administration date | |
primarySource | 1..1 | boolean | Indicates context the data was recorded in | |
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example) | |
location | 0..1 | Reference(Location) | Where vaccination occurred | |
manufacturer | 0..1 | Reference(AU Base Organisation) | Vaccine product manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..1 | Coding | Coded anatomical site Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
route | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding | Σ | 0..1 | Coding | Immunisation Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |
practitioner | ΣI | BackboneElement | Immunisation performer(s) Slice: Unordered, Open by value:role.coding | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
role | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Role Codes (extensible) |
actor | Σ | 1..1 | Reference(Practitioner) | Individual who was performing |
practitioner | ΣI | 0..1 | BackboneElement | Immunisation Administered By |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
role | Σ | 1..1 | CodeableConcept | Administering Role Binding: Immunization Role Codes (extensible) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"} |
text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Administering Provider |
actor | Σ | 1..1 | Reference(AU Base Practitioner) | Administering practitioner |
practitioner | ΣI | 0..1 | BackboneElement | Immunisation Approved By |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
role | Σ | 1..1 | CodeableConcept | Approver Role Binding: Immunization Role Codes (extensible) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"} |
text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Ordering Provider |
actor | Σ | 1..1 | Reference(AU Base Practitioner) | Approving practitioner |
note | Σ | 0..* | Annotation | Vaccination notes |
explanation | I | 0..1 | BackboneElement | Administration/non-administration reasons |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
reason | 0..* | CodeableConcept | Why immunization occurred Binding: Immunization Reason Codes (example) | |
reasonNotGiven | 0..* | CodeableConcept | Reason immunisation did not occur Binding: Immunization Reasons for Not Immunizing Codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Coded reason Slice: Unordered, Open by value:system | |
coding | Σ | 0..* | Coding | Coded reason (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
date | 0..1 | dateTime | When reaction started | |
detail | 0..1 | Reference(Observation) | Additional information on reaction | |
reported | 0..1 | boolean | Indicates self-reported reaction | |
vaccinationProtocol | I | 0..* | BackboneElement | What protocol was followed |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
doseSequence | 0..1 | positiveInt | Dose number within series | |
description | 0..1 | string | Details of vaccine protocol | |
authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
series | 0..1 | string | Name of vaccine series | |
seriesDoses | 0..1 | positiveInt | Recommended number of doses for immunity | |
targetDisease | 1..* | CodeableConcept | Disease immunized against Binding: Vaccination Protocol Dose Target Codes (example) | |
doseStatus | 1..1 | CodeableConcept | Indicates if dose counts towards immunity Binding: Vaccination Protocol Dose Status codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:coding | |
coding | Σ | 0..1 | Coding | Dose Status Not Available Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU","display":"Not available"} |
text | Σ | 0..1 | string | Plain text representation of the concept |
doseStatusReason | 0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example) | |
Documentation for this format |
This profile contains the following variations from Immunization:
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | An immunisation statement in an Australian healthcare context | ||
vaccineCode | 1..1 | CodeableConcept | Vaccine Administered | |
coding | Coding | Slice: Unordered, Open by value:system | ||
coding | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (required) | |
coding | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | |
patient | 1..1 | Reference(AU Base Patient) | Immunised patient | |
manufacturer | 0..1 | Reference(AU Base Organisation) | Vaccine product manufacturer | |
site | 0..1 | CodeableConcept | ||
coding | 0..1 | Coding | Coded anatomical site Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) | |
route | 0..1 | CodeableConcept | ||
coding | Coding | Slice: Unordered, Open by value:system | ||
coding | 0..1 | Coding | Immunisation Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required) | |
practitioner | BackboneElement | Immunisation performer(s) Slice: Unordered, Open by value:role.coding | ||
practitioner | 0..1 | BackboneElement | Immunisation Administered By | |
role | 1..1 | CodeableConcept | Administering Role | |
coding | 1..* | Coding | Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"} | |
text | 1..1 | string | Fixed Value: Administering Provider | |
actor | 1..1 | Reference(AU Base Practitioner) | Administering practitioner | |
practitioner | 0..1 | BackboneElement | Immunisation Approved By | |
role | 1..1 | CodeableConcept | Approver Role | |
coding | 1..* | Coding | Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"} | |
text | 1..1 | string | Fixed Value: Ordering Provider | |
actor | 1..1 | Reference(AU Base Practitioner) | Approving practitioner | |
explanation | 0..1 | BackboneElement | ||
reasonNotGiven | 0..* | CodeableConcept | Reason immunisation did not occur | |
coding | Coding | Coded reason Slice: Unordered, Open by value:system | ||
coding | 0..* | Coding | Coded reason (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (required) | |
vaccinationProtocol | 0..* | BackboneElement | ||
doseStatus | 1..1 | CodeableConcept | ||
coding | Coding | Slice: Unordered, Open by value:coding | ||
coding | 0..1 | Coding | Dose Status Not Available Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU","display":"Not available"} | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | I | 0..* | An immunisation statement in an Australian healthcare context | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Business identifier | |
status | ?!Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required) |
notGiven | ?!Σ | 1..1 | boolean | Flag for whether immunization was given |
vaccineCode | 1..1 | CodeableConcept | Vaccine Administered Binding: Vaccine Administered Value Set (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding | Σ | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (required) |
coding | Σ | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
patient | 1..1 | Reference(AU Base Patient) | Immunised patient | |
encounter | 0..1 | Reference(Encounter) | Encounter administered as part of | |
date | 0..1 | dateTime | Vaccination administration date | |
primarySource | 1..1 | boolean | Indicates context the data was recorded in | |
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example) | |
location | 0..1 | Reference(Location) | Where vaccination occurred | |
manufacturer | 0..1 | Reference(AU Base Organisation) | Vaccine product manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..1 | Coding | Coded anatomical site Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
route | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding | Σ | 0..1 | Coding | Immunisation Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |
practitioner | ΣI | BackboneElement | Immunisation performer(s) Slice: Unordered, Open by value:role.coding | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
role | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Role Codes (extensible) |
actor | Σ | 1..1 | Reference(Practitioner) | Individual who was performing |
practitioner | ΣI | 0..1 | BackboneElement | Immunisation Administered By |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
role | Σ | 1..1 | CodeableConcept | Administering Role Binding: Immunization Role Codes (extensible) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"AP","display":"Administering Provider"} |
text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Administering Provider |
actor | Σ | 1..1 | Reference(AU Base Practitioner) | Administering practitioner |
practitioner | ΣI | 0..1 | BackboneElement | Immunisation Approved By |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
role | Σ | 1..1 | CodeableConcept | Approver Role Binding: Immunization Role Codes (extensible) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..* | Coding | Code defined by a terminology system Fixed Value: {"system":"http://hl7.org/fhir/v2/0443","code":"OP","display":"Ordering Provider"} |
text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Ordering Provider |
actor | Σ | 1..1 | Reference(AU Base Practitioner) | Approving practitioner |
note | Σ | 0..* | Annotation | Vaccination notes |
explanation | I | 0..1 | BackboneElement | Administration/non-administration reasons |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
reason | 0..* | CodeableConcept | Why immunization occurred Binding: Immunization Reason Codes (example) | |
reasonNotGiven | 0..* | CodeableConcept | Reason immunisation did not occur Binding: Immunization Reasons for Not Immunizing Codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Coded reason Slice: Unordered, Open by value:system | |
coding | Σ | 0..* | Coding | Coded reason (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
date | 0..1 | dateTime | When reaction started | |
detail | 0..1 | Reference(Observation) | Additional information on reaction | |
reported | 0..1 | boolean | Indicates self-reported reaction | |
vaccinationProtocol | I | 0..* | BackboneElement | What protocol was followed |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
doseSequence | 0..1 | positiveInt | Dose number within series | |
description | 0..1 | string | Details of vaccine protocol | |
authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
series | 0..1 | string | Name of vaccine series | |
seriesDoses | 0..1 | positiveInt | Recommended number of doses for immunity | |
targetDisease | 1..* | CodeableConcept | Disease immunized against Binding: Vaccination Protocol Dose Target Codes (example) | |
doseStatus | 1..1 | CodeableConcept | Indicates if dose counts towards immunity Binding: Vaccination Protocol Dose Status codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:coding | |
coding | Σ | 0..1 | Coding | Dose Status Not Available Fixed Value: {"system":"http://hl7.org/fhir/v3/NullFlavor","code":"NAVU","display":"Not available"} |
text | Σ | 0..1 | string | Plain text representation of the concept |
doseStatusReason | 0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example) | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-immunisation
none defined