CDS Hooks
3.0.0-ballot - R3 Normative Ballot International flag

CDS Hooks, published by Clinical Decision Support WG. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot 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) ( Experimental )

Official URL: http://cds-hooks.hl7.org/StructureDefinition/CDSHooksServices Version: 3.0.0-ballot
Standards status: Informative Computable Name: CDSHooksServices

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 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
.. CDSHooksServices 0..* CDSHooksElement The response to the discovery endpoint

Elements defined in Ancestors:extension
... services 0..* CDSHooksElement An array of CDS Services
JSON: The type of this element is inferred from the JSON type in the instance
.... hook 1..1 string The hook this service should be invoked on
.... title 0..1 string The human-friendly name of this service
.... description 1..1 string The description of this service
.... id 1..1 string The {id} portion of the URL to this service
.... 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
..... key 1..1 code Key of FHIR query
..... value 1..1 string FHIR query template
.... usageRequirements 0..1 string Human-friendly preconditions for the use of this CDS Service
.... version 0..1 string CDS Hooks specification version implemented

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

Elements defined in Ancestors:extension
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... services 0..* CDSHooksElement An array of CDS Services
JSON: The type of this element is inferred from the JSON type in the instance
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... hook 1..1 string The hook this service should be invoked on
.... title 0..1 string The human-friendly name of this service
.... description 1..1 string The description of this service
.... id 1..1 string The {id} portion of the URL to this service
.... 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
..... key 1..1 code Key of FHIR query
..... value 1..1 string FHIR query template
.... usageRequirements 0..1 string Human-friendly preconditions for the use of this CDS Service
.... version 0..1 string CDS Hooks specification version implemented

doco Documentation for this format

Summary

Mandatory: 0 element(5 nested mandatory elements)

Differential View

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

Elements defined in Ancestors:extension
... services 0..* CDSHooksElement An array of CDS Services
JSON: The type of this element is inferred from the JSON type in the instance
.... hook 1..1 string The hook this service should be invoked on
.... title 0..1 string The human-friendly name of this service
.... description 1..1 string The description of this service
.... id 1..1 string The {id} portion of the URL to this service
.... 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
..... key 1..1 code Key of FHIR query
..... value 1..1 string FHIR query template
.... usageRequirements 0..1 string Human-friendly preconditions for the use of this CDS Service
.... version 0..1 string CDS Hooks specification version implemented

doco Documentation for this format

Snapshot ViewView

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

Elements defined in Ancestors:extension
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... services 0..* CDSHooksElement An array of CDS Services
JSON: The type of this element is inferred from the JSON type in the instance
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... hook 1..1 string The hook this service should be invoked on
.... title 0..1 string The human-friendly name of this service
.... description 1..1 string The description of this service
.... id 1..1 string The {id} portion of the URL to this service
.... 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
..... key 1..1 code Key of FHIR query
..... value 1..1 string FHIR query template
.... usageRequirements 0..1 string Human-friendly preconditions for the use of this CDS Service
.... version 0..1 string CDS Hooks specification version implemented

doco Documentation for this format

Summary

Mandatory: 0 element(5 nested mandatory elements)

 

Other representations of profile: CSV, Excel