US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot
US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot
US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | Version: 10.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 5 | Computable Name: USCoreImmunizationProfile | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.31 | ||||
The US Core Immunization Profile inherits from the FHIR Immunization 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.
Example Usage Scenarios:
The following are example usage scenarios for the US Core Immunization profile:
The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each Immunization Must Have:
Each Immunization Must Support:
1,2,3,4 see guidance below
This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.
not-done to represent that an immunization was not given.§
Immunization.statusReason communicates the reason the vaccine was not administered at the point of care, such as patient refusal. Note that this binding is provisional, pending the review of the terminology aligned with the HL7 FHIR US Quality Core Implementation Guide.http://hl7.org/fhir/sid/cvx for CVX and http://hl7.org/fhir/sid/ndc for NDC vaccine codes. Note that the vaccineCode binding link in the formal definition and the CDC links below use the associated OID as the code system identifiers.Immunization.manufacturer to ensure global uniqueness to lot numbers.§4The profile element Immunization.performer.actor communicates the individual level provenance author data corresponding to the U.S. Core Data for Interoperability (USCDI) Provenance Author Data Elements.
For the USCDI Adverse Events Data Class, Immunization.reaction records a reaction following an immunization, which can be the change in condition that the USCDI Adverse Event Condition describes. Adverse events are recorded as ordinary clinical events and are not tagged as adverse events; see the Adverse Events: Clinical Records and Patient Safety Reporting page.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 9.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Immunization |
C | 0..* | Immunization | Immunization event information Constraints: us-core-5 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | |
 statusReason |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (extensible) | |
| vaccineCode |
C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set  (extensible) |
 patient |
1..1 | Reference(US Core Patient Profile) | Who was immunized | |
| encounter |
0..1 | Reference(US Core Encounter Profile) | Encounter the immunization was part of | |
 occurrence[x] |
1..1 | Vaccine administration date | ||
 occurrenceDateTime |
dateTime | |||
 occurrenceString |
string | |||
| primarySource |
0..1 | boolean | Indicates context the data was recorded in | |
| location |
0..1 | Reference(US Core Location Profile) | Where the vaccine was administered | |
| lotNumber |
0..1 | string | Vaccine lot number | |
| performer |
0..* | BackboneElement | Who performed event | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| actor |
1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or organization who was performing | |
| isSubpotent |
0..1 | boolean | Dose potency | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📦4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | extensible | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | extensible |
CVX Vaccines Administered Vaccine Set
|
⏿20260428 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| us-core-5 | best practice | Immunization | SHOULD have an additional coding to the NDC value set |
vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()
|
This structure is derived from Immunization
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📦4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | extensible | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | extensible |
CVX Vaccines Administered Vaccine Set
|
⏿20260428 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| us-core-5 | best practice | Immunization | SHOULD have an additional coding to the NDC value set |
vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
C | 0..* | Immunization | Immunization event information Constraints: us-core-5 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
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.
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | |||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (extensible) | |||||
| vaccineCode |
C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) | ||||
| patient |
1..1 | Reference(US Core Patient Profile) | Who was immunized | |||||
| encounter |
0..1 | Reference(US Core Encounter Profile) | Encounter the immunization was part of | |||||
| occurrence[x] |
1..1 | Vaccine administration date | ||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceString |
string | |||||||
| recorded |
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 | |||||
| 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. | |||||
| location |
0..1 | Reference(US Core Location Profile) | Where the vaccine was administered | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered Constraints: sqty-1 | ||||
| performer |
0..* | BackboneElement | Who performed event | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
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. | |||||
| actor |
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 | |||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
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. | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
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. | |||||
| fundingSource |
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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
| doseNumber[x] |
1..1 | Dose number within series | ||||||
| doseNumberPositiveInt |
positiveInt | |||||||
| doseNumberString |
string | |||||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| Documentation for this format | ||||||||
| Id | Grade | Path(s) | Description | Expression |
| us-core-5 | best practice | Immunization | SHOULD have an additional coding to the NDC value set |
vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()
|
This structure is derived from Immunization
Summary
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Maturity: 5
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
C | 0..* | Immunization | Immunization event information Constraints: us-core-5 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | |
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (extensible) | |
| vaccineCode |
C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) |
| patient |
1..1 | Reference(US Core Patient Profile) | Who was immunized | |
| encounter |
0..1 | Reference(US Core Encounter Profile) | Encounter the immunization was part of | |
| occurrence[x] |
1..1 | Vaccine administration date | ||
| occurrenceDateTime |
dateTime | |||
| occurrenceString |
string | |||
| primarySource |
0..1 | boolean | Indicates context the data was recorded in | |
| location |
0..1 | Reference(US Core Location Profile) | Where the vaccine was administered | |
| lotNumber |
0..1 | string | Vaccine lot number | |
| performer |
0..* | BackboneElement | Who performed event | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| actor |
1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or organization who was performing | |
| isSubpotent |
0..1 | boolean | Dose potency | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📦4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | extensible | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | extensible |
CVX Vaccines Administered Vaccine Set
|
⏿20260428 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| us-core-5 | best practice | Immunization | SHOULD have an additional coding to the NDC value set |
vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()
|
Differential View
This structure is derived from Immunization
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📦4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | extensible | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | extensible |
CVX Vaccines Administered Vaccine Set
|
⏿20260428 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| us-core-5 | best practice | Immunization | SHOULD have an additional coding to the NDC value set |
vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
C | 0..* | Immunization | Immunization event information Constraints: us-core-5 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
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.
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | |||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (extensible) | |||||
| vaccineCode |
C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) | ||||
| patient |
1..1 | Reference(US Core Patient Profile) | Who was immunized | |||||
| encounter |
0..1 | Reference(US Core Encounter Profile) | Encounter the immunization was part of | |||||
| occurrence[x] |
1..1 | Vaccine administration date | ||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceString |
string | |||||||
| recorded |
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 | |||||
| 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. | |||||
| location |
0..1 | Reference(US Core Location Profile) | Where the vaccine was administered | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered Constraints: sqty-1 | ||||
| performer |
0..* | BackboneElement | Who performed event | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
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. | |||||
| actor |
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 | |||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
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. | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
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. | |||||
| fundingSource |
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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
| doseNumber[x] |
1..1 | Dose number within series | ||||||
| doseNumberPositiveInt |
positiveInt | |||||||
| doseNumberString |
string | |||||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| Documentation for this format | ||||||||
| Id | Grade | Path(s) | Description | Expression |
| us-core-5 | best practice | Immunization | SHOULD have an additional coding to the NDC value set |
vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()
|
This structure is derived from Immunization
Summary
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Maturity: 5
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to immunization data SHALL support these US Core SMART Scopes:
<patient|user|system>/Immunization.rs §The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching for all immunizations for a patient using the patient search parameter
GET [base]/Immunization?patient={Patient/}[id]
Example:
- GET [base]/Immunization?patient=Patient/1137192
Implementation Notes: Fetches a bundle of all US Core Immunization Profile resources for the specified patient ( see how to search by reference).
SHALL support searching for all immunizations for a patient for a given status (for example all administered immunizations or all immunizations that were not given) using the combination of the patient and status search parameters
GET [base]/Immunization?patient={Patient/}[id]&status={system|}[search_code]
Example:
- GET [base]/Immunization?patient=Patient/1137192&status=completed
Implementation Notes: Fetches a bundle of all US Core Immunization Profile resources for the specified patient and status ( see how to search by reference and how to search by token).
The following search parameters and search parameter combinations SHOULD be supported
SHOULD support searching for all immunizations for a patient for a specified time period using the combination of the patient and date search parameters
Including optional support for AND search on date (e.g.date=[date]&date=[date]&...)
Including support for these date comparators: "gt", "lt", "ge", "le"
GET [base]/Immunization?patient={Patient/}[id]&date={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}
Example:
- GET [base]/Immunization?patient=Patient/1137192&date=ge2019-01-14T00:00:00Z
Implementation Notes: Fetches a bundle of all US Core Immunization Profile resources for the specified patient and date ( see how to search by reference and how to search by date).
1 Although the CVX code system contains some concepts that are procedures, medications, or substances rather than immunizations, the value set defined in VSAC has removed those and retained only the vaccine codes (see the exclusion definition in VSAC for more detail)
IG © 2027+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.core#10.0.0-ballot based on FHIR 4.0.1. Generated 2026-10-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change