Australian Base Implementation Guide (AU Base 1.1.1)
This page is part of the Australian Base IG (v1.1.1: AU Base 1.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 Recommendation [FMM Level 1]
This profile defines an immunisation recommendation structure including core localisation concepts for use in an Australian context.
Examples
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-immunizationrecommendation
This profile defines an immunisation recommendation structure including core localisation concepts for use in an Australian context.
This profile builds on ImmunizationRecommendation.
This profile was published on Fri Apr 26 09:10:00 AEST 2019 as a draft by Health Level Seven Australia (Medications WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationRecommendation | 0..* | ImmunizationRecommendation | A patient's immunisation recommendations in an Australian healthcare context | |
  recommendation | 1..* | BackboneElement | ||
  vaccineCode | 0..1 | CodeableConcept | ||
  coding | 0..* | (Slice Definition) | Slice: Unordered, Open by value:system | |
  coding:amtVaccineCode | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (required) | |
 coding:airVaccineCode | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | |
| targetDisease | 0..1 | CodeableConcept | ||
| coding | 0..* | (Slice Definition) | Slice: Unordered, Open by value:system | |
| coding:snomedTargetDisease | 0..1 | Coding | Vaccination Target Disease (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required) | |
| protocol | 0..1 | BackboneElement | ||
 authority | 0..1 | Reference(AU Base Organisation) | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | I | 0..* | ImmunizationRecommendation | A patient's immunisation recommendations 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) Max Binding: All Languages | |
| 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 |
| patient | Σ | 1..1 | Reference(Patient) | Who this profile is for |
| recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
| 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 | Σ | 1..1 | dateTime | Date recommendation created |
| vaccineCode | Σ | 0..1 | CodeableConcept | Vaccine recommendation applies to 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 | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:amtVaccineCode | Σ | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (required) |
| coding:airVaccineCode | Σ | 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 |
| targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: Immunization Recommendation Target Disease 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 | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedTargetDisease | Σ | 0..1 | Coding | Vaccination Target Disease (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| doseNumber | Σ | 0..1 | positiveInt | Recommended dose number |
| forecastStatus | Σ | 1..1 | CodeableConcept | Vaccine administration status Binding: Immunization Recommendation Status Codes (example) |
| dateCriterion | I | 0..* | BackboneElement | Dates governing proposed 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 |
| code | 1..1 | CodeableConcept | Type of date Binding: Immunization Recommendation Date Criterion Codes (example) | |
| value | 1..1 | dateTime | Recommended date | |
| protocol | I | 0..1 | BackboneElement | Protocol used by recommendation |
| 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 sequence | |
| description | 0..1 | string | Protocol details | |
| authority | 0..1 | Reference(AU Base Organisation) | Who is responsible for protocol | |
| series | 0..1 | string | Name of vaccination series | |
| supportingImmunization | 0..* | Reference(Immunization) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(Observation | AllergyIntolerance) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | A patient's immunisation recommendations in an Australian healthcare context | |
| recommendation | 1..* | BackboneElement | ||
| vaccineCode | 0..1 | CodeableConcept | ||
| coding | 0..* | (Slice Definition) | Slice: Unordered, Open by value:system | |
| coding:amtVaccineCode | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (required) | |
| coding:airVaccineCode | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | |
| targetDisease | 0..1 | CodeableConcept | ||
| coding | 0..* | (Slice Definition) | Slice: Unordered, Open by value:system | |
| coding:snomedTargetDisease | 0..1 | Coding | Vaccination Target Disease (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required) | |
| protocol | 0..1 | BackboneElement | ||
| authority | 0..1 | Reference(AU Base Organisation) | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | I | 0..* | ImmunizationRecommendation | A patient's immunisation recommendations 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) Max Binding: All Languages | |
| 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 |
| patient | Σ | 1..1 | Reference(Patient) | Who this profile is for |
| recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
| 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 | Σ | 1..1 | dateTime | Date recommendation created |
| vaccineCode | Σ | 0..1 | CodeableConcept | Vaccine recommendation applies to 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 | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:amtVaccineCode | Σ | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (required) |
| coding:airVaccineCode | Σ | 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 |
| targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: Immunization Recommendation Target Disease 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 | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedTargetDisease | Σ | 0..1 | Coding | Vaccination Target Disease (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| doseNumber | Σ | 0..1 | positiveInt | Recommended dose number |
| forecastStatus | Σ | 1..1 | CodeableConcept | Vaccine administration status Binding: Immunization Recommendation Status Codes (example) |
| dateCriterion | I | 0..* | BackboneElement | Dates governing proposed 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 |
| code | 1..1 | CodeableConcept | Type of date Binding: Immunization Recommendation Date Criterion Codes (example) | |
| value | 1..1 | dateTime | Recommended date | |
| protocol | I | 0..1 | BackboneElement | Protocol used by recommendation |
| 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 sequence | |
| description | 0..1 | string | Protocol details | |
| authority | 0..1 | Reference(AU Base Organisation) | Who is responsible for protocol | |
| series | 0..1 | string | Name of vaccination series | |
| supportingImmunization | 0..* | Reference(Immunization) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(Observation | AllergyIntolerance) | Patient observations supporting recommendation | |
| 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-immunizationrecommendation
none defined
© AU Base 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
