Release 5 R6 Ballot (1st Draft)

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

Example ValueSet/immunization-status (XML)

Terminology Infrastructure Work Group Maturity Level : N/A Standards Status : Informative

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

Definition for Value SetImmunization Status Codes

<?xml version="1.0" encoding="UTF-8"?>

  
  
    
    
  
  
    
    
      
        Include these codes as defined in 
          
            
          
          
            
              
                
              
              
                
              
              
                
              
              
                
                  
                
              
            
            
              
                
              
              
              
              
                
                
              
            
            
              
                
              
              

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="immunization-status"/> 
  <meta> 
    <lastUpdated value="2023-12-18T15:12:07.602+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <ul> 
        <li> Include these codes as defined in 
          <a href="codesystem-event-status.html">
            <code> http://hl7.org/fhir/event-status</code> 
          </a> 
          <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;.).
              
                
                
              
            
            
              
                
              
              

                 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.
              
                
                
              
            
          
        
      
    
  
  
    
  
  
    
  
  
    
  
  
  
    
    
  
  
    
    
    
  
  
  
  
  
  
  
  
    
      
      
    
  

                 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> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pher"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/immunization-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.295"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.292"/> 
  </identifier> 
  <version value="6.0.0-ballot1"/> 
  <name value="ImmunizationStatusCodes"/> 
  <title value="Immunization Status Codes"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <publisher value="FHIR Project team"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="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.
  
    
      
      
      
    
  
  
    
      
      
        
      
      
        
      
      
        
      
    
  

   the current status of the administered dose of vaccine."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <compose> 
    <include> 
      <system value="http://hl7.org/fhir/event-status"/> 
      <concept> 
        <code value="completed"/> 
      </concept> 
      <concept> 
        <code value="entered-in-error"/> 
      </concept> 
      <concept> 
        <code value="not-done"/> 
      </concept> 
    </include> 
  </compose> 


</

ValueSet

>



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.