## Profile Comparison between http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization vs http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization

Left: | AU PS Immunization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization)
Right: | AU PS Immunization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization)

### Messages

Error | StructureDefinition.version | Values for version differ: '0.1.0-preview' vs '0.2.0-preview'
Information | StructureDefinition.date | Values for date differ: '2025-03-10T12:43:34+00:00' vs '2025-06-19T06:07:05+10:00'
Error | StructureDefinition.baseDefinition | Values for baseDefinition differ: 'http://hl7.org.au/fhir/StructureDefinition/au-immunization' vs 'http://hl7.org.au/fhir/core/StructureDefinition/au-core-immunization'
Information | StructureDefinition.short | Values for short differ: 'A reference to a code defined by a terminology system' vs 'Code defined by a terminology system'
Information | StructureDefinition.comment | Values for comment differ: 'Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.' vs 'Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.'
Warning | Immunization.vaccineCode.coding | Elements differ in definition for mustSupport: 'true' vs 'false'
Warning | Immunization.vaccineCode.text | Elements differ in definition for mustSupport: 'true' vs 'false'
Warning | Immunization.lotNumber | Elements differ in definition for mustSupport: 'false' vs 'true'

### Metadata

Name | Value | Comments
--- | --- | ---
abstract | false |
baseDefinition | http://hl7.org.au/fhir/StructureDefinition/au-immunization | http://hl7.org.au/fhir/core/StructureDefinition/au-core-immunization | Values Differ
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
date | 2025-03-10T12:43:34+00:00 | 2025-06-19T06:07:05+10:00 | Values Differ
description | This profile sets minimum expectations for an Immunization resource in the context of a patient summary in an Australian context. It is based on the [AU Base Immunisation](http://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-immunization.html) profile, and applies the constraints of [AU Core Immunization](http://hl7.org.au/fhir/core/StructureDefinition/au-core-immunization) and [Immunization (IPS)](http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips). | This profile sets minimum expectations for an Immunization resource in the context of a patient summary in an Australian context. It is based on the [AU Core Immunization](https://build.fhir.org/ig/hl7au/au-fhir-core/StructureDefinition-au-core-immunization.html) profile, and applies the additional requirements from [Immunization (IPS)](http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips). | Values Differ
experimental |  |
fhirVersion | 4.0.1 |
jurisdiction |  |
jurisdiction[0] | urn:iso:std:iso:3166#AU |
kind | resource |
name | AUPSImmunization |
publisher | HL7 Australia |
purpose |  |
status | draft |
title | AU PS Immunization |
type | Immunization |
url | http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization |
version | 0.1.0-preview | 0.2.0-preview | Values Differ

### Structure

Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Immunization |  | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context This profile also complies with the profiles Immunization (IPS) and AU Core Immunization |  | 0..* | AUCoreImmunization | An immunisation statement in an Australian healthcare context This profile also complies with the profile Immunization (IPS) |
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language |  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
|  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
contained |  | 0..* | Resource | Contained, inline Resources |  | 0..* | Resource | Contained, inline Resources |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier |  | 0..* | Identifier | Business identifier |  | 0..* | Identifier | Business identifier |
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization.
Obligations | Actor
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: ?? (preferred) |  | 0..1 | CodeableConcept | Reason not done Binding: ?? (preferred) |
vaccineCode | S Σ | 1..1 | ?? | Vaccine product administered Binding: ?? (example)
Additional Bindings | Purpose
?? | Preferred
?? | Preferred
| SO Σ | 1..1 | ?? | Vaccine product administered Binding: ?? (example)
Additional Bindings | Purpose
?? | Preferred
?? | Preferred
Obligations | Actor
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
Slices for coding | S | 0..* | ?? | A reference to a code defined by a terminology system Slice: Unordered, Open by pattern:$this | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | Elements differ in definition for mustSupport: 'true' vs 'false'
text | S Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | Elements differ in definition for mustSupport: 'true' vs 'false'
patient | S Σ | 1..1 | Reference(AU PS Patient) | Who was immunized | SO Σ | 1..1 | Reference(AU PS Patient) | Who was immunized
Obligations | Actor
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
reference | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 0..1 | string | Text alternative for the resource | Σ | 0..1 | string | Text alternative for the resource |
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of |  | 0..1 | Reference(Encounter) | Encounter immunization was part of |
occurrence[x] | S Σ | 1..1 | dateTime, string | Vaccine administration date | SO Σ | 1..1 | dateTime, string | Vaccine administration date
Obligations | Actor
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record |  | 0..1 | dateTime | When the immunization was first captured in the subject's record |
primarySource | S Σ | 0..1 | boolean | Indicates context the data was recorded in | SO Σ | 0..1 | boolean | Indicates context the data was recorded in
Obligations | Actor
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. |
location |  | 0..1 | Reference(Location) | Where immunization occurred |  | 0..1 | Reference(Location) | Where immunization occurred |
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer |
lotNumber |  | 0..1 | string | Vaccine lot number | SO | 0..1 | string | Vaccine lot number
Obligations | Actor
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
| Elements differ in definition for mustSupport: 'false' vs 'true'
expirationDate |  | 0..1 | date | Vaccine expiration date |  | 0..1 | date | Vaccine expiration date |
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (preferred) |  | 0..1 | ?? | Body site vaccine was administered Binding: ?? (preferred) |
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (preferred) |  | 0..1 | ?? | How vaccine entered body Binding: ?? (preferred) |
doseQuantity |  | 0..1 | ?? | Amount of vaccine administered |  | 0..1 | ?? | Amount of vaccine administered |
Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible) | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible) |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
note | S Σ | 0..* | Annotation | Additional immunization notes | SO Σ | 0..* | Annotation | Additional immunization notes
Obligations | Actor
SHALL:populate-if-known | AU Core Responder | from AU Core Immunization
SHALL:no-error | AU Core Requester | from AU Core Immunization
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (preferred) |  | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (preferred) |
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ?!Σ | 0..1 | boolean | Dose potency |
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. |
education | C | 0..* | BackboneElement | Educational material presented to patient | C | 0..* | BackboneElement | Educational material presented to patient |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
documentType |  | 0..1 | string | Educational material document identifier |  | 0..1 | string | Educational material document identifier |
reference |  | 0..1 | uri | Educational material reference pointer |  | 0..1 | uri | Educational material reference pointer |
publicationDate |  | 0..1 | dateTime | Educational material publication date |  | 0..1 | dateTime | Educational material publication date |
presentationDate |  | 0..1 | dateTime | Educational material presentation date |  | 0..1 | dateTime | Educational material presentation date |
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. |
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. |
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization |  | 0..* | BackboneElement | Details of a reaction that follows immunization |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
date |  | 0..1 | dateTime | When reaction started |  | 0..1 | dateTime | When reaction started |
detail |  | 0..1 | Reference(Observation) | Additional information on reaction |  | 0..1 | Reference(Observation) | Additional information on reaction |
reported |  | 0..1 | boolean | Indicates self-reported reaction |  | 0..1 | boolean | Indicates self-reported reaction |
protocolApplied |  | 0..* | BackboneElement | Protocol followed by the provider |  | 0..* | BackboneElement | Protocol followed by the provider |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
series |  | 0..1 | string | Name of vaccine series |  | 0..1 | string | Name of vaccine series |
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations |
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (preferred) |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (preferred) |
doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series |  | 1..1 | positiveInt, string | Dose number within series |
seriesDoses[x] |  | 0..1 | positiveInt, string | Recommended number of doses for immunity |  | 0..1 | positiveInt, string | Recommended number of doses for immunity |
Documentation for this format