FHIR Tooling Extensions IG
0.4.1 - Release 0.2.0
FHIR Tooling Extensions IG
0.4.1 - Release 0.2.0
This page is part of the HL7 Tools Extension IG (v0.4.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
| Page standards status: Informative | Maturity Level: 1 |
Definitions for the CDSHooksServices logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. CDSHooksServices | |
| Definition | The response to the discovery endpoint Base definition for all types defined in FHIR type system. |
| Short | The response to the discovery endpointBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHooksServices.extension | |
| Definition | A JSON object that has properties where the names are defined by the extension definitions |
| Short | Object that has Named Extension Properties |
| Comments | Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined |
| Control | 0..1 |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions |
| Extension Style | This element can be extended by named JSON elements |
| 4. CDSHooksServices.services | |
| Definition | A list of CDS services |
| Short | A list of CDS services |
| Comments | If the CDS server hosts no CDS services, the discovery endpoint should return a 200 HTTP response with an empty array of services |
| Control | 0..* |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement |
| 6. CDSHooksServices.services.extension | |
| Definition | A JSON object that has properties where the names are defined by the extension definitions |
| Short | Object that has Named Extension Properties |
| Comments | Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined |
| Control | 0..1 |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions |
| Extension Style | This element can be extended by named JSON elements |
| 8. CDSHooksServices.services.hook | |
| Definition | The hook this Services should be invoked on |
| Short | The hook this Services should be invoked on |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CDSHooksServices.services.title | |
| Definition | The human-friendly name of this Services (Recommended) |
| Short | The human-friendly name of this Services (Recommended) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. CDSHooksServices.services.id | |
| Definition | The {id} portion of the URL to this service which is available at |
| Short | The URL to this service which is available at: {baseUrl}/cds-services/{id} |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. CDSHooksServices.services.description | |
| Definition | The description of this Services |
| Short | The description of this Services |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. CDSHooksServices.services.usageRequirements | |
| Definition | Human-friendly description of any preconditions for the use of this CDS Services |
| Short | Human-friendly description of any preconditions for the use of this CDS Services |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. CDSHooksServices.services.prefetch | |
| Definition | An object containing key/value pairs of FHIR queries that this Services is requesting the CDS Client to perform and provide on each Services call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query |
| Short | Key/value pairs of FHIR queries the CDS Client provides on each call |
| Control | 0..* |
| Type | Base |
| JSON Format | This repeating object is represented as a single JSON object with named properties. The name of the property (key) is the value of thekey child |
| 20. CDSHooksServices.services.prefetch.key | |
| Definition | Key of FHIR query - name for client to use when sending to Services |
| Short | Key of FHIR query - name for client to use when sending to Services |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. CDSHooksServices.services.prefetch.value | |
| Definition | Value of FHIR query - FHIR Query for client to perform |
| Short | Value of FHIR query - FHIR Query for client to perform |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. CDSHooksServices | |
| Definition | The response to the discovery endpoint |
| Short | The response to the discovery endpoint |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHooksServices.services | |
| Definition | A list of CDS services |
| Short | A list of CDS services |
| Comments | If the CDS server hosts no CDS services, the discovery endpoint should return a 200 HTTP response with an empty array of services |
| Control | 0..* |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement |
| 4. CDSHooksServices.services.hook | |
| Definition | The hook this Services should be invoked on |
| Short | The hook this Services should be invoked on |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CDSHooksServices.services.title | |
| Definition | The human-friendly name of this Services (Recommended) |
| Short | The human-friendly name of this Services (Recommended) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CDSHooksServices.services.id | |
| Definition | The {id} portion of the URL to this service which is available at |
| Short | The URL to this service which is available at: {baseUrl}/cds-services/{id} |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CDSHooksServices.services.description | |
| Definition | The description of this Services |
| Short | The description of this Services |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. CDSHooksServices.services.usageRequirements | |
| Definition | Human-friendly description of any preconditions for the use of this CDS Services |
| Short | Human-friendly description of any preconditions for the use of this CDS Services |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. CDSHooksServices.services.prefetch | |
| Definition | An object containing key/value pairs of FHIR queries that this Services is requesting the CDS Client to perform and provide on each Services call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query |
| Short | Key/value pairs of FHIR queries the CDS Client provides on each call |
| Control | 0..* |
| Type | Base |
| JSON Format | This repeating object is represented as a single JSON object with named properties. The name of the property (key) is the value of thekey child |
| 16. CDSHooksServices.services.prefetch.key | |
| Definition | Key of FHIR query - name for client to use when sending to Services |
| Short | Key of FHIR query - name for client to use when sending to Services |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. CDSHooksServices.services.prefetch.value | |
| Definition | Value of FHIR query - FHIR Query for client to perform |
| Short | Value of FHIR query - FHIR Query for client to perform |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. CDSHooksServices | |
| Definition | The response to the discovery endpoint |
| Short | The response to the discovery endpoint |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CDSHooksServices.extension | |
| Definition | A JSON object that has properties where the names are defined by the extension definitions |
| Short | Object that has Named Extension Properties |
| Comments | Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined |
| Control | 0..1 |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions |
| Extension Style | This element can be extended by named JSON elements |
| 4. CDSHooksServices.services | |
| Definition | A list of CDS services |
| Short | A list of CDS services |
| Comments | If the CDS server hosts no CDS services, the discovery endpoint should return a 200 HTTP response with an empty array of services |
| Control | 0..* |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement |
| 6. CDSHooksServices.services.extension | |
| Definition | A JSON object that has properties where the names are defined by the extension definitions |
| Short | Object that has Named Extension Properties |
| Comments | Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined |
| Control | 0..1 |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions |
| Extension Style | This element can be extended by named JSON elements |
| 8. CDSHooksServices.services.hook | |
| Definition | The hook this Services should be invoked on |
| Short | The hook this Services should be invoked on |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CDSHooksServices.services.title | |
| Definition | The human-friendly name of this Services (Recommended) |
| Short | The human-friendly name of this Services (Recommended) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. CDSHooksServices.services.id | |
| Definition | The {id} portion of the URL to this service which is available at |
| Short | The URL to this service which is available at: {baseUrl}/cds-services/{id} |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. CDSHooksServices.services.description | |
| Definition | The description of this Services |
| Short | The description of this Services |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. CDSHooksServices.services.usageRequirements | |
| Definition | Human-friendly description of any preconditions for the use of this CDS Services |
| Short | Human-friendly description of any preconditions for the use of this CDS Services |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. CDSHooksServices.services.prefetch | |
| Definition | An object containing key/value pairs of FHIR queries that this Services is requesting the CDS Client to perform and provide on each Services call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query |
| Short | Key/value pairs of FHIR queries the CDS Client provides on each call |
| Control | 0..* |
| Type | Base |
| JSON Format | This repeating object is represented as a single JSON object with named properties. The name of the property (key) is the value of thekey child |
| 20. CDSHooksServices.services.prefetch.key | |
| Definition | Key of FHIR query - name for client to use when sending to Services |
| Short | Key of FHIR query - name for client to use when sending to Services |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. CDSHooksServices.services.prefetch.value | |
| Definition | Value of FHIR query - FHIR Query for client to perform |
| Short | Value of FHIR query - FHIR Query for client to perform |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.tools#0.4.1 based on FHIR 5.0.0. Generated 2025-03-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change