CDS Hooks
3.0.0 - R3 Normative/Trial-Use International flag

CDS Hooks, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cds-hooks/ and changes regularly. See the Directory of published versions

Logical Model: CDSHooks Discovery Response (Logical Definition)

Official URL: http://cds-hooks.hl7.org/StructureDefinition/CDSHooksServices Version: 3.0.0
Standards status: Informative Maturity Level: 1 Computable Name: CDSHooksServices
Other Identifiers: OID:2.16.840.1.113883.4.642.40.93.42.7

This structure is defined to allow the FHIR Validator to validate a CDSHooks Discovery response body.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksServices 0..* CDSHooksElement The response to the discovery endpoint

Elements defined in Ancestors:extension
CDSHooksServices.services 0..* CDSHooksElement An array of CDS Services
JSON: The type of this element is inferred from the JSON type in the instance
CDSHooksServices.services.hook 1..1 string The hook this service should be invoked on
CDSHooksServices.services.title 0..1 string The human-friendly name of this service
CDSHooksServices.services.description 1..1 markdown The description of this service
CDSHooksServices.services.id 1..1 string The {id} portion of the URL to this service
CDSHooksServices.services.prefetch 0..* Base Key/value pairs of FHIR queries to provide when calling
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
CDSHooksServices.services.prefetch.key 1..1 code Key of FHIR query
CDSHooksServices.services.prefetch.value 1..1 string FHIR query template
CDSHooksServices.services.usageRequirements 0..1 string Human-friendly preconditions for the use of this CDS Service
CDSHooksServices.services.version 0..1 string CDS Hooks specification version implemented
CDSHooksServices.services.hookVersion 0..1 string Hook version implemented

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksServices 0..* CDSHooksElement The response to the discovery endpoint

Elements defined in Ancestors:extension
CDSHooksServices.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksServices.services 0..* CDSHooksElement An array of CDS Services
JSON: The type of this element is inferred from the JSON type in the instance
CDSHooksServices.services.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksServices.services.hook 1..1 string The hook this service should be invoked on
CDSHooksServices.services.title 0..1 string The human-friendly name of this service
CDSHooksServices.services.description 1..1 markdown The description of this service
CDSHooksServices.services.id 1..1 string The {id} portion of the URL to this service
CDSHooksServices.services.prefetch 0..* Base Key/value pairs of FHIR queries to provide when calling
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
CDSHooksServices.services.prefetch.key 1..1 code Key of FHIR query
CDSHooksServices.services.prefetch.value 1..1 string FHIR query template
CDSHooksServices.services.usageRequirements 0..1 string Human-friendly preconditions for the use of this CDS Service
CDSHooksServices.services.version 0..1 string CDS Hooks specification version implemented
CDSHooksServices.services.hookVersion 0..1 string Hook version implemented

doco Documentation for this format

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(5 nested mandatory elements)

Maturity: 1

Differential View

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksServices 0..* CDSHooksElement The response to the discovery endpoint

Elements defined in Ancestors:extension
CDSHooksServices.services 0..* CDSHooksElement An array of CDS Services
JSON: The type of this element is inferred from the JSON type in the instance
CDSHooksServices.services.hook 1..1 string The hook this service should be invoked on
CDSHooksServices.services.title 0..1 string The human-friendly name of this service
CDSHooksServices.services.description 1..1 markdown The description of this service
CDSHooksServices.services.id 1..1 string The {id} portion of the URL to this service
CDSHooksServices.services.prefetch 0..* Base Key/value pairs of FHIR queries to provide when calling
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
CDSHooksServices.services.prefetch.key 1..1 code Key of FHIR query
CDSHooksServices.services.prefetch.value 1..1 string FHIR query template
CDSHooksServices.services.usageRequirements 0..1 string Human-friendly preconditions for the use of this CDS Service
CDSHooksServices.services.version 0..1 string CDS Hooks specification version implemented
CDSHooksServices.services.hookVersion 0..1 string Hook version implemented

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksServices 0..* CDSHooksElement The response to the discovery endpoint

Elements defined in Ancestors:extension
CDSHooksServices.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksServices.services 0..* CDSHooksElement An array of CDS Services
JSON: The type of this element is inferred from the JSON type in the instance
CDSHooksServices.services.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksServices.services.hook 1..1 string The hook this service should be invoked on
CDSHooksServices.services.title 0..1 string The human-friendly name of this service
CDSHooksServices.services.description 1..1 markdown The description of this service
CDSHooksServices.services.id 1..1 string The {id} portion of the URL to this service
CDSHooksServices.services.prefetch 0..* Base Key/value pairs of FHIR queries to provide when calling
JSON: Represented as a single JSON Object with named properties using the value of the key child as the key
CDSHooksServices.services.prefetch.key 1..1 code Key of FHIR query
CDSHooksServices.services.prefetch.value 1..1 string FHIR query template
CDSHooksServices.services.usageRequirements 0..1 string Human-friendly preconditions for the use of this CDS Service
CDSHooksServices.services.version 0..1 string CDS Hooks specification version implemented
CDSHooksServices.services.hookVersion 0..1 string Hook version implemented

doco Documentation for this format

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(5 nested mandatory elements)

Maturity: 1

 

Other representations of profile: CSV, Excel