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'
package_name: hl7.fhir.uv.tools.r5
derivation: specialization
name: CDSHooksServices
type: http://hl7.org/fhir/tools/StructureDefinition/CDSHooksServices
elements:
  services:
    type: http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
    short: A list of CDS services
    array: true
    index: 0
    elements:
      hook: {type: string, short: The hook this Services should be invoked on, index: 1}
      title: {type: string, short: The human-friendly name of this Services (Recommended), index: 2}
      id: {type: code, short: 'The URL to this service which is available at: {baseUrl}/cds-services/{id}', index: 3}
      description: {type: string, short: The description of this Services, index: 4}
      usageRequirements: {type: string, short: Human-friendly description of any preconditions for the use of this CDS Services, index: 5}
      prefetch:
        type: Base
        short: Key/value pairs of FHIR queries the CDS Client provides on each call
        array: true
        index: 6
        elements:
          key: {type: code, short: Key of FHIR query - name for client to use when sending to Services, index: 7}
          value: {type: string, short: Value of FHIR query - FHIR Query for client to perform, index: 8}
        required: [key, value]
    required: [id, hook, description]
package_version: 0.4.0
class: logical
kind: logical
url: http://hl7.org/fhir/tools/StructureDefinition/CDSHooksServices
base: http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
version: 0.4.0