Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

4.4.1.2 ValueSet http://hl7.org/fhir/ValueSet/immunization-status

Public Health and Emergency Response icon

Work Group

Maturity Level: 5

Trial Use

Use Context: Country: World

Official URL: `http://hl7.org/fhir/ValueSet/immunization-status`				Version: 5.0.0
draft as of 2023-03-26				Computable Name: ImmunizationStatusCodes
Flags:				OID: 2.16.840.1.113883.4.642.3.295

This value set is used in the following places:

ConceptMap: Translation source in Canonical Mapping for "Immunization Status Codes"
Resource: Immunization.status (code / Required)

4.4.1.2.1 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.2.2 Content Logical Definition

Include these codes as defined in http://hl7.org/fhir/event-status

Code	Display	Definition	Canonical Mapping for "Immunization Status Codes"
completed	Completed	The event has now concluded.	~complete
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
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.	~abandoned

4.4.1.2.3 Expansion

This expansion generated 26 Mar 2023

This value set contains 3 concepts

Expansion based on EventStatus v5.0.0 (CodeSystem)

Code	System	Display	Definition	Canonical Mapping for "Immunization Status Codes"
completed	http://hl7.org/fhir/event-status	Completed	The event has now concluded.	~complete
entered-in-error	http://hl7.org/fhir/event-status	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
not-done	http://hl7.org/fhir/event-status	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.	~abandoned

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

Explanation of the columns that may appear on this page:

Lvl

A few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code 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