Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

availability of data and safety #506

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/hooks/patient-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,18 @@ The user has just opened a patient's record.

## Context

The patient whose record was opened, including their encounter, if applicable.
The patient whose record was opened, including their encounter, if applicable.

The FHIR resources, referenced by ids in `context`, SHOULD be available to the CDS service. If supported by the CDS Client, the CDS service may request these resources through prefetch. Alternatively or additionally the CDS Client may provide a `fhirserver` in the request for RESTful access. Support for both `prefetch` and `fhirServer` are optional. As such, CDS Service implementers need to be aware that CDS Clients may not support this behavior.

Field | Optionality | Prefetch Token | Type | Description
----- | -------- | ---- | ---- | ----
`userId` | REQUIRED | Yes | *string* | The id of the current user.<br />For example, if the user represents a FHIR resource on the given FHIR server, the resource type would be one of [Practitioner](https://www.hl7.org/fhir/practitioner.html), [Patient](https://www.hl7.org/fhir/patient.html), or [RelatedPerson](https://www.hl7.org/fhir/relatedperson.html).<br />If the user was a Practitioner, this value would be `Practitioner/123`
`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the current patient in context
`encounterId` | OPTIONAL | Yes | *string* | The FHIR `Encounter.id` of the current encounter in context

The `patient-view` hook allows a CDS Service to provide guidance based on information acquired using a prefetch template and the FHIR server. A variety of factors could cause this information to become outdated. Stale clinical data could result in a risk to patient safety. For information on patient safety issues see [Security & Safety](../../specification/1.0/#security-and-safety).

### Examples

```json
Expand Down