FHIR Chat · docs / Issue #290 clarify that new, required fields in ho... · cds hooks/github

Stream: cds hooks/github

Topic: docs / Issue #290 clarify that new, required fields in ho...

Github Notifications (Aug 06 2018 at 16:10):

isaacvetter edited Issue #290(assigned to isaacvetter)

## May 2018 Ballot Comment 84

Submitted by @cmoesel from MITRE

Chapter: Hooks
Section: Hook version
Type: NEG :exclamation:
In Person Requested? No

Existing Wording:

Addition of a new field to the context - Minor

Proposed Wording:

Addition of a new REQUIRED field to the context - Major
Addition of a new OPTIONAL field to the context - Minor

Comment:
While adding a context field is backwards-compatible from the perspective of CDS services, it is not necessarily backwards-compatible from the perspective of the EHR, particularly if the new field is REQUIRED.

Consider a hook for which the REQUIRED context field "foo" is added in v1.1 (minor update). If a service implements against v1.1 of the hook, they expect the "foo" to always be provided -- but if the EHR is implemented against v1.0 of the hook, this will not be the case -- and the service will be broken.

---

_This issue was imported by @cds-hooks-bot from the consolidated CDS Hooks May 2018 ballot spreadsheet._

Github Notifications (Aug 09 2018 at 14:12):

kpshek closed Issue #290

Last updated: Apr 12 2022 at 19:14 UTC