Profile Comparison between http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips vs http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org/fhir/StructureDefinition/Immunization
copyright
date	2020-05-19T18:37:29+00:00	2022-11-22T03:32:52+00:00	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.
experimental
fhirVersion	4.0.1
jurisdiction
jurisdiction[0]	http://unstats.un.org/unsd/methods/m49/m49.htm#001
kind	resource
name	ImmunizationUvIps
publisher	Health Level Seven International - Patient Care Work Group
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.
status	active
title	Immunization (IPS)
type	Immunization
url	http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips
version	1.0.0	1.1.0	Values Differ

Structure

Name	L Flags	L Card.	L Type	L Description & Constraints	R Flags	R Card.	L Type	L Description & Constraints	Comments
Immunization	S	0..*	Immunization	Immunization event information		0..*	Immunization	Immunization event information	Elements differ in definition for mustSupport: 'true' vs 'false'
id	Σ	0..1	string	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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation		0..1	Narrative	Text summary of the resource, for human interpretation
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	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Slices for vaccineCode	SΣ	1..1	?pkp-2?	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. Slice: Unordered, Open by pattern:$this Binding: VaccinesUvIps (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.	S	1..1	CodeableConceptIPS	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: Vaccines - IPS (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 Vaccines - SNOMED CT IPS Free Set Candidate Validation Binding For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS Candidate Validation Binding For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS Candidate Validation Binding "known absent" and "not known", for use with other value sets	Elements differ in definition: '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 immunized is provided; or the known absent / unknown. Other coded information can be provided as well as: 1. The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept. 2. The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept. 3. The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept. 4. The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept. 5. The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. 6. The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. 7. Any other kind of code that that identifies, classifies or clusters the administered product (e.g. the medicinal product or the product class). The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.' vs '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 immunized is provided; or the known absent / unknown. Other coded information can be provided as well as: - The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept. - The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. - The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. - Any other kind of code that that identifies, classifies or clusters the administered product (e.g. the medicinal product or the product class). The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.' Elements differ in binding.description: 'The type of vaccine for particular disease or diseases against which the patient has been immunised.' vs 'The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.'
patient	SΣ	1..1	Reference(Patient (IPS))	Who was immunized	SΣ	1..1	Reference(Patient (IPS))	Who was immunized
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: ResourceType (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: ResourceType (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	SΣ	1..1	dateTime, string	Vaccine administration date
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
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	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (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: ImmunizationOriginCodes (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		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date		0..1	date	Vaccine expiration date
site	S	0..1	?pkp-2?	Concept - reference to a terminology or just text Binding: TargetSiteCodeUvIps (preferred)		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)	Elements differ in definition for mustSupport: 'true' vs 'false' Example/preferred bindings differ at Immunization.site using binding from ImmunizationUvIps
route	S	0..1	?pkp-2?	Concept - reference to a terminology or just text Binding: RouteOfAdminUvIps (preferred)		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)	Elements differ in definition for mustSupport: 'true' vs 'false'
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered		0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	BackboneElement	Who performed event	Σ	0..*	BackboneElement	Who performed event	Elements differ in definition for mustSupport: 'true' vs 'false' Element maximum cardinalities differ: '1' vs '2147483647'
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: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing	Elements differ in definition for mustSupport: 'true' vs 'false'
note	Σ	0..*	Annotation	Additional immunization notes	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (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: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present	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: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (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
Slices for targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Slice: Unordered, Open by pattern:$this Binding: TargetDiseasesUvIps (preferred)		0..*	CodeableConcept	Vaccine preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set Candidate Validation Binding	Elements differ in short: 'Vaccine preventatable disease being targetted' vs 'Vaccine preventable disease being targeted' Elements differ in definition: 'The vaccine preventable disease the dose is being administered against.' vs 'The particular disease against which the patient has been immunized. Additional conformance bindings provided for use for this element in specific (jurisdictional or other) contexts include (these bindings are represented in the StructureDefinition as instances of the [elementdefinition-additionalBinding] extension): - [targetDiseases-uv-ips]' 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