R6 Ballot (3rd Draft) (1st Full Ballot)

Publish-box (todo) This page is part of the FHIR Specification v6.0.0-ballot4: Release 6 Ballot (1st Full Ballot) (see Ballot Notes ). The current version is 5.0.0 . For a full list of available versions, see the Directory of published versions for published versions

Example CodeSystem/encounter-status (XML)

Maturity Level : N/A
Responsible Owner: Patient Administration Work Group Standards Status : Informative

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

Definition for Code SystemEncounterStatus

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

  
  
    
    
  
  
    
    
      
        
      
      
      
      

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="encounter-status"/> 
  <meta> 
    <lastUpdated value="2025-12-18T07:07:42.170+11:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: CodeSystem encounter-status</b> 
      </p> 
      <a name="encounter-status"> </a> 
      <a name="hcencounter-status"> </a> 
      <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border:
       1px solid #8da1b4; border-radius: 5px; line-height: 60%
        
        Profile: 
          
        
      
      This case-sensitive code system 
         defines the following codes:
      
      
        
          
            
          
          
            
          
          
            
          
        
        
          planned
            
          
          
          
        
        
          in-progress
            
          
          

       1px solid #8da1b4; border-radius: 5px; line-height: 60%">
        <p style="margin-bottom: 0px">Last updated: 2021-01-05T10:01:24.148+11:00</p> 
      </div> 
      <p> This case-sensitive code system 
        <code> http://hl7.org/fhir/encounter-status</code>  defines the following codes:
      </p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">planned
            <a name="encounter-status-planned"> </a> 
          </td> 
          <td> Planned</td> 
          <td> The Encounter has not yet started.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">in-progress
            <a name="encounter-status-in-progress"> </a> 
          </td> 
          <td> In Progress</td> 
          <td> The Encounter has begun and the patient is present / the practitioner and the patient
             are meeting.
        
        
          on-hold
            
          
          

             are meeting.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">on-hold
            <a name="encounter-status-on-hold"> </a> 
          </td> 
          <td> On Hold</td> 
          <td> The Encounter has begun, but is currently on hold, e.g. because the patient is
             temporarily on leave.
        
        
          discharged
            
          
          

             temporarily on leave.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">discharged
            <a name="encounter-status-discharged"> </a> 
          </td> 
          <td> Discharged</td> 
          <td> The Encounter has been clinically completed, the patient has been discharged from
             the facility or the visit has ended, and the patient may have departed (refer to
             subjectStatus). While the encounter is in this status, administrative activities
             are usually performed, collating all required documentation and charge information
             before being released for billing, at which point the status will move to completed.
        
        
          completed
            
          
          
          
        
        
          cancelled
            
          
          
          
        
        
          discontinued
            
          
          

             before being released for billing, at which point the status will move to completed.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">completed
            <a name="encounter-status-completed"> </a> 
          </td> 
          <td> Completed</td> 
          <td> The Encounter has ended.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">cancelled
            <a name="encounter-status-cancelled"> </a> 
          </td> 
          <td> Cancelled</td> 
          <td> The Encounter has ended before it has begun.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">discontinued
            <a name="encounter-status-discontinued"> </a> 
          </td> 
          <td> Discontinued</td> 
          <td> The Encounter has started, but was not able to be completed. Further action may
             need to be performed, such as rescheduling appointments related to this encounter.
        
        
          entered-in-error
            
          
          
          
        
        
          unknown
            
          
          

             need to be performed, such as rescheduling appointments related to this encounter.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">entered-in-error
            <a name="encounter-status-entered-in-error"> </a> 
          </td> 
          <td> Entered in Error</td> 
          <td> This instance should not have been part of this patient's medical record.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">unknown
            <a name="encounter-status-unknown"> </a> 
          </td> 
          <td> Unknown</td> 
          <td> The encounter status is unknown. Note that &quot;unknown&quot; is a value of last
             resort and every attempt should be made to provide a meaningful value other than
             &quot;unknown&quot;.
        
      
    
  
  
    
  
  
    
  
  
    
  
  
  
    
    
  
  
    
    
    
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  
  
  
    
      
      
      
    
  
  
  
  
  
    
    
    
  
  
    
    

             &quot;unknown&quot;.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pa"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="4"/> 
  </extension> 
  <url value="http://hl7.org/fhir/encounter-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.247"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.242"/> 
  </identifier> 
  <version value="6.0.0-ballot4"/> 
  <name value="EncounterStatus"/> 
  <title value="Encounter Status"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2021-01-05T10:01:24+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="Current state of the encounter."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/encounter-status"/> 
  <content value="complete"/> 
  <concept> 
    <code value="planned"/> 
    <display value="Planned"/> 
    <definition value="The Encounter has not yet started."/> 
  </concept> 
  <concept> 
    <code value="in-progress"/> 
    <display value="In Progress"/> 
    <definition value="The Encounter has begun and the patient is present / the practitioner and the patient
     are meeting.
  
  
    
    

     are meeting."/> 
  </concept> 
  <concept> 
    <code value="on-hold"/> 
    <display value="On Hold"/> 
    <definition value="The Encounter has begun, but is currently on hold, e.g. because the patient is
     temporarily on leave.
  
  
    
    

     temporarily on leave."/> 
  </concept> 
  <concept> 
    <code value="discharged"/> 
    <display value="Discharged"/> 
    <definition value="The Encounter has been clinically completed, the patient has been discharged from
     the facility or the visit has ended, and the patient may have departed (refer to
     subjectStatus). While the encounter is in this status, administrative activities
     are usually performed, collating all required documentation and charge information
     before being released for billing, at which point the status will move to completed.
  
  
    
    
    
  
  
    
    
    
  
  
    
    

     before being released for billing, at which point the status will move to completed."/> 
  </concept> 
  <concept> 
    <code value="completed"/> 
    <display value="Completed"/> 
    <definition value="The Encounter has ended."/> 
  </concept> 
  <concept> 
    <code value="cancelled"/> 
    <display value="Cancelled"/> 
    <definition value="The Encounter has ended before it has begun."/> 
  </concept> 
  <concept> 
    <code value="discontinued"/> 
    <display value="Discontinued"/> 
    <definition value="The Encounter has started, but was not able to be completed. Further action may
     need to be performed, such as rescheduling appointments related to this encounter.
  
  
    
    
    
  
  
    
    

     need to be performed, such as rescheduling appointments related to this encounter."/> 
  </concept> 
  <concept> 
    <code value="entered-in-error"/> 
    <display value="Entered in Error"/> 
    <definition value="This instance should not have been part of this patient's medical record."/> 
  </concept> 
  <concept> 
    <code value="unknown"/> 
    <display value="Unknown"/> 
    <definition value="The encounter status is unknown. Note that &quot;unknown&quot; is a value of last
     resort and every attempt should be made to provide a meaningful value other than
     &quot;unknown&quot;.
  

     &quot;unknown&quot;."/> 
  </concept> 


</

CodeSystem

>



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.