Profile Comparison between http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips 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	Added the item 'Used by permission of HL7 International, all rights reserved Creative Commons License'
date	2024-06-19T10:50:07-05:00	2023-10-17	Values Differ
description	This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.	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	Added the item 'false'
fhirVersion	4.0.1
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[1]		urn:iso:std:iso:3166#US	Added the item 'urn:iso:std:iso:3166#US'
kind	resource
name	ImmunizationUvIps	USCoreImmunizationProfile	Values Differ
publisher	HL7 International / Patient Care	HL7 International / Cross-Group Projects	Values Differ
purpose	This profile constrains the representation of a record of a vaccination of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.		Removed the item 'This profile constrains the representation of a record of a vaccination of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.'
status	active
title	Immunization (IPS)	US Core Immunization Profile	Values Differ
type	Immunization
url	http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips	http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization	Values Differ
version	2.0.0	9.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
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
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
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	?!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 Creator (IPS) SHALL:handle Consumer (IPS) SHOULD:display Consumer (IPS)	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ?? (required)
statusReason		0..1	CodeableConcept	Reason not done Binding: ?? (example): The reason why a vaccine was not administered.	S	0..1	CodeableConcept	Reason not done Binding: ?? (example)	Elements differ in definition for mustSupport: 'false' vs 'true'
vaccineCode	SOΣ	1..1	??	Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: ?? (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation ?? candidate For when WHO ATC code system is preferred Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS) SHOULD:display Consumer (IPS)	SΣC	1..1	CodeableConcept	Vaccine Product Type (bind to CVX) Binding: ?? (extensible)
patient	SOΣ	1..1	Reference(Patient (IPS))	Who was immunized Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS) SHOULD:display Consumer (IPS)	SΣ	1..1	Reference(US Core Patient Profile)	Who was immunized
id		0..1	string	Unique id for inter-element referencing					Removed this element
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url					Removed this element
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS)					Removed this element
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).					Removed this element
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known					Removed this element
display	Σ	0..1	string	Text alternative for the resource					Removed this element
encounter		0..1	Reference(Encounter)	Encounter immunization was part of	S	0..1	Reference(US Core Encounter Profile)	Encounter the immunization was part of	Elements differ in definition for mustSupport: 'false' vs 'true'
Slices for occurrence[x]	SOΣ	1..1	dateTime, string	Vaccine administration date Slice: Unordered, Open by type:$this Obligations Actor SHALL:populate-if-known Creator (IPS) SHALL:handle Consumer (IPS) SHOULD:display Consumer (IPS)	SΣ	1..1	dateTime S, string	Vaccine administration date
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	Σ	0..1	boolean	Indicates context the data was recorded in	SΣ	0..1	boolean	Indicates context the data was recorded in	Elements differ in definition for mustSupport: 'false' vs 'true'
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	S	0..1	Reference(US Core Location Profile)	Where the vaccine was administered	Elements differ in definition for mustSupport: 'false' vs 'true'
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number	S	0..1	string	Vaccine lot number	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	CodeableConcept	Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered.	Example/preferred bindings differ at Immunization.site using binding from ImmunizationUvIps
route		0..1	CodeableConcept	How vaccine entered body Binding: ?? (preferred): SNOMED Route Terms Additional Bindings Purpose ?? candidate		0..1	CodeableConcept	How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered.	Example/preferred bindings differ at Immunization.route using binding from ImmunizationUvIps
doseQuantity		0..1	??	Amount of vaccine administered		0..1	??	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event	SΣ	0..*	BackboneElement	Who performed event	Elements differ in definition for mustSupport: 'false' vs 'true'
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): The role a practitioner or organization plays in the immunization event.	Σ	0..1	CodeableConcept	What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing	SΣ	1..1	Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core Organization Profile)	Individual or organization who was performing	Elements differ in definition for mustSupport: 'false' vs 'true'
note	Σ	0..*	Annotation	Additional immunization notes	Σ	0..*	Annotation	Additional immunization notes
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.
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 preventable disease being targeted Binding: ?? (preferred): The particular disease or diseases against which the patient has been immunized.		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for.	Example/preferred bindings differ at Immunization.protocolApplied.targetDisease using binding from ImmunizationUvIps
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