## Profile Comparison between http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization vs http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-immunization

Left: | US Core Immunization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization)
Right: | De-Identified UDS Plus Immunization (http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-immunization)

### Messages

Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization' vs 'http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-immunization'
Error | StructureDefinition.version | Values for version differ: '9.0.0-ballot' vs '0.1.0'
Information | StructureDefinition.name | Values for name differ: 'USCoreImmunizationProfile' vs 'UDSPlusImmunization'
Information | StructureDefinition.title | Values for title differ: 'US Core Immunization Profile' vs 'De-Identified UDS Plus Immunization'
Information | StructureDefinition.date | Values for date differ: '2023-10-17' vs '2026-03-16T10:54:28+00:00'
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Cross-Group Projects' vs 'HL7 International / Cross Group Projects'
Information | StructureDefinition.short | Values for short differ: 'Immunization event information' vs 'De-Identified UDS Plus Immunization'
Information | StructureDefinition.definition | Values for definition differ: 'Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.' vs 'The UDS+ profile is based on the Immunization resource and establishes the core elements, extensions, vocabularies and value sets for representing Immunizations for UDS+ program.'
Information | StructureDefinition.short | Values for short differ: 'Logical id of this artifact' vs 'The de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver'
Information | StructureDefinition.definition | Values for definition differ: 'The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.' vs 'De-dentified immunization resource identifier.'
Warning | Immunization.id | Elements differ in definition for mustSupport: 'false' vs 'true'
Information | StructureDefinition.short | Values for short differ: 'Text summary of the resource, for human interpretation' vs 'Cannot include any text in the resource as part of the de-identified data.'
Information | Immunization.text | Element maximum cardinalities differ: '1' vs '0'
Information | StructureDefinition.short | Values for short differ: 'Contained, inline Resources' vs 'Cannot include any contained resources in the resource as part of the de-identified data.'
Information | Immunization.contained | Element maximum cardinalities differ: '2147483647' vs '0'
Information | StructureDefinition.short | Values for short differ: 'Vaccine Product Type (bind to CVX)' vs 'Vaccine product administered'
Information | StructureDefinition.short | Values for short differ: 'Encounter the immunization was part of' vs 'Encounter immunization was part of'
Warning | Immunization.encounter | Elements differ in definition for mustSupport: 'true' vs 'false'
Warning | Immunization.recorded | Elements differ in definition for mustSupport: 'false' vs 'true'
Information | StructureDefinition.definition | Values for definition differ: 'Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.' vs 'An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.'
Information | StructureDefinition.comment | Values for comment differ: 'This updated definition is adopted from the FHIR R5 Immunization resource.' vs 'Reflects the “reliability” of the content.'
Information | Immunization.primarySource | Element minimum cardinalities differ: '0' vs '1'
Information | StructureDefinition.short | Values for short differ: 'Where the vaccine was administered' vs 'Where immunization occurred'
Warning | Immunization.location | Elements differ in definition for mustSupport: 'true' vs 'false'
Warning | Immunization.lotNumber | Elements differ in definition for mustSupport: 'true' vs 'false'
Warning | Immunization.performer | Elements differ in definition for mustSupport: 'true' vs 'false'
Warning | Immunization.performer.actor | Elements differ in definition for mustSupport: 'true' vs 'false'

### 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 | 2023-10-17 | 2026-03-16T10:54:28+00:00 | Values Differ
description | 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. | The UDS+ profile is based on the Immunization resource and establishes the core elements, extensions, vocabularies and value sets for representing immunizations for UDS+ program. | Values Differ
experimental | false |
fhirVersion | 4.0.1 |
jurisdiction |  |
jurisdiction[0] | urn:iso:std:iso:3166#US |
kind | resource |
name | USCoreImmunizationProfile | UDSPlusImmunization | Values Differ
publisher | HL7 International / Cross-Group Projects | HL7 International / Cross Group Projects | Values Differ
purpose |  |
status | active |
title | US Core Immunization Profile | De-Identified UDS Plus Immunization | Values Differ
type | Immunization |
url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-immunization | Values Differ
version | 9.0.0-ballot | 0.1.0 | Values Differ

### Structure

Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Immunization | C | 0..* | Immunization | Immunization event information Constraints: us-core-5 |  | 0..* | Immunization | De-Identified UDS Plus Immunization |
id | Σ | 0..1 | id | Logical id of this artifact | S Σ | 0..1 | id | The de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver | Elements differ in definition for mustSupport: 'false' vs 'true'
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..0 |  | Cannot include any text in the resource as part of the de-identified data. This profile does not constrain the narrative in regard to content, language, or traceability to data elements | Element maximum cardinalities differ: '1' vs '0'
contained |  | 0..* | Resource | Contained, inline Resources |  | 0..0 |  | Cannot include any contained resources in the resource as part of the de-identified data. | Element maximum cardinalities differ: '2147483647' vs '0'
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: ?? (required) | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. |
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ?? (example) | S | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. |
vaccineCode | S Σ C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: ?? (extensible) | S Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: ?? (example): The code for vaccine product administered. |
patient | S Σ | 1..1 | Reference(US Core Patient Profile) | Who was immunized | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | Who was immunized |
encounter | S | 0..1 | Reference(US Core Encounter Profile) | Encounter the immunization was part of |  | 0..1 | Reference(Encounter) | Encounter immunization was part of | Elements differ in definition for mustSupport: 'true' vs 'false'
occurrence[x] | S Σ | 1..1 | dateTime S, string | Vaccine administration date | S Σ | 1..1 | dateTime | Vaccine administration date |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record | S | 0..1 | dateTime | When the immunization was first captured in the subject's record | Elements differ in definition for mustSupport: 'false' vs 'true'
primarySource | S Σ | 0..1 | boolean | Indicates context the data was recorded in | S Σ | 1..1 | boolean | Indicates context the data was recorded in | Element minimum cardinalities differ: '0' vs '1'
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 | S | 0..1 | Reference(US Core Location Profile) | Where the vaccine was administered |  | 0..1 | Reference(Location) | Where immunization occurred | Elements differ in definition for mustSupport: 'true' vs 'false'
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer |
lotNumber | S | 0..1 | string | Vaccine lot number |  | 0..1 | string | Vaccine lot number | Elements differ in definition for mustSupport: 'true' vs 'false'
expirationDate |  | 0..1 | date | Vaccine expiration date |  | 0..1 | date | Vaccine expiration date |
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. |
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. |
doseQuantity |  | 0..1 | ?? | Amount of vaccine administered |  | 0..1 | ?? | Amount of vaccine administered |
performer | S Σ | 0..* | BackboneElement | Who performed event | Σ | 0..* | BackboneElement | Who performed event | Elements differ in definition for mustSupport: 'true' vs 'false'
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 | S Σ | 1..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core Organization Profile) | 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: ?? (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 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. |
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