Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/appointmentstatus (XML)

Patient Administration Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemAppointmentStatus

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="appointmentstatus"/> 
  <meta> 
    <lastUpdated value="2022-09-10T04:52:37.223+10:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system 
        <code> http://hl7.org/fhir/appointmentstatus</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">proposed
            <a name="appointmentstatus-proposed"> </a> 
          </td> 
          <td> Proposed</td> 
          <td> None of the participant(s) have finalized their acceptance of the appointment request,
             and the start/end time might not be set yet.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">pending
            <a name="appointmentstatus-pending"> </a> 
          </td> 
          <td> Pending</td> 
          <td> Some or all of the participant(s) have not finalized their acceptance of the appointment
             request.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">booked
            <a name="appointmentstatus-booked"> </a> 
          </td> 
          <td> Booked</td> 
          <td> All participant(s) have been considered and the appointment is confirmed to go
             ahead at the date/times specified.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">arrived
            <a name="appointmentstatus-arrived"> </a> 
          </td> 
          <td> Arrived</td> 
          <td> The patient/patients has/have arrived and is/are waiting to be seen.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">fulfilled
            <a name="appointmentstatus-fulfilled"> </a> 
          </td> 
          <td> Fulfilled</td> 
          <td> The planning stages of the appointment are now complete, the encounter resource
             will exist and will track further status changes. Note that an encounter may exist
             before the appointment status is fulfilled for many reasons.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">cancelled
            <a name="appointmentstatus-cancelled"> </a> 
          </td> 
          <td> Cancelled</td> 
          <td> The appointment has been cancelled.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">noshow
            <a name="appointmentstatus-noshow"> </a> 
          </td> 
          <td> No Show</td> 
          <td> Some or all of the participant(s) have not/did not appear for the appointment (usually
             the patient).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">entered-in-error
            <a name="appointmentstatus-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">checked-in
            <a name="appointmentstatus-checked-in"> </a> 
          </td> 
          <td> Checked In</td> 
          <td> When checked in, all pre-encounter administrative work is complete, and the encounter
             may begin. (where multiple patients are involved, they are all present).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">waitlist
            <a name="appointmentstatus-waitlist"> </a> 
          </td> 
          <td> Waitlisted</td> 
          <td> The appointment has been placed on a waitlist, to be scheduled/confirmed in the
             future when a slot/service is available.
A specific time might or might not be pre-allocated.</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="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3"/> 
  </extension> 
  <url value="http://hl7.org/fhir/appointmentstatus"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.485"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="AppointmentStatus"/> 
  <title value="AppointmentStatus"/> 
  <status value="draft"/> 
  <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="The free/busy status of an appointment."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/appointmentstatus"/> 
  <content value="complete"/> 
  <concept> 
    <code value="proposed"/> 
    <display value="Proposed"/> 
    <definition value="None of the participant(s) have finalized their acceptance of the appointment request,
     and the start/end time might not be set yet."/> 
  </concept> 
  <concept> 
    <code value="pending"/> 
    <display value="Pending"/> 
    <definition value="Some or all of the participant(s) have not finalized their acceptance of the appointment
     request."/> 
  </concept> 
  <concept> 
    <code value="booked"/> 
    <display value="Booked"/> 
    <definition value="All participant(s) have been considered and the appointment is confirmed to go
     ahead at the date/times specified."/> 
  </concept> 
  <concept> 
    <code value="arrived"/> 
    <display value="Arrived"/> 
    <definition value="The patient/patients has/have arrived and is/are waiting to be seen."/> 
  </concept> 
  <concept> 
    <code value="fulfilled"/> 
    <display value="Fulfilled"/> 
    <definition value="The planning stages of the appointment are now complete, the encounter resource
     will exist and will track further status changes. Note that an encounter may exist
     before the appointment status is fulfilled for many reasons."/> 
  </concept> 
  <concept> 
    <code value="cancelled"/> 
    <display value="Cancelled"/> 
    <definition value="The appointment has been cancelled."/> 
  </concept> 
  <concept> 
    <code value="noshow"/> 
    <display value="No Show"/> 
    <definition value="Some or all of the participant(s) have not/did not appear for the appointment (usually
     the patient)."/> 
  </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="checked-in"/> 
    <display value="Checked In"/> 
    <definition value="When checked in, all pre-encounter administrative work is complete, and the encounter
     may begin. (where multiple patients are involved, they are all present)."/> 
  </concept> 
  <concept> 
    <code value="waitlist"/> 
    <display value="Waitlisted"/> 
    <definition value="The appointment has been placed on a waitlist, to be scheduled/confirmed in the
     future when a slot/service is available.
A specific time might or might not be pre-allocated."/> 
  </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.