| Left: | US Core Immunization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization) |
| Right: | US Core Immunization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization) |
| Error | StructureDefinition.version | Values for version differ: '7.0.0' vs '10.0.0-ballot' |
| Information | Immunization.language | Example/preferred bindings differ at Immunization.language using binding from USCoreImmunizationProfile |
| Warning | Immunization.lotNumber | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | Immunization.performer | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | Immunization.performer.actor | Elements differ in definition for mustSupport: 'false' vs 'true' |
| 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 |
| |
| date | 2023-10-17 | ||
| 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. | ||
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
 jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USCoreImmunizationProfile | ||
| publisher | HL7 International / Cross-Group Projects | ||
| purpose | |||
| status | active | ||
| title | US Core Immunization Profile | ||
| type | Immunization | ||
| url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | ||
| version | 7.0.0 | 10.0.0-ballot |
|
| 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 | 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.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
|
| ||||||||||
| 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 | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required) | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required) | |||||||||||
| statusReason | 0..1 | CodeableConcept | Reason not done Binding: ?? (example) | 0..1 | CodeableConcept | Reason not done Binding: ?? (extensible) | |||||||||||
| vaccineCode | C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: ?? (extensible) | C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: ?? (extensible) | |||||||||
| patient | 1..1 | Reference(US Core Patient Profile) | Who was immunized | 1..1 | Reference(US Core Patient Profile) | Who was immunized | |||||||||||
| encounter | 0..1 | Reference(US Core Encounter Profile) | Encounter the immunization was part of | 0..1 | Reference(US Core Encounter Profile) | Encounter the immunization was part of | |||||||||||
| occurrence[x] | 1..1 | dateTime , string | Vaccine administration date | 1..1 | dateTime , 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 | 0..1 | boolean | Indicates context the data was recorded in | |||||||||||
| 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(US Core Location Profile) | Where the vaccine was administered | 0..1 | Reference(US Core Location Profile) | Where the vaccine was administered | |||||||||||
| 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 | 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 | C | 0..1 | ?? | Amount of vaccine administered | ||||||||||
| performer | 0..* | BackboneElement | Who performed event | 0..* | BackboneElement | Who performed event |
| ||||||||||
 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 | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or organization who was performing |
| ||||||||||
| 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 | |||||||||||||||||