This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.2.0-ballot: STU 2.2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.1.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: CRD CDSHooks Request (Logical Definition)

Defines CRD-specific constraints on the CDS Hooks Request logical model

Usages:

• This Logical Model Profile 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 of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksRequest	C	0..*	CDSHooksRequest	Elements defined in Ancestors:extension, hook, hookInstance, fhirServer, fhirAuthorization, context, prefetch Request for decision support Constraints: cds-r-1
extension		0..1	CDSHooksExtensions	Extension
hook	S	1..1	code	Hook event triggering call Binding: CDS Hook Types Value Set (required)
hookInstance	S	1..1	uuid	Unique id for hook invocation When this element is read urn:uuid: is prefixed to the value before validation
fhirServer	S	1..1	url	Location to query for data
fhirAuthorization	SC	1..1	CDSHooksElement	Auth to use in queries Constraints: cds-r-2
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
accessToken	S	1..1	string	Auth token for query header JSON Property Name: access_token
tokenType	S	1..1	code	Bearer JSON Property Name: token_type Fixed Value: Bearer
expiresIn	S	1..1	integer	Seconds token is valid JSON Property Name: expires_in
scope	S	1..1	string	Granted access scopes
subject	S	1..1	string	Patient id for access
patient		0..1	id	OAuth 2.0 client identifier of the CDS Service
context	S	1..1	CDSHookContext	Context for decision support JSON: If%resource.hook = 'appointment-book'then the type is CDSHookAppointmentBookContext JSON: If%resource.hook = 'encounter-start'then the type is CDSHookEncounterStartContext JSON: If%resource.hook = 'encounter-discharge'then the type is CDSHookEncounterDischargeContext JSON: If%resource.hook = 'patient-view'then the type is CDSHookPatientViewContext JSON: If%resource.hook = 'order-dispatch'then the type is CDSHookOrderDispatchContext JSON: If%resource.hook = 'order-sign'then the type is CDSHookOrderSignContext JSON: If%resource.hook = 'order-select'then the type is CDSHookOrderSelectContext
prefetch	S	0..*	Base	Prefetch info requested by server JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
key	S	1..1	code	Key as specfied in server prefetch config
value	S	1..1	Resource	Resource(s) matching prefetch criteria Id may or not be present (this is the default for elements but not resources) JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CDSHooksRequest.hook	required	CDSHookType http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
cds-r-1	error	CDSHooksRequest	if fhirAuthorization details are provided, a fhirServer SHALL be specified : fhirAuthorization.exists() implies fhirServer.exists()
cds-r-2	error	CDSHooksRequest.fhirAuthorization	If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient. : scope.contains('Patient/') implies patient.exists()

This structure is derived from CDSHooksRequest

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksRequest		0..*	CDSHooksRequest	Elements defined in Ancestors:extension, hook, hookInstance, fhirServer, fhirAuthorization, context, prefetch Request for decision support
extension		0..1	CDSHooksExtensions	Extension
hook	S	1..1	code	Hook event triggering call Binding: CDS Hook Types Value Set (required)
hookInstance	S	1..1	uuid	Unique id for hook invocation
fhirServer	S	1..1	url	Location to query for data
fhirAuthorization	S	1..1	CDSHooksElement	Auth to use in queries
accessToken	S	1..1	string	Auth token for query header
tokenType	S	1..1	code	Bearer
expiresIn	S	1..1	integer	Seconds token is valid
scope	S	1..1	string	Granted access scopes
subject	S	1..1	string	Patient id for access
context	S	1..1	CDSHookContext	Context for decision support JSON: If%resource.hook = 'appointment-book'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookAppointmentBookContext JSON: If%resource.hook = 'encounter-start'then the type is http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterStartContext JSON: If%resource.hook = 'encounter-discharge'then the type is http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterDischargeContext JSON: If%resource.hook = 'order-dispatch'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDOrderDispatchContext JSON: If%resource.hook = 'order-select'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext JSON: If%resource.hook = 'order-sign'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext
prefetch	S	0..*	Base	Prefetch info requested by server
key	S	1..1	code	Key as specfied in server prefetch config
value	S	1..1	Resource	Resource(s) matching prefetch criteria
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CDSHooksRequest.hook	required	CDSHookType http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksRequest	C	0..*	CDSHooksRequest	Elements defined in Ancestors:extension, hook, hookInstance, fhirServer, fhirAuthorization, context, prefetch Request for decision support Constraints: cds-r-1
extension		0..1	CDSHooksExtensions	Extension
hook	S	1..1	code	Hook event triggering call Binding: CDS Hook Types Value Set (required)
hookInstance	S	1..1	uuid	Unique id for hook invocation When this element is read urn:uuid: is prefixed to the value before validation
fhirServer	S	1..1	url	Location to query for data
fhirAuthorization	SC	1..1	CDSHooksElement	Auth to use in queries Constraints: cds-r-2
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
accessToken	S	1..1	string	Auth token for query header JSON Property Name: access_token
tokenType	S	1..1	code	Bearer JSON Property Name: token_type Fixed Value: Bearer
expiresIn	S	1..1	integer	Seconds token is valid JSON Property Name: expires_in
scope	S	1..1	string	Granted access scopes
subject	S	1..1	string	Patient id for access
patient		0..1	id	OAuth 2.0 client identifier of the CDS Service
context	S	1..1	CDSHookContext	Context for decision support JSON: If%resource.hook = 'appointment-book'then the type is CDSHookAppointmentBookContext JSON: If%resource.hook = 'encounter-start'then the type is CDSHookEncounterStartContext JSON: If%resource.hook = 'encounter-discharge'then the type is CDSHookEncounterDischargeContext JSON: If%resource.hook = 'patient-view'then the type is CDSHookPatientViewContext JSON: If%resource.hook = 'order-dispatch'then the type is CDSHookOrderDispatchContext JSON: If%resource.hook = 'order-sign'then the type is CDSHookOrderSignContext JSON: If%resource.hook = 'order-select'then the type is CDSHookOrderSelectContext
prefetch	S	0..*	Base	Prefetch info requested by server JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
key	S	1..1	code	Key as specfied in server prefetch config
value	S	1..1	Resource	Resource(s) matching prefetch criteria Id may or not be present (this is the default for elements but not resources) JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CDSHooksRequest.hook	required	CDSHookType http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
cds-r-1	error	CDSHooksRequest	if fhirAuthorization details are provided, a fhirServer SHALL be specified : fhirAuthorization.exists() implies fhirServer.exists()
cds-r-2	error	CDSHooksRequest.fhirAuthorization	If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient. : scope.contains('Patient/') implies patient.exists()

This structure is derived from CDSHooksRequest

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Maturity: 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksRequest	C	0..*	CDSHooksRequest	Elements defined in Ancestors:extension, hook, hookInstance, fhirServer, fhirAuthorization, context, prefetch Request for decision support Constraints: cds-r-1
extension		0..1	CDSHooksExtensions	Extension
hook	S	1..1	code	Hook event triggering call Binding: CDS Hook Types Value Set (required)
hookInstance	S	1..1	uuid	Unique id for hook invocation When this element is read urn:uuid: is prefixed to the value before validation
fhirServer	S	1..1	url	Location to query for data
fhirAuthorization	SC	1..1	CDSHooksElement	Auth to use in queries Constraints: cds-r-2
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
accessToken	S	1..1	string	Auth token for query header JSON Property Name: access_token
tokenType	S	1..1	code	Bearer JSON Property Name: token_type Fixed Value: Bearer
expiresIn	S	1..1	integer	Seconds token is valid JSON Property Name: expires_in
scope	S	1..1	string	Granted access scopes
subject	S	1..1	string	Patient id for access
patient		0..1	id	OAuth 2.0 client identifier of the CDS Service
context	S	1..1	CDSHookContext	Context for decision support JSON: If%resource.hook = 'appointment-book'then the type is CDSHookAppointmentBookContext JSON: If%resource.hook = 'encounter-start'then the type is CDSHookEncounterStartContext JSON: If%resource.hook = 'encounter-discharge'then the type is CDSHookEncounterDischargeContext JSON: If%resource.hook = 'patient-view'then the type is CDSHookPatientViewContext JSON: If%resource.hook = 'order-dispatch'then the type is CDSHookOrderDispatchContext JSON: If%resource.hook = 'order-sign'then the type is CDSHookOrderSignContext JSON: If%resource.hook = 'order-select'then the type is CDSHookOrderSelectContext
prefetch	S	0..*	Base	Prefetch info requested by server JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
key	S	1..1	code	Key as specfied in server prefetch config
value	S	1..1	Resource	Resource(s) matching prefetch criteria Id may or not be present (this is the default for elements but not resources) JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CDSHooksRequest.hook	required	CDSHookType http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
cds-r-1	error	CDSHooksRequest	if fhirAuthorization details are provided, a fhirServer SHALL be specified : fhirAuthorization.exists() implies fhirServer.exists()
cds-r-2	error	CDSHooksRequest.fhirAuthorization	If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient. : scope.contains('Patient/') implies patient.exists()

Differential View

This structure is derived from CDSHooksRequest

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksRequest		0..*	CDSHooksRequest	Elements defined in Ancestors:extension, hook, hookInstance, fhirServer, fhirAuthorization, context, prefetch Request for decision support
extension		0..1	CDSHooksExtensions	Extension
hook	S	1..1	code	Hook event triggering call Binding: CDS Hook Types Value Set (required)
hookInstance	S	1..1	uuid	Unique id for hook invocation
fhirServer	S	1..1	url	Location to query for data
fhirAuthorization	S	1..1	CDSHooksElement	Auth to use in queries
accessToken	S	1..1	string	Auth token for query header
tokenType	S	1..1	code	Bearer
expiresIn	S	1..1	integer	Seconds token is valid
scope	S	1..1	string	Granted access scopes
subject	S	1..1	string	Patient id for access
context	S	1..1	CDSHookContext	Context for decision support JSON: If%resource.hook = 'appointment-book'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookAppointmentBookContext JSON: If%resource.hook = 'encounter-start'then the type is http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterStartContext JSON: If%resource.hook = 'encounter-discharge'then the type is http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterDischargeContext JSON: If%resource.hook = 'order-dispatch'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDOrderDispatchContext JSON: If%resource.hook = 'order-select'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext JSON: If%resource.hook = 'order-sign'then the type is http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext
prefetch	S	0..*	Base	Prefetch info requested by server
key	S	1..1	code	Key as specfied in server prefetch config
value	S	1..1	Resource	Resource(s) matching prefetch criteria
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CDSHooksRequest.hook	required	CDSHookType http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksRequest	C	0..*	CDSHooksRequest	Elements defined in Ancestors:extension, hook, hookInstance, fhirServer, fhirAuthorization, context, prefetch Request for decision support Constraints: cds-r-1
extension		0..1	CDSHooksExtensions	Extension
hook	S	1..1	code	Hook event triggering call Binding: CDS Hook Types Value Set (required)
hookInstance	S	1..1	uuid	Unique id for hook invocation When this element is read urn:uuid: is prefixed to the value before validation
fhirServer	S	1..1	url	Location to query for data
fhirAuthorization	SC	1..1	CDSHooksElement	Auth to use in queries Constraints: cds-r-2
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
accessToken	S	1..1	string	Auth token for query header JSON Property Name: access_token
tokenType	S	1..1	code	Bearer JSON Property Name: token_type Fixed Value: Bearer
expiresIn	S	1..1	integer	Seconds token is valid JSON Property Name: expires_in
scope	S	1..1	string	Granted access scopes
subject	S	1..1	string	Patient id for access
patient		0..1	id	OAuth 2.0 client identifier of the CDS Service
context	S	1..1	CDSHookContext	Context for decision support JSON: If%resource.hook = 'appointment-book'then the type is CDSHookAppointmentBookContext JSON: If%resource.hook = 'encounter-start'then the type is CDSHookEncounterStartContext JSON: If%resource.hook = 'encounter-discharge'then the type is CDSHookEncounterDischargeContext JSON: If%resource.hook = 'patient-view'then the type is CDSHookPatientViewContext JSON: If%resource.hook = 'order-dispatch'then the type is CDSHookOrderDispatchContext JSON: If%resource.hook = 'order-sign'then the type is CDSHookOrderSignContext JSON: If%resource.hook = 'order-select'then the type is CDSHookOrderSelectContext
prefetch	S	0..*	Base	Prefetch info requested by server JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
key	S	1..1	code	Key as specfied in server prefetch config
value	S	1..1	Resource	Resource(s) matching prefetch criteria Id may or not be present (this is the default for elements but not resources) JSON: This object can be represented as null in the JSON structure (which counts as 'present' for cardinality purposes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CDSHooksRequest.hook	required	CDSHookType http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
cds-r-1	error	CDSHooksRequest	if fhirAuthorization details are provided, a fhirServer SHALL be specified : fhirAuthorization.exists() implies fhirServer.exists()
cds-r-2	error	CDSHooksRequest.fhirAuthorization	If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient. : scope.contains('Patient/') implies patient.exists()

This structure is derived from CDSHooksRequest

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Maturity: 4

Other representations of profile: CSV, Excel