FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B

R4

4.4.1.5 R3 ValueSet http://hl7.org/fhir/ValueSet/immunization-status Using Codes

Responsible Owner: Public Health icon Code Systems Work Group Normative Value Sets Use Context : Country: World
  Maturity Level : 3
Official URL : http://hl7.org/fhir/ValueSet/immunization-status Public Health and Emergency Response Work Group Version : 6.0.0-ballot3
active as of 2025-11-20 Informative Computable Name : ImmunizationStatusCodes
Use Context : Not Intended for Production use Flags : OID : 2.16.840.1.113883.4.642.3.295

This is a value set defined by is used in the FHIR project. Summary following places:

Defining URL:

http://hl7.org/fhir/ValueSet/immunization-status 4.4.1.5.1 Definition Name: Immunization Status Codes Definition:

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the current status of the administered dose of vaccine.

4.4.1.5.2 Content Logical Definition

Generated Narrative: ValueSet immunization-status

Last updated: 2025-11-20T23:56:49.898Z

  • Include these codes as defined in http://hl7.org/fhir/event-status version 📦6.0.0-ballot3 Public Health and Emergency Response
    Code Display Definition Canonical Mapping for "Immunization Status Codes"
    Committee: completed Completed The event has now concluded. ~ complete Work Group
    OID: entered-in-error Entered in Error 2.16.840.1.113883.4.642.3.292 (for OID This electronic record should never have existed, though it is possible that real-world decisions were based terminology systems) on it. (If real-world activity has occurred, the status should be "stopped" rather than "entered-in-error".). ~ error
    Source Resource not-done Not Done The event was terminated prior to any activity beyond preparation. I.e. The 'main' activity has not yet begun. The boundary between preparatory and the 'main' activity is context-specific. XML / JSON ~ abandoned
    This value set is used in the following places: Immunization.status ( Required )

 

4.3.1.292.1 4.4.1.5.3 Content Logical Definition Expansion

This value set includes codes from the following code systems: expansion generated 20 Nov 2025

Include these codes as defined in ValueSet http://hl7.org/fhir/medication-admin-status

Expansion performed internally based on codesystem EventStatus v6.0.0-ballot3 (CodeSystem)

This value set contains 3 concepts

System Code Display Definition Canonical Mapping for "Immunization Status Codes"
completed http://hl7.org/fhir/event-status    completed Completed All actions that are implied by the administration have occurred. The event has now concluded. ~ complete
entered-in-error http://hl7.org/fhir/event-status    entered-in-error Entered in Error This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "stopped" rather than "entered-in-error".). ~ error
http://hl7.org/fhir/event-status    not-done Not Done The administration event was entered in error terminated prior to any activity beyond preparation. I.e. The 'main' activity has not yet begun. The boundary between preparatory and therefore nullified. the 'main' activity is context-specific. ~ abandoned

 

See the full registry of value sets defined as part of FHIR.

Explanation of the columns that may appear on this page:

Level Lvl A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes For value sets, levels are under other codes, and imply that the mostly used to organize codes for user convenience, but may follow code they are under also applies system hierarchy - see Code System for further information
Source The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
Display The display (used in the display element of a Coding ). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code