Skip to content

Commit 24142bc

Browse files
authored
small fixes per review
1) fix misspelling of quantity 2) Clarify that hooks is agnostic of the type of order. 3) Clarify that this hooks "replaces" order-review. 4) Rename context `orders` field to `draftOrders`
1 parent 3cb2913 commit 24142bc

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/hooks/order-sign.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
## Workflow
99

10-
The `order-sign` hook fires when a clinician signs one or more orders for a patient.
10+
The `order-sign` hook fires when a clinician signs one or more orders for a patient, (including orders for medications, procedures, labs and other orders).
1111
This hook is among the last workflow events before an order is promoted out of a draft status.
12-
The context contains all order details, such as dose, quanity, route, etc,
12+
The context contains all order details, such as dose, quantity, route, etc,
1313
although the order has not yet been signed and therefore still exists in a draft status.
1414
Use this hook when your service requires all order details, and the clinician will accept recommended changes.
1515

16-
This hook is intended to deprecate the `order-review` hook.
16+
This hook is intended to replace (deprecate) the `order-review` hook.
1717

1818
## Context
1919

@@ -22,7 +22,7 @@ Field | Optionality | Prefetch Token | Type | Description
2222
`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).<br />For example, `Practitioner/123`
2323
`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the current patient in context
2424
`encounterId` | OPTIONAL | Yes | *string* | The FHIR `Encounter.id` of the current encounter in context
25-
`orders` | REQUIRED | No | *object* | DSTU2 - FHIR Bundle of MedicationOrder, DiagnosticOrder, DeviceUseRequest, ReferralRequest, ProcedureRequest, NutritionOrder, VisionPrescription with _draft_ status <br/> STU3 - FHIR Bundle of MedicationRequest, ReferralRequest, ProcedureRequest, NutritionOrder, VisionPrescription with _draft_ status
25+
`draftOrders` | REQUIRED | No | *object* | DSTU2 - FHIR Bundle of MedicationOrder, DiagnosticOrder, DeviceUseRequest, ReferralRequest, ProcedureRequest, NutritionOrder, VisionPrescription with _draft_ status <br/> STU3 - FHIR Bundle of MedicationRequest, ReferralRequest, ProcedureRequest, NutritionOrder, VisionPrescription with _draft_ status
2626

2727

2828

@@ -36,7 +36,7 @@ Field | Optionality | Prefetch Token | Type | Description
3636
"userId":"Practitioner/123",
3737
"patientId":"1288992",
3838
"encounterId":"89284",
39-
"orders":{
39+
"draftOrders":{
4040
"resourceType":"Bundle",
4141
"entry":[
4242
{
@@ -215,7 +215,7 @@ Field | Optionality | Prefetch Token | Type | Description
215215
"userId":"Practitioner/123",
216216
"patientId":"1288992",
217217
"encounterId":"89284",
218-
"orders":{
218+
"draftOrders":{
219219
"resourceType":"Bundle",
220220
"entry":[
221221
{

0 commit comments

Comments
 (0)