{
  "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",
  "_filename": "StructureDefinition-CDSHooksServices.json",
  "package_name": "hl7.fhir.uv.tools",
  "date": "2024-10-27T07:27:27+11:00",
  "derivation": "specialization",
  "publisher": "HL7 International / FHIR Infrastructure",
  "fhirVersion": "5.0.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "name": "CDSHooksServices",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksServices",
  "experimental": "true",
  "resourceType": "StructureDefinition",
  "title": "CDSHooks Services Request (Logical Definition)",
  "package_version": "0.3.0",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 2
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "fhir"
  } ],
  "snapshot": {
    "element": [ {
      "path": "CDSHooksServices",
      "min": 0,
      "definition": "The response to the discovery endpoint",
      "isModifier": false,
      "short": "The response to the discovery endpoint",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "CDSHooksServices",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      }
    }, {
      "path": "CDSHooksServices.extension",
      "min": 0,
      "definition": "A JSON object that has properties where the names are defined by the extension definitions",
      "short": "Object that has Named Extension Properties",
      "type": [ {
        "code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-extension-style",
        "valueCode": "named-elements"
      } ],
      "max": "1",
      "id": "CDSHooksServices.extension",
      "comment": "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",
      "base": {
        "max": "1",
        "min": 0,
        "path": "CDSHooksElement.extension"
      }
    }, {
      "path": "CDSHooksServices.services",
      "min": 0,
      "definition": "A list of CDS services",
      "short": "A list of CDS services",
      "type": [ {
        "code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
      } ],
      "max": "*",
      "id": "CDSHooksServices.services",
      "comment": "If the CDS server hosts no CDS services, the discovery endpoint should return a 200 HTTP response with an empty array of services",
      "base": {
        "max": "*",
        "min": 0,
        "path": "CDSHooksServices.services"
      }
    }, {
      "path": "CDSHooksServices.services.extension",
      "min": 0,
      "definition": "A JSON object that has properties where the names are defined by the extension definitions",
      "short": "Object that has Named Extension Properties",
      "type": [ {
        "code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-extension-style",
        "valueCode": "named-elements"
      } ],
      "max": "1",
      "id": "CDSHooksServices.services.extension",
      "comment": "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",
      "base": {
        "max": "1",
        "min": 0,
        "path": "CDSHooksElement.extension"
      }
    }, {
      "id": "CDSHooksServices.services.hook",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHooksServices.services.hook"
      },
      "path": "CDSHooksServices.services.hook",
      "type": [ {
        "code": "string"
      } ],
      "short": "The hook this Services should be invoked on",
      "definition": "The hook this Services should be invoked on"
    }, {
      "id": "CDSHooksServices.services.title",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "CDSHooksServices.services.title"
      },
      "path": "CDSHooksServices.services.title",
      "type": [ {
        "code": "string"
      } ],
      "short": "The human-friendly name of this Services (Recommended)",
      "definition": "The human-friendly name of this Services (Recommended)"
    }, {
      "id": "CDSHooksServices.services.id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHooksServices.services.id"
      },
      "path": "CDSHooksServices.services.id",
      "type": [ {
        "code": "code"
      } ],
      "short": "The URL to this service which is available at: {baseUrl}/cds-services/{id}",
      "definition": "The {id} portion of the URL to this service which is available at ```{baseUrl}/cds-services/{id}```"
    }, {
      "id": "CDSHooksServices.services.description",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHooksServices.services.description"
      },
      "path": "CDSHooksServices.services.description",
      "type": [ {
        "code": "string"
      } ],
      "short": "The description of this Services",
      "definition": "The description of this Services"
    }, {
      "id": "CDSHooksServices.services.usageRequirements",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "CDSHooksServices.services.usageRequirements"
      },
      "path": "CDSHooksServices.services.usageRequirements",
      "type": [ {
        "code": "string"
      } ],
      "short": "Human-friendly description of any preconditions for the use of this CDS Services",
      "definition": "Human-friendly description of any preconditions for the use of this CDS Services"
    }, {
      "path": "CDSHooksServices.services.prefetch",
      "min": 0,
      "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",
      "type": [ {
        "code": "Base"
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/json-property-key",
        "valueCode": "key"
      } ],
      "max": "*",
      "id": "CDSHooksServices.services.prefetch",
      "base": {
        "max": "*",
        "min": 0,
        "path": "CDSHooksServices.services.prefetch"
      }
    }, {
      "id": "CDSHooksServices.services.prefetch.key",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHooksServices.services.prefetch.key"
      },
      "path": "CDSHooksServices.services.prefetch.key",
      "type": [ {
        "code": "code"
      } ],
      "short": "Key of FHIR query - name for client to use when sending to Services",
      "definition": "Key of FHIR query - name for client to use when sending to Services"
    }, {
      "id": "CDSHooksServices.services.prefetch.value",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "CDSHooksServices.services.prefetch.value"
      },
      "path": "CDSHooksServices.services.prefetch.value",
      "type": [ {
        "code": "string"
      } ],
      "short": "Value of FHIR query - FHIR Query for client to perform",
      "definition": "Value of FHIR query - FHIR Query for client to perform"
    } ]
  },
  "status": "draft",
  "id": "bf1936d9-5f15-45e2-8aa1-8b2ff30e38aa",
  "kind": "logical",
  "url": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksServices",
  "identifier": [ {
    "value": "urn:oid:2.16.840.1.113883.4.642.40.1.42.8",
    "system": "urn:ietf:rfc:3986"
  } ],
  "version": "0.3.0",
  "differential": {
    "element": [ {
      "id": "CDSHooksServices",
      "path": "CDSHooksServices",
      "short": "The response to the discovery endpoint",
      "definition": "The response to the discovery endpoint"
    }, {
      "id": "CDSHooksServices.services",
      "max": "*",
      "min": 0,
      "path": "CDSHooksServices.services",
      "type": [ {
        "code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
      } ],
      "short": "A list of CDS services",
      "comment": "If the CDS server hosts no CDS services, the discovery endpoint should return a 200 HTTP response with an empty array of services",
      "definition": "A list of CDS services"
    }, {
      "id": "CDSHooksServices.services.hook",
      "max": "1",
      "min": 1,
      "path": "CDSHooksServices.services.hook",
      "type": [ {
        "code": "string"
      } ],
      "short": "The hook this Services should be invoked on",
      "definition": "The hook this Services should be invoked on"
    }, {
      "id": "CDSHooksServices.services.title",
      "max": "1",
      "min": 0,
      "path": "CDSHooksServices.services.title",
      "type": [ {
        "code": "string"
      } ],
      "short": "The human-friendly name of this Services (Recommended)",
      "definition": "The human-friendly name of this Services (Recommended)"
    }, {
      "id": "CDSHooksServices.services.id",
      "max": "1",
      "min": 1,
      "path": "CDSHooksServices.services.id",
      "type": [ {
        "code": "code"
      } ],
      "short": "The URL to this service which is available at: {baseUrl}/cds-services/{id}",
      "definition": "The {id} portion of the URL to this service which is available at ```{baseUrl}/cds-services/{id}```"
    }, {
      "id": "CDSHooksServices.services.description",
      "max": "1",
      "min": 1,
      "path": "CDSHooksServices.services.description",
      "type": [ {
        "code": "string"
      } ],
      "short": "The description of this Services",
      "definition": "The description of this Services"
    }, {
      "id": "CDSHooksServices.services.usageRequirements",
      "max": "1",
      "min": 0,
      "path": "CDSHooksServices.services.usageRequirements",
      "type": [ {
        "code": "string"
      } ],
      "short": "Human-friendly description of any preconditions for the use of this CDS Services",
      "definition": "Human-friendly description of any preconditions for the use of this CDS Services"
    }, {
      "id": "CDSHooksServices.services.prefetch",
      "max": "*",
      "min": 0,
      "path": "CDSHooksServices.services.prefetch",
      "type": [ {
        "code": "Base"
      } ],
      "short": "Key/value pairs of FHIR queries the CDS Client provides on each call",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/json-property-key",
        "valueCode": "key"
      } ],
      "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"
    }, {
      "id": "CDSHooksServices.services.prefetch.key",
      "max": "1",
      "min": 1,
      "path": "CDSHooksServices.services.prefetch.key",
      "type": [ {
        "code": "code"
      } ],
      "short": "Key of FHIR query - name for client to use when sending to Services",
      "definition": "Key of FHIR query - name for client to use when sending to Services"
    }, {
      "id": "CDSHooksServices.services.prefetch.value",
      "max": "1",
      "min": 1,
      "path": "CDSHooksServices.services.prefetch.value",
      "type": [ {
        "code": "string"
      } ],
      "short": "Value of FHIR query - FHIR Query for client to perform",
      "definition": "Value of FHIR query - FHIR Query for client to perform"
    } ]
  },
  "contact": [ {
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fiwg",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}