patient-view

February 2020 STU Ballot

This is the first STU ballot of the patient-view hook. This hook was originally included as part of the first CDS Hooks ballot, but reconciliation of that ballot resulted in the CDS Hooks specification defining the structure of a hook definition, but no actual hooks. The Hook Maturity Model defines the process for proposing new hooks on the CDS Hooks Repository and the CDS Hooks Community Build Site. Once the hook reaches maturity level 4, it is balloted as part of an HL7 STU Ballot. This ballot is the first hook definition to be balloted using this process.

Ballot Content

Note carefully that this ballot is all and only this page. None of the rest of the CDS Hooks specification content is being balloted this cycle. Commenters should focus their review on the contents of this page.

Metadata Value
specificationVersion 1.0
hookVersion 1.0
Hook maturity 4 - Documented

Workflow

The user has just opened a 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.
For example, if the user represents a FHIR resource on the given FHIR server, the resource type would be one of Practitioner, Patient, or RelatedPerson.
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

Examples

1
2
3
4
"context":{
  "userId" : "Practitioner/123",
  "patientId" : "1288992"
}

1
2
3
4
5
"context":{
  "userId" : "Practitioner/123",
  "patientId" : "1288992",
  "encounterId" : "456"
}

Change Log

Version Description
1.0 Initial Release (1st STU Ballot)