Profile Comparison between http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization vs http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org/fhir/StructureDefinition/Immunization
copyright	Used by permission of HL7 International all rights reserved Creative Commons License		Removed the item 'Used by permission of HL7 International all rights reserved Creative Commons License'
date	2022-08-02	2023-10-17	Values Differ
description	Minimum expectations for an Immunization resource when accessed via a International Patient Access API	The US Core Immunization Profile inherits from the FHIR [Immunization](https://hl7.org/fhir/R4/immunization.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Immunization resource to record, search, and fetch immunization history associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.	Values Differ
experimental	false
fhirVersion	4.0.1
jurisdiction
jurisdiction / jurisdiction[0]	http://unstats.un.org/unsd/methods/m49/m49.htm#001		Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
jurisdiction / jurisdiction[1]		urn:iso:std:iso:3166#US	Added the item 'urn:iso:std:iso:3166#US'
kind	resource
name	IPAImmunization	USCoreImmunizationProfile	Values Differ
publisher	HL7 International / Patient Care	HL7 International / Cross-Group Projects	Values Differ
purpose
status	active
title	IPA-Immunization	US Core Immunization Profile	Values Differ
type	Immunization
url	http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization	http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization	Values Differ
version	1.1.0	10.0.0-ballot	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..*	Immunization	Immunization event information	C	0..*	Immunization	Immunization event information Constraints: us-core-5
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	Example/preferred bindings differ at Immunization.language using binding from IPAImmunization
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.extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
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 Server SHALL:handle Client	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	completed | entered-in-error | not-done Binding: ?? (required)
Immunization.statusReason		0..1	CodeableConcept	Reason not done Binding: ?? (example): The reason why a vaccine was not administered.	S This element must be supported.	0..1	CodeableConcept	Reason not done Binding: ?? (extensible)	Elements differ in definition for mustSupport: 'false' vs 'true'
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): The code for vaccine product administered. Obligations Actor SHALL:populate-if-known Server SHALL:handle Client	S This element must be supported. Σ This element is included in summaries. C	1..1	CodeableConcept	Vaccine Product Type (bind to CVX) Binding: ?? (extensible)
Immunization.patient	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(IPA-Patient)	Who was immunized Obligations Actor SHALL:populate-if-known Server SHALL:handle Client	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(US Core Patient Profile)	Who was immunized
Immunization.encounter		0..1	Reference(Encounter)	Encounter immunization was part of	S This element must be supported.	0..1	Reference(US Core Encounter Profile)	Encounter the immunization was part of	Elements differ in definition for mustSupport: 'false' vs 'true'
Immunization.occurrence[x]	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	dateTime, string	Vaccine administration date Obligations Actor SHALL:populate-if-known Server SHALL:handle Client	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime S This type must be supported. , string	Vaccine administration date
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	Σ This element is included in summaries.	0..1	boolean	Indicates context the data was recorded in	S This element must be supported. Σ This element is included in summaries.	0..1	boolean	Indicates context the data was recorded in	Elements differ in definition for mustSupport: 'false' vs 'true'
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	S This element must be supported.	0..1	Reference(US Core Location Profile)	Where the vaccine was administered	Elements differ in definition for mustSupport: 'false' vs 'true'
Immunization.manufacturer		0..1	Reference(Organization)	Vaccine manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
Immunization.lotNumber		0..1	string	Vaccine lot number	S This element must be supported.	0..1	string	Vaccine lot number	Elements differ in definition for mustSupport: 'false' vs 'true'
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: ?? (example): The site at which the vaccine was administered.		0..1	CodeableConcept	Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered.
Immunization.route		0..1	CodeableConcept	How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered.		0..1	CodeableConcept	How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered.
Immunization.doseQuantity		0..1	??	Amount of vaccine administered	C	0..1	??	Amount of vaccine administered
Immunization.performer	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event	S This element must be supported. Σ This element is included in summaries.	0..*	BackboneElement	Who performed event	Elements differ in definition for mustSupport: 'false' vs 'true'
Immunization.performer.id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Immunization.performer.extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
Immunization.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.performer.function	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event.	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor	Σ This element is included in summaries.	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(US Core Practitioner Profile S This type must be supported. | US Core PractitionerRole Profile | US Core Organization Profile)	Individual or organization who was performing	Elements differ in definition for mustSupport: 'false' vs 'true'
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Additional immunization notes	Σ This element is included in summaries.	0..*	Annotation	Additional immunization notes
Immunization.reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered.		0..*	CodeableConcept	Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered.
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: ?? (example): The vaccine preventable disease the dose is being administered for.		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for.
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