R6 Ballot (1st Draft)

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

Example CodeSystem/encounter-status (JSON)

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

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

Definition for Code SystemEncounterStatus

{
  "resourceType" : "CodeSystem",
  "id" : "encounter-status",
  "meta" : {
    "lastUpdated" : "2023-12-18T15:12:07.602+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><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.</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.</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.</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.</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;.</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" : 2
  }],
  "url" : "http://hl7.org/fhir/encounter-status",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.247"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.242"
  }],
  "version" : "6.0.0-ballot1",
  "name" : "EncounterStatus",
  "title" : "Encounter Status",
  "status" : "active",
  "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" : "Current state of the encounter.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/encounter-status",
  "content" : "complete",
  "concept" : [{
    "code" : "planned",
    "display" : "Planned",
    "definition" : "The Encounter has not yet started."
  },
  {
    "code" : "in-progress",
    "display" : "In Progress",
    "definition" : "The Encounter has begun and the patient is present / the practitioner and the patient are meeting."
  },
  {
    "code" : "on-hold",
    "display" : "On Hold",
    "definition" : "The Encounter has begun, but is currently on hold, e.g. because the patient is temporarily on leave."
  },
  {
    "code" : "discharged",
    "display" : "Discharged",
    "definition" : "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."
  },
  {
    "code" : "completed",
    "display" : "Completed",
    "definition" : "The Encounter has ended."
  },
  {
    "code" : "cancelled",
    "display" : "Cancelled",
    "definition" : "The Encounter has ended before it has begun."
  },
  {
    "code" : "discontinued",
    "display" : "Discontinued",
    "definition" : "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."
  },
  {
    "code" : "entered-in-error",
    "display" : "Entered in Error",
    "definition" : "This instance should not have been part of this patient's medical record."
  },
  {
    "code" : "unknown",
    "display" : "Unknown",
    "definition" : "The encounter status is unknown. Note that \"unknown\" is a value of last resort and every attempt should be made to provide a meaningful value other than \"unknown\"."
  }]
}

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.