FHIR Tooling Extensions IG
0.7.1 - Release 0.2.0 International flag

This page is part of the HL7 Tools Extension IG (v0.7.1: Release - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 0.8.0. For a full list of available versions, see the Directory of published versions

Logical Model: CDSHooks Services Request (Logical Definition) ( Experimental )

Official URL: http://hl7.org/fhir/tools/StructureDefinition/CDSHooksServices Version: 0.7.1
Standards status: Informative Maturity Level: 1 Computable Name: CDSHooksServices
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.8

This structure is defined to allow the FHIR Validator to validate a CDSHooks Services response body. TODO: This content will be moved to the CDS Hooks specification in the future

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksServices 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... services 0..* CDSHooksElement A list of CDS services
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... hook 1..1 string The hook this Services should be invoked on
.... title 0..1 string The human-friendly name of this Services (Recommended)
.... id 1..1 code The URL to this service which is available at: {baseUrl}/cds-services/{id}
.... description 1..1 string The description of this Services
.... usageRequirements 0..1 string Human-friendly description of any preconditions for the use of this CDS Services
.... prefetch 0..* Base Key/value pairs of FHIR queries the CDS Client provides on each call
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 - name for client to use when sending to Services
..... value 1..1 string Value of FHIR query - FHIR Query for client to perform

doco Documentation for this format

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksServices 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... services 0..* CDSHooksElement A list of CDS services
.... hook 1..1 string The hook this Services should be invoked on
.... title 0..1 string The human-friendly name of this Services (Recommended)
.... id 1..1 code The URL to this service which is available at: {baseUrl}/cds-services/{id}
.... description 1..1 string The description of this Services
.... usageRequirements 0..1 string Human-friendly description of any preconditions for the use of this CDS Services
.... prefetch 0..* Base Key/value pairs of FHIR queries the CDS Client provides on each call
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 - name for client to use when sending to Services
..... value 1..1 string Value of FHIR query - FHIR Query for client to perform

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksServices 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... services 0..* CDSHooksElement A list of CDS services
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... hook 1..1 string The hook this Services should be invoked on
.... title 0..1 string The human-friendly name of this Services (Recommended)
.... id 1..1 code The URL to this service which is available at: {baseUrl}/cds-services/{id}
.... description 1..1 string The description of this Services
.... usageRequirements 0..1 string Human-friendly description of any preconditions for the use of this CDS Services
.... prefetch 0..* Base Key/value pairs of FHIR queries the CDS Client provides on each call
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 - name for client to use when sending to Services
..... value 1..1 string Value of FHIR query - FHIR Query for client to perform

doco Documentation for this format

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(5 nested mandatory elements)

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksServices 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... services 0..* CDSHooksElement A list of CDS services
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... hook 1..1 string The hook this Services should be invoked on
.... title 0..1 string The human-friendly name of this Services (Recommended)
.... id 1..1 code The URL to this service which is available at: {baseUrl}/cds-services/{id}
.... description 1..1 string The description of this Services
.... usageRequirements 0..1 string Human-friendly description of any preconditions for the use of this CDS Services
.... prefetch 0..* Base Key/value pairs of FHIR queries the CDS Client provides on each call
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 - name for client to use when sending to Services
..... value 1..1 string Value of FHIR query - FHIR Query for client to perform

doco Documentation for this format

Differential View

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksServices 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... services 0..* CDSHooksElement A list of CDS services
.... hook 1..1 string The hook this Services should be invoked on
.... title 0..1 string The human-friendly name of this Services (Recommended)
.... id 1..1 code The URL to this service which is available at: {baseUrl}/cds-services/{id}
.... description 1..1 string The description of this Services
.... usageRequirements 0..1 string Human-friendly description of any preconditions for the use of this CDS Services
.... prefetch 0..* Base Key/value pairs of FHIR queries the CDS Client provides on each call
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 - name for client to use when sending to Services
..... value 1..1 string Value of FHIR query - FHIR Query for client to perform

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksServices 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... services 0..* CDSHooksElement A list of CDS services
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... hook 1..1 string The hook this Services should be invoked on
.... title 0..1 string The human-friendly name of this Services (Recommended)
.... id 1..1 code The URL to this service which is available at: {baseUrl}/cds-services/{id}
.... description 1..1 string The description of this Services
.... usageRequirements 0..1 string Human-friendly description of any preconditions for the use of this CDS Services
.... prefetch 0..* Base Key/value pairs of FHIR queries the CDS Client provides on each call
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 - name for client to use when sending to Services
..... value 1..1 string Value of FHIR query - FHIR Query for client to perform

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