Proposal for new "discharge" hook, initiated by Davinci coverage requirements discovery (#466)

Author: lmckenzi

docs/hooks/encounter-discharge.md

@@ -0,0 +1,38 @@
+# `encounter-discharge`
+
+| Metadata | Value
+| ---- | ----
+| specificationVersion | 1.0
+| hookVersion | 1.0
+| hookMaturity | 0 - Draft 
+
+## Workflow
+
+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.
+
+## Context
+
+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.<br />For this hook, the user is expected to be of type [Practitioner](https://www.hl7.org/fhir/practitioner.html) or [PractitionerRole](https://www.hl7.org/fhir/practitionerrole.html).<br />For example, `Practitioner/123`
+`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the being discharged
+`encounterId` | REQUIRED | Yes | *string* | The FHIR `Encounter.id` of the Encounter being ended
+
+### Examples
+
+```json
+"context":{
+  "userId" : "PractitionerRole/A2340113",
+  "patientId" : "1288992",
+  "encounterId" : "456"
+}
+```
+
+## Change Log
+
+Version | Description
+---- | ----
+1.0 | Initial Release
+

mkdocs.yml

@@ -23,6 +23,7 @@ nav:
     - 'order-sign 1' : 'hooks/order-sign.md'
     - 'appointment-book 0' : 'hooks/appointment-book.md'
     - 'encounter-start 0' : 'hooks/encounter-start.md'
+    - 'encounter-discharge 0' : 'hooks/encounter-discharge.md'
 - Quick Start: 'quickstart.md'
 - Best Practices: 'best-practices.md'
 - Examples: 'examples.md'