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 Hooks Specific Context for order-dispatch (Logical Definition) ( Experimental )

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

This structure is defined to allow the FHIR Validator to validate a CDSHooks order-dispatch 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
.. CDSHookOrderDispatchContext 0..* CDSHookContext The context for the order-dispatch hook
... patientId 1..1 id The FHIR Patient.id of the current patient in context
... dispatchedOrders 1..* string Array of FHIR references
Id may or not be present (this is the default for elements but not resources)
... performer C 1..1 string Who orders are dispatched to in form [ResourceType]/[ResourceId]
Constraints: ord-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ord-1 error CDSHookOrderDispatchContext.performer Must be in the format {type}/{id} $this.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHookOrderDispatchContext 0..* CDSHookContext The context for the order-dispatch hook
... patientId 1..1 id The FHIR Patient.id of the current patient in context
... dispatchedOrders 1..* string Array of FHIR references
Id may or not be present (this is the default for elements but not resources)
... performer C 1..1 string Who orders are dispatched to in form [ResourceType]/[ResourceId]
Constraints: ord-1

doco Documentation for this format

Constraints

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

Summary

Mandatory: 0 element(3 nested mandatory elements)

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHookOrderDispatchContext 0..* CDSHookContext The context for the order-dispatch hook
... patientId 1..1 id The FHIR Patient.id of the current patient in context
... dispatchedOrders 1..* string Array of FHIR references
Id may or not be present (this is the default for elements but not resources)
... performer C 1..1 string Who orders are dispatched to in form [ResourceType]/[ResourceId]
Constraints: ord-1

doco Documentation for this format

Constraints

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

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHookOrderDispatchContext 0..* CDSHookContext The context for the order-dispatch hook
... patientId 1..1 id The FHIR Patient.id of the current patient in context
... dispatchedOrders 1..* string Array of FHIR references
Id may or not be present (this is the default for elements but not resources)
... performer C 1..1 string Who orders are dispatched to in form [ResourceType]/[ResourceId]
Constraints: ord-1

doco Documentation for this format

Constraints

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

Summary

Mandatory: 0 element(3 nested mandatory elements)

 

Other representations of profile: CSV, Excel