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 (JSON)

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

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

Definition for Code SystemAppointmentStatus

{
  "resourceType" : "CodeSystem",
  "id" : "appointmentstatus",
  "meta" : {
    "lastUpdated" : "2022-09-10T04:52:37.223+10:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<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.\nA specific time might or might not be pre-allocated.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pa"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 3
  }],
  "url" : "http://hl7.org/fhir/appointmentstatus",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.485"
  }],
  "version" : "5.0.0-ballot",
  "name" : "AppointmentStatus",
  "title" : "AppointmentStatus",
  "status" : "draft",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "The free/busy status of an appointment.",
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/appointmentstatus",
  "content" : "complete",
  "concept" : [{
    "code" : "proposed",
    "display" : "Proposed",
    "definition" : "None of the participant(s) have finalized their acceptance of the appointment request, and the start/end time might not be set yet."
  },
  {
    "code" : "pending",
    "display" : "Pending",
    "definition" : "Some or all of the participant(s) have not finalized their acceptance of the appointment request."
  },
  {
    "code" : "booked",
    "display" : "Booked",
    "definition" : "All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified."
  },
  {
    "code" : "arrived",
    "display" : "Arrived",
    "definition" : "The patient/patients has/have arrived and is/are waiting to be seen."
  },
  {
    "code" : "fulfilled",
    "display" : "Fulfilled",
    "definition" : "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."
  },
  {
    "code" : "cancelled",
    "display" : "Cancelled",
    "definition" : "The appointment has been cancelled."
  },
  {
    "code" : "noshow",
    "display" : "No Show",
    "definition" : "Some or all of the participant(s) have not/did not appear for the appointment (usually the patient)."
  },
  {
    "code" : "entered-in-error",
    "display" : "Entered in error",
    "definition" : "This instance should not have been part of this patient's medical record."
  },
  {
    "code" : "checked-in",
    "display" : "Checked In",
    "definition" : "When checked in, all pre-encounter administrative work is complete, and the encounter may begin. (where multiple patients are involved, they are all present)."
  },
  {
    "code" : "waitlist",
    "display" : "Waitlisted",
    "definition" : "The appointment has been placed on a waitlist, to be scheduled/confirmed in the future when a slot/service is available.\nA specific time might or might not be pre-allocated."
  }]
}

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.