Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32 ) in it's permanent home (it will always be available at this URL). ). 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

Extension-capabilities.json

4.4.1.533 ValueSet http://hl7.org/fhir/ValueSet/encounter-status

FHIR Infrastructure Patient Administration icon Work Group   Maturity Level : N/A 2 Standards Status Trial Use Use Context : Informative Country: World, Country: World
Official URL : http://hl7.org/fhir/ValueSet/encounter-status Version : 5.0.0-snapshot3
draft as of 2020-12-28 Computable Name : EncounterStatus
Flags : Immutable OID : 2.16.840.1.113883.4.642.3.246

Raw JSON This value set is used in the following places:

4.4.1.533.1 Definition

Current state of the encounter.

4.4.1.533.2 Content Logical Definition

capabilities  

4.4.1.533.3 Expansion

This expansion generated 14 Dec 2022

This value set contains 9 concepts

Expansion based on EncounterStatus v5.0.0-snapshot3 (CodeSystem)

Code System Display Definition Canonical Mapping for "EncounterStatus"
   planned http://hl7.org/fhir/encounter-status Planned

The Encounter has not yet started.

~ planned
   in-progress http://hl7.org/fhir/encounter-status In Progress

The Encounter has begun and the patient is present / the practitioner and the patient are meeting.

{ "resourceType" : "StructureDefinition", "id" : "capabilities", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "fhir" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 1 }], "url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities", "version" : "4.0.1", "name" : "capabilities", "status" : "active", "date" : "2018-02-15", "publisher" : "Health Level Seven International (FHIR Infrastructure)", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://www.hl7.org/Special/committees/fiwg" }] }], "description" : "A set of codes that defines what the server is capable of.", "fhirVersion" : "4.0.1", "mapping" : [{ "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }], "kind" : "complex-type", "abstract" : false, "context" : [{ "type" : "element", "expression" : "CapabilityStatement.rest.security" }], "type" : "Extension", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension", "derivation" : "constraint", "snapshot" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "Server Capabilities", "definition" : "A set of codes that defines what the server is capable of.", "min" : 0, "max" : "*", "base" : { "path" : "Extension", "min" : 0, "max" : "*" }, "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false }, { "id" : "Extension.id", "path" : "Extension.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Extension.extension", "path" : "Extension.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Extension", "definition" : "An Extension", "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Extension.url", "path" : "Extension.url", "representation" : ["xmlAttr"], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "uri" }], "code" : "http://hl7.org/fhirpath/System.String" }], "fixedUri" : "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities", "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "short" : "Value of extension", "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list).", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "SmartCapabilities" }], "strength" : "required", "description" : "Codes that define what the server is capable of.", "valueSet" : "http://hl7.org/fhir/ValueSet/smart-capabilities|4.0.1" }, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }] }, "differential" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "Server Capabilities", "definition" : "A set of codes that defines what the server is capable of.", "min" : 0, "max" : "*" }, { "id" : "Extension.extension", "path" : "Extension.extension", "max" : "0" }, { "id" : "Extension.url", "path" : "Extension.url", "fixedUri" : "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities" }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "min" : 1, "type" : [{ "code" : "code" }], "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "SmartCapabilities" }], "strength" : "required", "description" : "Codes that define what the server is capable of.", "valueSet" : "http://hl7.org/fhir/ValueSet/smart-capabilities|4.0.1" } }] } }
~ active
   on-hold http://hl7.org/fhir/encounter-status On Hold

Usage note: every effort The Encounter has begun, but is currently on hold, e.g. because the patient is temporarily on leave.

~ suspended
   discharged http://hl7.org/fhir/encounter-status Discharged

The Encounter has been made clinically completed, the patient has been discharged from the facility or the visit has ended, and the patient may have departed (refer to ensure that subjectStatus). While the examples encounter is in this status, administrative activities are correct usually performed, collating all required documentation and useful, charge information before being released for billing, at which point the status will move to completed.

~ partial
   completed http://hl7.org/fhir/encounter-status Completed

The Encounter has ended.

~ complete
   cancelled http://hl7.org/fhir/encounter-status Cancelled

The Encounter has ended before it has begun.

~ failed
   discontinued http://hl7.org/fhir/encounter-status Discontinued

The Encounter has started, but they are was not able to be completed. Further action may need to be performed, such as rescheduling appointments related to this encounter.

~ abandoned
   entered-in-error http://hl7.org/fhir/encounter-status Entered in Error

This instance should not have been part of this patient's medical record.

~ error
   unknown http://hl7.org/fhir/encounter-status Unknown

The encounter status is unknown. Note that "unknown" is a normative value of last resort and every attempt should be made to provide a meaningful value other than "unknown".

~ unknown

 

See the full registry of value sets defined as part of FHIR.

Explanation of the specification. columns that may appear on this page:

Lvl A few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code system hierarchy - see Code System for further information
Source The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
Display The display (used in the display element of a Coding ). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code