FHIR Chat · docs / Issue #74 CDS Hooks Version · cds hooks/github

Stream: cds hooks/github

Topic: docs / Issue #74 CDS Hooks Version

view this post on Zulip Github Notifications (Mar 21 2018 at 17:36):

bkaney edited Issue #74

Are there any thoughts on how to advertise/handle the CDS Hooks service version?

This could be handled as part of the service discovery -- e.g. include the version as an attribute in the cds-services payload.

{
  "services": [
    {
      "hook": "patient-view",
      "title": "Static CDS Service Example",
      "description": "An example of a CDS service that returns a static set of cards",
      "id": "static-patient-greeter",
      "cds-hooks-version": "1.0.0"
    }
  ]
}

view this post on Zulip Github Notifications (Mar 26 2018 at 06:00):

kpshek commented on Issue #74

Some options I can imagine:

  • The CDS Service definition returned from the Discovery call contains the CDS Hooks specification version supported
  • Every call made by the EHR contains the CDS Hooks specification version. This allows the CDS Service to respond accordingly (for instance, perhaps the Discovery response flexes to only return CDS Services that can handle the particular CDS Hooks specification version in use).

Furthermore, I'll echo @olbrich's suggestion of a new JSON field or HTTP header are both options to communicate the specification version.

My proposal is that we do not address this today. We only need to address this once we introduce a new version of the CDS Hooks specification in which the CDS Service needs to change its behavior based upon the specification version in use. If we introduce a new specification version that contains breaking or other changes which necessitate its communication, we can simply add this per the above options. The absence of this version information just means we're dealing with pre-specification versions in which this information doesn't matter (eg, 1.0).

If the community is OK with this proposal, we'd close this issue and simply re-open it if we end up needing to address this due to a future specification change.

Last updated: Apr 12 2022 at 19:14 UTC


An HL7 Website -