{
"description": "CDS Hooks describes a \\\"hook\\\"-based pattern for invoking decision support from within a clinician's workflow.",
"_filename": "ImplementationGuide-hl7.fhir.uv.cds-hooks.json",
"package_name": "hl7.fhir.uv.cds-hooks",
"definition": {
"page": {
"page": [ {
"title": "Home",
"nameUrl": "index.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "index.html"
} ],
"generation": "markdown"
}, {
"title": "Change Log",
"nameUrl": "changes.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "changes.html"
} ],
"generation": "markdown"
}, {
"title": "Downloads",
"nameUrl": "downloads.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "downloads.html"
} ],
"generation": "markdown"
} ],
"title": "Table of Contents",
"nameUrl": "toc.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "toc.html"
} ],
"generation": "html"
},
"resource": [ {
"name": "Non-Adherence Reason",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
} ],
"reference": {
"reference": "ValueSet/non-adherence-reason"
},
"description": "A set of codes capturing all reasons why a Patient Care Clinical Decision Support (PC CDS) recommendation may not be followed, drawn from the CDS-NonAdherence-Reason CodeSystem.",
"exampleBoolean": false
}, {
"name": "Non-Adherence Reason Categories ValueSet",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
} ],
"reference": {
"reference": "ValueSet/non-adherence-reason-category"
},
"description": "A set of codes capturing the six high-level categories for why a PC CDS recommendation may not be followed.",
"exampleBoolean": false
}, {
"name": "Non-Adherence Reason Clinical Selection",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
} ],
"reference": {
"reference": "ValueSet/non-adherence-reason-clinical"
},
"description": "A set of common and clinically relevant reasons for non-adherence, including all categories and key specific sub-codes for point-of-care selection.",
"exampleBoolean": false
}, {
"name": "Non-Adherence Reason Codes",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
} ],
"reference": {
"reference": "CodeSystem/non-adherence-reason-codes"
},
"description": "Codes representing reasons why a Patient Care Clinical Decision Support (PC CDS) recommendation may not be followed, categorized by the source of the barrier. The concepts here were originally defined in the AHRQ CDSiC publication [Approaches to Standardizing Override Reasons for Patient-Centered Clinical Decision Support](https://digital.ahrq.gov/sites/default/files/508_SRF%20Level%202%20Override%20Taxonomy%20Implementation%208.28.25.pdf).\n\nNotes: \"Recipient\" means the individual who received the PC CDS, which could be a clinician for clinician-facing PC CDS, or a patient or caregiver for patient-facing PC CDS. \"Recommended action\" refers to the action suggested by the PC CDS. \"Intended action\" refers to the course of action that the PC CDS recipient (clinician, patient, or caregiver) meant to take, and which triggered the PC CDS. *The category \"Patient refuses/declines (no context given)\" is included to acknowledge that override reasons that document patient refusal without providing more information are common in current CDS tools. However, this category is separated from the main taxonomy to indicate that it is not a preferred option; in the future, it would be ideal if PC CDS tools provided more specific patient override reasons.",
"exampleBoolean": false
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "copyrightyear"
}, {
"url": "value",
"valueString": "2019+"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "releaselabel"
}, {
"url": "value",
"valueString": "R3 Normative Ballot"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "excludettl"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "shownav"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "related-ig"
}, {
"url": "value",
"valueString": "module:library=hl7.fhir.uv.cds-hooks-library"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "special-url-base"
}, {
"url": "value",
"valueString": "http://terminology.hl7.org"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "autoload-resources"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-liquid"
}, {
"url": "value",
"valueString": "template/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-liquid"
}, {
"url": "value",
"valueString": "input/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-qa"
}, {
"url": "value",
"valueString": "temp/qa"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-temp"
}, {
"url": "value",
"valueString": "temp/pages"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-output"
}, {
"url": "value",
"valueString": "output"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-suppressed-warnings"
}, {
"url": "value",
"valueString": "input/ignoreWarnings.txt"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-history"
}, {
"url": "value",
"valueString": "http://cds-hooks.hl7.org/history.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "template-html"
}, {
"url": "value",
"valueString": "template-page.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "template-md"
}, {
"url": "value",
"valueString": "template-page-md.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-contact"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-context"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-copyright"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-jurisdiction"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-license"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-publisher"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-version"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-wg"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "active-tables"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "fmm-definition"
}, {
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "propagate-status"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "excludelogbinaryformat"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "tabbed-snapshots"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "i18n-default-lang"
}, {
"url": "value",
"valueString": "en"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "wantGen-ttl"
}, {
"url": "value",
"valueString": "false"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "wantGen-ttl-html"
}, {
"url": "value",
"valueString": "false"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r4#0.8.0"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "copyrightyear"
}, {
"url": "value",
"valueString": "2019+"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "releaselabel"
}, {
"url": "value",
"valueString": "R3 Normative Ballot"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "excludettl"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "shownav"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "related-ig"
}, {
"url": "value",
"valueString": "module:library=hl7.fhir.uv.cds-hooks-library"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "special-url-base"
}, {
"url": "value",
"valueString": "http://terminology.hl7.org"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "autoload-resources"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-liquid"
}, {
"url": "value",
"valueString": "template/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-liquid"
}, {
"url": "value",
"valueString": "input/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-qa"
}, {
"url": "value",
"valueString": "temp/qa"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-temp"
}, {
"url": "value",
"valueString": "temp/pages"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-output"
}, {
"url": "value",
"valueString": "output"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-suppressed-warnings"
}, {
"url": "value",
"valueString": "input/ignoreWarnings.txt"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-history"
}, {
"url": "value",
"valueString": "http://cds-hooks.hl7.org/history.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "template-html"
}, {
"url": "value",
"valueString": "template-page.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "template-md"
}, {
"url": "value",
"valueString": "template-page-md.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-contact"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-context"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-copyright"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-jurisdiction"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-license"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-publisher"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-version"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-wg"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "active-tables"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "fmm-definition"
}, {
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "propagate-status"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "excludelogbinaryformat"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "tabbed-snapshots"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "i18n-default-lang"
}, {
"url": "value",
"valueString": "en"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "wantGen-ttl"
}, {
"url": "value",
"valueString": "false"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "wantGen-ttl-html"
}, {
"url": "value",
"valueString": "false"
} ]
} ],
"parameter": [ {
"code": "path-resource",
"value": "input/capabilities"
}, {
"code": "path-resource",
"value": "input/examples"
}, {
"code": "path-resource",
"value": "input/extensions"
}, {
"code": "path-resource",
"value": "input/models"
}, {
"code": "path-resource",
"value": "input/operations"
}, {
"code": "path-resource",
"value": "input/profiles"
}, {
"code": "path-resource",
"value": "input/resources"
}, {
"code": "path-resource",
"value": "input/vocabulary"
}, {
"code": "path-resource",
"value": "input/maps"
}, {
"code": "path-resource",
"value": "input/testing"
}, {
"code": "path-resource",
"value": "input/history"
}, {
"code": "path-resource",
"value": "fsh-generated/resources"
}, {
"code": "path-pages",
"value": "template/config"
}, {
"code": "path-pages",
"value": "input/assets"
}, {
"code": "path-pages",
"value": "input/images"
}, {
"code": "path-tx-cache",
"value": "input-cache/txcache"
} ]
},
"date": "2025-12-15T23:02:48+11:00",
"publisher": "Clinical Decision Support WG",
"fhirVersion": [ "4.0.1" ],
"license": "CC0-1.0",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"dependsOn": [ {
"id": "hl7tx",
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"version": "7.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
} ],
"packageId": "hl7.terminology.r4"
}, {
"id": "hl7ext",
"uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"version": "5.2.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"
} ],
"packageId": "hl7.fhir.uv.extensions.r4"
} ],
"name": "CDSHooks",
"type": null,
"experimental": null,
"resourceType": "ImplementationGuide",
"title": "CDS Hooks",
"package_version": "3.0.0-ballot",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cds"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 6
}, {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ImplementationGuide.copyrightLabel",
"valueString": "HL7 & Boston Children's Hospital"
} ],
"status": "active",
"language": "en",
"id": "b0f82dfe-a5d8-4460-85cf-2b4e4d69bcf6",
"kind": null,
"url": "http://cds-hooks.hl7.org/ImplementationGuide/hl7.fhir.uv.cds-hooks",
"version": "3.0.0-ballot",
"packageId": "hl7.fhir.uv.cds-hooks",
"contact": [ {
"name": "Clinical Decision Support WG",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/dss/index.cfm",
"system": "url"
}, {
"value": "cds@lists.HL7.org",
"system": "email"
} ]
} ]
}