CDS Hooks Library
2.0.0-cibuild - ci-build 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-cibuild 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

Logical Model: CDS Hook Specific Context for patient-view (Logical Definition) ( Experimental )

Official URL: http://cds-hooks.hl7.org/hooks/StructureDefinition/CDSHookPatientViewContext Version: 2.0.0-cibuild
Standards status: Informative Draft as of 2026-04-22 Computable Name: CDSHookPatientViewContext

This structure is defined to allow the FHIR Validator to validate a CDSHooks Patient-View context.

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHookPatientViewContext 0..* CDSHookContext The context for the patient-view hook
... userId C 1..1 string The id of the current user. Must be in the format [ResourceType]/[id].
Constraints: ord-1
... patientId 1..1 id The FHIR Patient.id of the current patient in context
... encounterId 0..1 id The FHIR Encounter.id of the current encounter in context

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookPatientViewContext.userId Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHookPatientViewContext 0..* CDSHookContext The context for the patient-view hook
... userId C 1..1 string The id of the current user. Must be in the format [ResourceType]/[id].
Constraints: ord-1
... patientId 1..1 id The FHIR Patient.id of the current patient in context
... encounterId 0..1 id The FHIR Encounter.id of the current encounter in context

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookPatientViewContext.userId Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Summary

Mandatory: 0 element(2 nested mandatory elements)

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHookPatientViewContext 0..* CDSHookContext The context for the patient-view hook
... userId C 1..1 string The id of the current user. Must be in the format [ResourceType]/[id].
Constraints: ord-1
... patientId 1..1 id The FHIR Patient.id of the current patient in context
... encounterId 0..1 id The FHIR Encounter.id of the current encounter in context

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookPatientViewContext.userId Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHookPatientViewContext 0..* CDSHookContext The context for the patient-view hook
... userId C 1..1 string The id of the current user. Must be in the format [ResourceType]/[id].
Constraints: ord-1
... patientId 1..1 id The FHIR Patient.id of the current patient in context
... encounterId 0..1 id The FHIR Encounter.id of the current encounter in context

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookPatientViewContext.userId Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')

Summary

Mandatory: 0 element(2 nested mandatory elements)

 

Other representations of profile: CSV, Excel