patient-view

Info

This page defines a workflow hook for the purpose of providing clinical decision support using CDS Hooks. This is a build at the level of Trial Use.

Metadata	Value
specificationVersion	1.0
hookVersion	1.0
hookMaturity	5 - Mature

Workflow

The user has just opened a patient's record; typically called only once at the beginning of a user's interaction with a specific patient's record.

Context

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

Field	Optionality	Prefetch Token	Type	Description
userId	REQUIRED	Yes	string	The id of the current user. Must be in the format [ResourceType]/[id]. For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/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

Examples

"context":{
  "userId" : "PractitionerRole/123",
  "patientId" : "1288992"
}

"context":{
  "userId" : "Practitioner/abc",
  "patientId" : "1288992",
  "encounterId" : "456"
}

Change Log

Version	Description
1.0	Initial Release