Skip to content

Commit 4e77d58

Browse files
committed
#343: Updated prefetch example to use full key names instead of abbreviations
1 parent fec095d commit 4e77d58

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/specification/1.0.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -215,9 +215,9 @@ The CDS Service MUST NOT receive any prefetch template key that the EHR chooses
215215
```json
216216
{
217217
"prefetch": {
218-
"p": "Patient/{{context.patientId}}",
219-
"a1c": "Observation?patient={{context.patientId}}&code=4548-4&_count=1&sort:desc=date",
220-
"u": "Practitioner/{{context.userId}}"
218+
"patient": "Patient/{{context.patientId}}",
219+
"hemoglobin-a1c": "Observation?patient={{context.patientId}}&code=4548-4&_count=1&sort:desc=date",
220+
"user": "Practitioner/{{context.userId}}"
221221
}
222222
}
223223
```
@@ -227,22 +227,22 @@ goal is to know, at call time:
227227

228228
| Key | Description |
229229
| --- | ----------- |
230-
| `p` | Patient demographics. |
231-
| `a1c` | Most recent Hemoglobin A1c reading for this patient. |
232-
| `u` | Information on the current user (Practitioner).
230+
| `patient` | Patient demographics. |
231+
| `hemoglobin-a1c` | Most recent Hemoglobin A1c reading for this patient. |
232+
| `user` | Information on the current user (Practitioner).
233233

234234
#### Example prefetch response
235235

236236
```json
237237
{
238238
"prefetch": {
239-
"p":{
239+
"patient":{
240240
"resourceType": "Patient",
241241
"gender": "male",
242242
"birthDate": "1974-12-25",
243243
"...": "<snipped for brevity>"
244244
},
245-
"a1c": {
245+
"hemoglobin-a1c": {
246246
"resourceType": "Bundle",
247247
"type": "searchset",
248248
"entry": [{
@@ -264,9 +264,9 @@ goal is to know, at call time:
264264
```
265265

266266
The response is augmented to include two prefetch values, where the dictionary
267-
keys match the request keys (`p` and `a1c` in this case).
267+
keys match the request keys (`patient` and `hemoglobin-a1c` in this case).
268268

269-
Note that the missing `u` key indicates that either the EHR has decided not to satisfy this particular prefetch template or it was not able to retrieve this prefetched data. The CDS Service is responsible for retrieving this Practitioner data from the FHIR server (if required).
269+
Note that the missing `user` key indicates that either the EHR has decided not to satisfy this particular prefetch template or it was not able to retrieve this prefetched data. The CDS Service is responsible for retrieving this Practitioner data from the FHIR server (if required).
270270

271271
#### Prefetch query restrictions
272272

0 commit comments

Comments
 (0)