CDS Hooks Library, published by Clinical Decision Support WG. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cds-hooks-library/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use |
encounter-discharge| Metadata | Value |
|---|---|
| specificationVersion | 1.0 |
| hookVersion | 1.0.1 |
| hookMaturity | 1 - Submitted |
This hook is invoked when the user is performing the discharge process for an encounter where the notion of 'discharge' is relevant - typically an inpatient encounter. It may be invoked at the start and end of the discharge process or any time between those two points. It allows hook services to intervene in the decision of whether discharge is appropriate, to verify discharge medications, to check for continuity of care planning, to ensure necessary documentation is present for discharge processing, etc.
We are seeking implementer feedback on this workflow; see Workflow Feedback.
The patient who is being discharged and the encounter being ended.
| Field | Optionality | Prefetch Token | Type | Description |
|---|---|---|---|---|
userId |
REQUIRED | Yes | string | The id of the current user. For this hook, the user is expected to be of type Practitioner or PractitionerRole. For example, Practitioner/123 |
patientId |
REQUIRED | Yes | string | The FHIR Patient.id of the patient being discharged |
encounterId |
REQUIRED | Yes | string | The FHIR Encounter.id of the Encounter being ended |
Note: CDS Hooks is designed to be agnostic of FHIR version. The FHIR resources referenced on this page are those of the FHIR version used by the CDS Service's implementation.
"context":{
"userId" : "PractitionerRole/A2340113",
"patientId" : "1288992",
"encounterId" : "456"
}
| Version | Description |
|---|---|
| 1.0 | Initial Release |
| 1.0.1 | Added encounter workflow diagram (FHIR-51509); removed version-specific FHIR resource links and added a FHIR version note (FHIR-50078); corrected typographical errors |