Skip to content

Commit dc767a2

Browse files
committed
#500: Renamed 1.0 to current and added 1.0 link to the published specification on HL7.org
1 parent efc5ce3 commit dc767a2

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs/specification/1.0.md renamed to docs/specification/current.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![CDS Hooks Overview](../images/logo.png)
22

3-
!!! info "1.0 Release"
3+
!!! info "Current Build"
44
This is the continuous integration, community release of the CDS Hooks specification. All stable releases are available at [https://cds-hooks.hl7.org](https://cds-hooks.hl7.org).
55

66
## Overview
@@ -21,7 +21,7 @@ decision support from within a clinician's workflow. The API supports:
2121

2222
* Synchronous, workflow-triggered CDS calls returning information and suggestions
2323
* Launching a user-facing SMART app when CDS requires additional interaction
24-
24+
2525
The basic components of CDS Hooks are:
2626

2727
* **CDS Service** A decision support service that accepts requests containing patient information, and provides responses
@@ -228,7 +228,7 @@ It is the CDS Service's responsibility to check prefetched data against its temp
228228

229229
#### Prefetch tokens
230230

231-
A prefetch token is a placeholder in a prefetch template that is replaced by a value from the hook's context to construct the FHIR URL used to request the prefetch data.
231+
A prefetch token is a placeholder in a prefetch template that is replaced by a value from the hook's context to construct the FHIR URL used to request the prefetch data.
232232

233233
Prefetch tokens MUST be delimited by `{{` and `}}`, and MUST contain only the qualified path to a hook context field.
234234

@@ -772,7 +772,7 @@ As another example, an extension defined on the discovery response could look li
772772

773773
### Overview
774774

775-
As a specification, CDS Hooks does not prescribe a default or required set of hooks for implementers. Rather, the set of hooks defined here are merely a set of common use cases that were used to aid in the creation of CDS Hooks. The set of hooks defined here are not a closed set; anyone is able to define new hooks to fit their use cases and propose those hooks to the community. New hooks are proposed in a prescribed [format](#hook-definition-format) using the [documentation template](../hooks/template) by submitting a [pull request](https://github.com/cds-hooks/docs/tree/master/docs/hooks). Hooks are [versioned](#changes-to-the-definition-of-a-hook-hook-versioning), and mature according to the [Hook Maturity Model](#hook-maturity-model).
775+
As a specification, CDS Hooks does not prescribe a default or required set of hooks for implementers. Rather, the set of hooks defined here are merely a set of common use cases that were used to aid in the creation of CDS Hooks. The set of hooks defined here are not a closed set; anyone is able to define new hooks to fit their use cases and propose those hooks to the community. New hooks are proposed in a prescribed [format](#hook-definition-format) using the [documentation template](../hooks/template) by submitting a [pull request](https://github.com/cds-hooks/docs/tree/master/docs/hooks). Hooks are [versioned](#changes-to-the-definition-of-a-hook-hook-versioning), and mature according to the [Hook Maturity Model](#hook-maturity-model).
776776

777777
Note that each hook (e.g. `medication-prescribe`) represents something the user is doing in the CDS Client and multiple CDS Services might respond to the same hook (e.g. a "price check" service and a "prior authorization" service might both respond to `medication-prescribe`).
778778

@@ -847,9 +847,9 @@ Field | Optionality | Prefetch Token | Type | Description
847847

848848
For context fields that may contain multiple FHIR resources, the field SHOULD be defined as a FHIR Bundle, rather than as an array of FHIR resources. For example, multiple FHIR resources are necessary to describe all of the orders under review in the `order-review` hook's `orders` field. Hook definitions SHOULD prefer the use of FHIR Bundles over other bespoke data structures.
849849

850-
Often, context is populated with in-progress or in-memory data that may not yet be available from the FHIR server. For example, imagine a hook, `medication-order` that is invoked when a user selects a medication durating an order workflow. The context data for this hook would contain draft FHIR resources representing the medications that have been selected for ordering. In this case, the CDS Client should only provide these draft resources and not the full set of orders available from its FHIR server. The CDS service MAY pre-fetch or query for FHIR resources with other statuses.
850+
Often, context is populated with in-progress or in-memory data that may not yet be available from the FHIR server. For example, imagine a hook, `medication-order` that is invoked when a user selects a medication durating an order workflow. The context data for this hook would contain draft FHIR resources representing the medications that have been selected for ordering. In this case, the CDS Client should only provide these draft resources and not the full set of orders available from its FHIR server. The CDS service MAY pre-fetch or query for FHIR resources with other statuses.
851851

852-
All FHIR resources in context MUST be based on the same FHIR version.
852+
All FHIR resources in context MUST be based on the same FHIR version.
853853

854854
#### Examples
855855

@@ -870,15 +870,15 @@ Hook creators SHOULD include examples of the context.
870870
If the context contains FHIR data, hook creators SHOULD include examples across multiple versions of FHIR if differences across FHIR versions are possible.
871871

872872
### Hook Maturity Model
873-
The intent of the CDS Hooks Maturity Model is to attain broad community engagement and consensus, before a hook is labeled as mature, that the hook is necessary, implementable, and worthwhile to the CDS services and CDS clients that would reasonably be expected to use it. Implementer feedback should drive the maturity of new hooks. Diverse participation in open developer forums and events, such as HL7 FHIR Connectathons, is necessary to achieve significant implementer feedback. The below criteria will be evaluated with these goals in mind.
873+
The intent of the CDS Hooks Maturity Model is to attain broad community engagement and consensus, before a hook is labeled as mature, that the hook is necessary, implementable, and worthwhile to the CDS services and CDS clients that would reasonably be expected to use it. Implementer feedback should drive the maturity of new hooks. Diverse participation in open developer forums and events, such as HL7 FHIR Connectathons, is necessary to achieve significant implementer feedback. The below criteria will be evaluated with these goals in mind.
874874

875875
Hook maturity | 3 - Considered
876876

877-
The Hook maturity levels use the term CDS client to generically refer to the clinical workflow system in which a CDS services returned cards are displayed.
877+
The Hook maturity levels use the term CDS client to generically refer to the clinical workflow system in which a CDS services returned cards are displayed.
878878

879879
Maturity Level | Maturity title | Requirements
880880
--- | --- | ---
881-
0 | Draft | Hook is defined according to the [hook definition format](#hook-definition-format).
881+
0 | Draft | Hook is defined according to the [hook definition format](#hook-definition-format).
882882
1 | Submitted | _The above, and …_ Hook definition is written up as a [github pull request](https://github.com/cds-hooks/docs/tree/master/docs/hooks) using the [Hook template](hooks/template/) and community feedback is solicited on the [zulip CDS Hooks stream](https://chat.fhir.org/#narrow/stream/17-cds-hooks).
883883
2 | Tested | _The above, and …_ The hook has been tested and successfully supports interoperability among at least one CDS client and two independent CDS services using semi-realistic data and scenarios (e.g. at a FHIR Connectathon). The github pull request defining the hook is approved and published by the CDS Hooks Project Management Committee.
884884
3 | Considered | _The above, and …_ At least 3 distinct organizations recorded ten distinct implementer comments (including a github issue, tracker item, or comment on the hook definition page), including at least two CDS clients and three independent CDS services. The hook has been tested at two connectathons.
@@ -930,7 +930,7 @@ When a major change is made, the hook definition MUST be published under a new n
930930
> Note that the intent of this table is to outline possible breaking changes. The authors have attempted to enumerate these types of changes exhaustively, but as new types of breaking changes are identified, this list will be updated.
931931
932932
#### Hook Maturity
933-
As each hook progresses through a process of being defined, tested, implemented, used in production environments, and balloted, the hook's formal maturity level increases. Each hook has its own maturity level, which MUST be defined in the hook's definition and correspond to the [Hook Maturity Model](#hook-maturity-model).
933+
As each hook progresses through a process of being defined, tested, implemented, used in production environments, and balloted, the hook's formal maturity level increases. Each hook has its own maturity level, which MUST be defined in the hook's definition and correspond to the [Hook Maturity Model](#hook-maturity-model).
934934

935935
hookMaturity | 0 - Draft
936936

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ extra:
1313
nav:
1414
- Overview: 'index.md'
1515
- Specification:
16-
- '1.0': 'specification/1.0.md'
16+
- Current: 'specification/current.md'
17+
- '1.0 (External Link)': https://cds-hooks.hl7.org/1.0/
1718
- Hooks:
1819
- 'new-hook-template' : 'hooks/template.md'
1920
- 'patient-view 4' : 'hooks/patient-view.md'

0 commit comments

Comments
 (0)