Skip to content

patient-view

Metadata Value
specificationVersion 1.0
hookVersion 1.0

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