Skip to content

Commit f12274b

Browse files
authored
rename orders to draftOrders
per feedback from review & CDS wg.
1 parent b7149de commit f12274b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/hooks/order-select.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ The `order-select` hook occurs after the clinician selects the order, but before
1717

1818
## Context
1919

20-
The context of this hook distinguishes between the list of unsigned orders from the clinician's ordering session, and one or orders just added to this list. The `selections` field contains a list of ids of these newly selected orders; the `orders` Bundle contains an entry for all unsigned orders from this session, including newly selected orders.
20+
The context of this hook distinguishes between the list of unsigned orders from the clinician's ordering session, and one or orders just added to this list. The `selections` field contains a list of ids of these newly selected orders; the `draftOrders` Bundle contains an entry for all unsigned orders from this session, including newly selected orders.
2121

2222
Field | Optionality | Prefetch Token | Type | Description
2323
----- | -------- | ---- | ---- | ----
2424
`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`
2525
`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the current patient in context
2626
`encounterId` | OPTIONAL | Yes | *string* | The FHIR `Encounter.id` of the current encounter in context
2727
`selections` | REQUIRED | No| *array* | The FHIR id of the newly selected order(s).<br />The `selections` field references FHIR resources in the `orders` Bundle. For example, `MedicationRequest/103`.
28-
`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
28+
`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
2929

3030

3131

@@ -40,7 +40,7 @@ Field | Optionality | Prefetch Token | Type | Description
4040
"patientId":"1288992",
4141
"encounterId":"89284",
4242
"selections": [ "NutritionOrder/pureeddiet-simple", "MedicationRequest/smart-MedicationRequest-103" ],
43-
"orders":{
43+
"draftOrders":{
4444
"resourceType":"Bundle",
4545
"entry":[
4646
{
@@ -220,7 +220,7 @@ Field | Optionality | Prefetch Token | Type | Description
220220
"patientId":"1288992",
221221
"encounterId":"89284",
222222
"selections":[ "NutritionOrder/nest-patient-1-NUTR1", "MedicationOrder/smart-MedicationOrder-103" ],
223-
"orders":{
223+
"draftOrders":{
224224
"resourceType":"Bundle",
225225
"entry":[
226226
{

0 commit comments

Comments
 (0)