CDS Hooks Library
2.0.0-ballot - R2 Normative Ballot International flag

CDS Hooks Library, published by Clinical Decision Support WG. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cds-hooks-library/ and changes regularly. See the Directory of published versions

Patient View

Page standards status: Normative

patient-view

Metadata Value
specificationVersion 1.0
hookVersion 1.0.1
hookMaturity 6 - Normative

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

Note: CDS Hooks is designed to be agnostic of FHIR version. The FHIR resources referenced on this page are those of the FHIR version used by the CDS Service's implementation.

Examples

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

Change Log

Version Description
1.0 Initial Release
1.0.1 Removed version-specific FHIR resource links and added a FHIR version note (FHIR-50078)