Source | hl7.fhir.uv.tools#current:FHIR Tooling Extensions IG (v5.0.0) |
resourceType | StructureDefinition |
id | CDSHooksServices |
canonical | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksServices |
version | 1.0.0-candidate |
status | draft |
publisher | HL7 International / FHIR Infrastructure |
name | CDSHooksServices |
title | CDSHooks Services Request (Logical Definition) |
date | 2023-09-04T23:06:57+00:00 |
experimental | true |
description | 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 |
jurisdictions | uv |
fhirVersion | 5.0.0 |
kind | logical |
abstract | false |
sdTtype | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksServices |
derivation | specialization |
base | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement |
Usages | (none) |
Name | Flags | Card. | Type |
Description & Constraints
![]() |
---|---|---|---|---|
![]() ![]() |
CDSHooksElement |
The response to the discovery endpoint This logical model cannot be the target of a reference |
||
![]() ![]() ![]() |
0..* | CDSHooksElement |
A list of CDS services |
|
![]() ![]() ![]() ![]() |
1..1 | string | The hook this Services should be invoked on | |
![]() ![]() ![]() ![]() |
0..1 | string | The human-friendly name of this Services (Recommended) | |
![]() ![]() ![]() ![]() |
1..1 | code | The URL to this service which is available at: {baseUrl}/cds-services/{id} | |
![]() ![]() ![]() ![]() |
1..1 | string | The description of this Services | |
![]() ![]() ![]() ![]() |
0..1 | string | Human-friendly description of any preconditions for the use of this CDS Services | |
![]() ![]() ![]() ![]() |
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 |
|
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Key of FHIR query - name for client to use when sending to Services | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of FHIR query - FHIR Query for client to perform | |
![]() |
Produced 08 Sep 2023