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 . Page versions: R5 R4B R4 R3

Valueset-immunization-status.json

Example ValueSet/immunization-status (JSON)

Maturity Level : N/A
Responsible Owner: Vocabulary Terminology Infrastructure Work Group Ballot Standards Status : Informative

Raw JSON ( canonical form + also see JSON Format Specification )

Definition for Value SetImmunization Status Codes

{
  "resourceType": "ValueSet",
  "id": "immunization-status",
  "meta": {
    "lastUpdated": "2019-10-24T11:53:00+11:00",
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/shareablevalueset"
    ]

  "resourceType" : "ValueSet",
  "id" : "immunization-status",
  "meta" : {
    "lastUpdated" : "2025-11-12T19:40:08.403+00:00"

  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"

  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ValueSet immunization-status</b></p><a name=\"immunization-status\"> </a><a name=\"hcimmunization-status\"> </a><ul><li>Include these codes as defined in <a href=\"codesystem-event-status.html\"><code>http://hl7.org/fhir/event-status</code></a><span title=\"Version is not explicitly stated, which means it is fixed to the version provided in this specification\"> version &#x1F4E6;6.0.0-ballot3</span><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b><a href=\"valueset-resource-status.html\">Canonical Mapping for &quot;Immunization Status Codes&quot;</a></b></td></tr><tr><td><a href=\"codesystem-event-status.html#event-status-completed\">completed</a></td><td style=\"color: #cccccc\">Completed</td><td>The event has now concluded.</td><td><span title=\"EQUIVALENT\">~</span><a href=\"codesystem-resource-status.html#resource-status-complete\">complete</a></td></tr><tr><td><a href=\"codesystem-event-status.html#event-status-entered-in-error\">entered-in-error</a></td><td style=\"color: #cccccc\">Entered in Error</td><td>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 &quot;stopped&quot; rather than &quot;entered-in-error&quot;.).</td><td><span title=\"EQUIVALENT\">~</span><a href=\"codesystem-resource-status.html#resource-status-error\">error</a></td></tr><tr><td><a href=\"codesystem-event-status.html#event-status-not-done\">not-done</a></td><td style=\"color: #cccccc\">Not Done</td><td>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.</td><td><span title=\"EQUIVALENT\">~</span><a href=\"codesystem-resource-status.html#resource-status-abandoned\">abandoned</a></td></tr></table></li></ul></div>"

  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
      "valueString": "Informative"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pher"
    }
  ],
  "url": "http://hl7.org/fhir/ValueSet/immunization-status",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.3.292"
    }
  ],
  "version": "3.0.2",
  "name": "Immunization Status Codes",
  "status": "draft",
  "experimental": true,
  "date": "2019-10-24T11:53:00+11:00",
  "publisher": "FHIR Project team",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "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.",
  "compose": {
    "include": [

  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pher"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  }],
  "url" : "http://hl7.org/fhir/ValueSet/immunization-status",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.295"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.292"
  }],
  "version" : "6.0.0-ballot3",
  "name" : "ImmunizationStatusCodes",
  "title" : "Immunization Status Codes",
  "status" : "draft",
  "experimental" : false,
  "publisher" : "FHIR Project team",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "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.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "compose" : {
    "include" : [{
      "system" : "http://hl7.org/fhir/event-status",
      "concept" : [{
        "code" : "completed"
      },

      {
        "system": "http://hl7.org/fhir/medication-admin-status",
        "concept": [
          {
            "code": "completed"
          },
          {
            "code": "entered-in-error"
          }
        ]
      }
    ]

        "code" : "entered-in-error"
      },
      {
        "code" : "not-done"
      }]
    }]

  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.