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

Stream: cds hooks/github

Topic: docs / Issue #74 CDS Hooks Services Version

Github Notifications (Aug 02 2017 at 17:02):

bkaney opened 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",
      "version": "1.0.0"
    }
  ]
}

Github Notifications (Aug 03 2017 at 18:07):

kpshek commented on Issue #74

@bkaney - Can you elaborate on why you think this would be valuable?

For instance, we don't define this today with SMART apps. If a CDS Service is offered as software as a service (SaaS), and every company I've talked to is working under this model, then I'm not sure why version needs to be exposed.

If the CDS Service provider wants to explicitly version its services, this would be best put in the id field.

For instance, in your above example the CDS Service would be available at https://example.com/static-patient-greeter. So, when you version it to 2.0 it's still at the same URL. If your intention is to allow the EHR to make a purposeful decision to move to 2.0 then you'd want the URL to change too. So, the id could be static-patient-greeter-2.0 making the URL https://example.com/static-patient-greeter-2.0

Thoughts?

Github Notifications (Aug 04 2017 at 13:09):

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"
    }
  ]
}

Github Notifications (Aug 04 2017 at 13:10):

bkaney commented on Issue #74

I see the confusion. It's not about the cds service version, it's the CDS Hooks version the service conforms to. My example is misleading, so I updated it.

Last updated: Apr 12 2022 at 19:14 UTC