Da Vinci Alerts Implementation Guide (Release 0.1.0 STU1 Ballot)

This page is part of the Da Vinci Unsolicited Notifications (v1.0.0: STU1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Downloads: CapabilityStatement: (XML, JSON),OpenAPI-Swagger Definition file

Alert Initiator CapabilityStatement

  • FHIR Version: 4.0.0
  • Supported formats: xml, json
  • Published: 2019-07-29
  • Published by: HL7 International - Clinical Decision Support Work Group

This CapabilityStatement describes the expected capabilities of a client that is capable of sending an alert by initiating the Da Vinci Notify Operation.

SHALL Support the Following Implementation Guides:

FHIR RESTful Capabilities

The Da Vinci Alerts $notify Initiator SHALL:

  1. Support at least one use case defined in this Guide and listed in the Scenarios Section.
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Support json source formats for all Da Vinci Alert interactions.
  4. Declare a CapabilityStatement identifying the scenarios, transactions and profiles supported.

The Da Vinci Alerts $notify Initiator SHOULD:

  1. Support xml source formats for all Da Vinci Alert interactions.
  2. Identify the Da Vinci Alert or US Core profiles supported as part of the FHIR meta.profile attribute for each instance.

Security:

  1. For general security consideration refer to the Security and Privacy Considerations.
  2. For security considerations specific to this guide refer to the Security page for requirements and recommendations.

Summary of System Wide Interactions

  • MAY support the transaction interaction.
  • MAY support the batch interaction.
  • MAY support the search-system interaction.
  • MAY support the history-system interaction.

    • RESTful Capabilities by Resource/Profile:

    Summary of Search Criteria

    Resource TypeSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
    BundleDa Vinci Alerts Bundle Profile
    CommunicationDa Vinci Alerts Communication Profile $notify
    CoverageHRex Coverage Profile
    EndpointDa Vinci Alerts Endpoint Profile

    Bundle

    Supported Profiles: Da Vinci Alerts Bundle Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHOULD support history-instance.
    • MAY support create, search-type, read, vread, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Client MAY be capable of fetching a Bundle resource using:
      GET [base]/Bundle/[id]

    Communication

    Supported Profiles: Da Vinci Alerts Communication Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHOULD support history-instance.
    • MAY support create, search-type, read, vread, update, patch, delete, history-type.

    Operation Summary:

    • SHALL support the $notify operation

      A server SHALL be capable of invoking the $notify operation to alert the Alert Recipient or Alert Intermediary of a patient event.

      GET [base]/Communication/$notify

    Fetch and Search Criteria:

    • A Client MAY be capable of fetching a Communication resource using:
      GET [base]/Communication/[id]

    Coverage

    Supported Profiles: HRex Coverage Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHOULD support history-instance.
    • MAY support create, search-type, read, vread, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Client MAY be capable of fetching a Coverage resource using:
      GET [base]/Coverage/[id]

    Endpoint

    Supported Profiles: Da Vinci Alerts Endpoint Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • MAY support create, search-type, read, vread, update, patch, delete, history-instance, history-type.

    Fetch and Search Criteria:

    • A Client MAY be capable of fetching a Endpoint resource using:
      GET [base]/Endpoint/[id]