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

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org.au/fhir/StructureDefinition/au-immunization
copyright	Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.
description	This profile sets minimum expectations for an Immunization resource to record, search, and fetch immunisation history associated with a patient. It is based on the [AU Base Immunization](https://hl7.org.au/fhir/6.0.0/StructureDefinition-au-immunization.html) profile and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the Immunization resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.	This profile sets minimum expectations for an Immunization resource to record, search, and fetch immunisation history associated with a patient. It is based on the [AU Base Immunization](http://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-immunization.html) profile and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the Immunization resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.	Values Differ
experimental
fhirVersion	4.0.1
jurisdiction
jurisdiction / jurisdiction[0]	urn:iso:std:iso:3166#AU
kind	resource
name	AUCoreImmunization
publisher	HL7 Australia
purpose
status	active
title	AU Core Immunization
type	Immunization
url	http://hl7.org.au/fhir/core/StructureDefinition/au-core-immunization

Structure

Name	L Flags	L Card.	L Type	L Description & Constraints	R Flags	R Card.	R Type	R Description & Constraints	Comments
Immunization		0..*	AUBaseImmunization	An immunisation statement in an Australian healthcare context		0..*	AUBaseImmunization	An immunisation statement in an Australian healthcare context
Immunization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.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
Immunization.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
Immunization.contained		0..*	Resource	Contained, inline Resources		0..*	Resource	Contained, inline Resources
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url		0..*	Extension	Extension Slice: Unordered, Open by value:url
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier		0..*	Identifier	Business identifier		0..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	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 SHALL:no-error AU Core Requester	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	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 SHALL:no-error AU Core Requester
Immunization.statusReason		0..1	CodeableConcept	Reason not done Binding: ?? (preferred)		0..1	CodeableConcept	Reason not done Binding: ?? (preferred)
Immunization.vaccineCode	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: ?? (example) Additional Bindings Purpose ?? Preferred ?? Preferred Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: ?? (example) Additional Bindings Purpose ?? Preferred ?? Preferred Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Immunization.vaccineCode.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Immunization.vaccineCode.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
Immunization.vaccineCode.Slices for coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.patient	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(AU Core Patient)	Who was immunized Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(AU Core Patient)	Who was immunized Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Immunization.encounter		0..1	Reference(Encounter)	Encounter immunization was part of		0..1	Reference(Encounter)	Encounter immunization was part of
Immunization.occurrence[x]	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	dateTime S This type must be supported. , string	Vaccine administration date Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	dateTime S This type must be supported. , string	Vaccine administration date Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
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
Immunization.primarySource	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	boolean	Indicates context the data was recorded in Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	boolean	Indicates context the data was recorded in Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
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.
Immunization.location		0..1	Reference(Location)	Where immunization occurred		0..1	Reference(Location)	Where immunization occurred
Immunization.manufacturer		0..1	Reference(Organization)	Vaccine manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
Immunization.lotNumber	SO This element has obligations and must be supported.	0..1	string	Vaccine lot number Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester	SO This element has obligations and must be supported.	0..1	string	Vaccine lot number Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Immunization.expirationDate		0..1	date	Vaccine expiration date		0..1	date	Vaccine expiration date
Immunization.site		0..1	CodeableConcept	Body site vaccine was administered Binding: ?? (preferred)		0..1	CodeableConcept	Body site vaccine was administered Binding: ?? (preferred)
Immunization.route		0..1	CodeableConcept	How vaccine entered body Binding: ?? (preferred)		0..1	CodeableConcept	How vaccine entered body Binding: ?? (preferred)
Immunization.doseQuantity		0..1	??	Amount of vaccine administered	C	0..1	??	Amount of vaccine administered
Immunization.Slices for performer	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for performer.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Immunization.Slices for performer.extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
Immunization.Slices for performer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.Slices for performer.function	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: ?? (extensible)	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: ?? (extensible)
Immunization.Slices for performer.actor	Σ This element is included in summaries.	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing	Σ This element is included in summaries.	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
Immunization.note	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Immunization.reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ?? (preferred)		0..*	CodeableConcept	Why immunization occurred Binding: ?? (preferred)
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Immunization.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.
Immunization.education	C	0..*	BackboneElement	Educational material presented to patient	C	0..*	BackboneElement	Educational material presented to patient
Immunization.education.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Immunization.education.extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
Immunization.education.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType		0..1	string	Educational material document identifier		0..1	string	Educational material document identifier
Immunization.education.reference		0..1	uri	Educational material reference pointer		0..1	uri	Educational material reference pointer
Immunization.education.publicationDate		0..1	dateTime	Educational material publication date		0..1	dateTime	Educational material publication date
Immunization.education.presentationDate		0..1	dateTime	Educational material presentation date		0..1	dateTime	Educational material presentation date
Immunization.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.
Immunization.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.
Immunization.reaction		0..*	BackboneElement	Details of a reaction that follows immunization		0..*	BackboneElement	Details of a reaction that follows immunization
Immunization.reaction.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Immunization.reaction.extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
Immunization.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date		0..1	dateTime	When reaction started		0..1	dateTime	When reaction started
Immunization.reaction.detail		0..1	Reference(Observation)	Additional information on reaction		0..1	Reference(Observation)	Additional information on reaction
Immunization.reaction.reported		0..1	boolean	Indicates self-reported reaction		0..1	boolean	Indicates self-reported reaction
Immunization.protocolApplied		0..*	BackboneElement	Protocol followed by the provider		0..*	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Immunization.protocolApplied.extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
Immunization.protocolApplied.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series		0..1	string	Name of vaccine series		0..1	string	Name of vaccine series
Immunization.protocolApplied.authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ?? (preferred)		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ?? (preferred)
Immunization.protocolApplied.doseNumber[x]		1..1	positiveInt, string	Dose number within series		1..1	positiveInt, string	Dose number within series
Immunization.protocolApplied.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