Da Vinci Unsolicited Notifications Implementation Guide (Release 0.2.0 STU1 Ballot)

This page is part of the Da Vinci Unsolicited Notifications (v0.2.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

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

Notification Sender CapabilityStatement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.0
  • Supported formats: xml, json
  • Published: 2019-11-26
  • Published by: HL7 International - Infrascture and Messaging Work Group

This CapabilityStatement describes the expected capabilities of a client that is capable of sending a Da Vinci Unsolicited Notification transacted with the $process-message operation.

SHALL Support the Following Implementation Guides:

FHIR RESTful Capabilities

The Da Vinci Notification Sender SHALL:

  1. Support the notification framework defined in this Guide.
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Support json source formats for all Da Vinci Notification interactions.
  4. Declare a CapabilityStatement identifying the scenarios, transactions and profiles supported.

The Da Vinci Notifications Sender SHOULD:

  1. Support the admission/discharge use case defined in this Guide.
  2. Support xml source formats for all Da Vinci Notification interactions.
  3. Identify the Da Vinci 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 Operations

  • SHALL support the $process-message operation.
  • RESTful Capabilities by Resource/Profile:

    Summary of Search Criteria

    Resource TypeSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
    BundleDa Vinci Notifications Bundle Profile
    ConditionDa Vinci Admit/Discharge Notification Condition Profile
    CoverageDa Vinci Admit/Discharge Notification Coverage Profile
    Encounter​Da Vinci Admit/Discharge Notification Encounter Profile
    GraphDefinitionDa Vinci Notifications GraphDefinition Profile
    Location
    MessageDefinitionDa Vinci Notifications MessageDefinition Profile
    MessageHeaderDa Vinci Notifications MessageHeader Profile, Da Vinci Admit Notification MessageHeader Profile, Da Vinci Discharge Notification MessageHeader Profile
    Organization
    Patient
    Practitioner
    PractitionerRole

    Bundle

    Conformance Expectation: SHALL

    Supported Profiles: Da Vinci Notifications Bundle Profile

    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 Bundle resource using:
      GET [base]/Bundle/[id]


    Condition

    Conformance Expectation: SHOULD

    Supported Profiles: Da Vinci Admit/Discharge Notification Condition Profile

    Resource Specific Documentation:

    Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle


    Coverage

    Conformance Expectation: SHOULD

    Supported Profiles: Da Vinci Admit/Discharge Notification Coverage Profile

    Resource Specific Documentation:

    Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle

    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 Coverage resource using:
      GET [base]/Coverage/[id]


    Encounter

    Conformance Expectation: SHOULD

    Supported Profiles: ​Da Vinci Admit/Discharge Notification Encounter Profile

    Resource Specific Documentation:

    Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle


    GraphDefinition

    Conformance Expectation: SHOULD

    Supported Profiles: Da Vinci Notifications GraphDefinition Profile

    Profile Interaction Summary:

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

    Fetch and Search Criteria:

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


    Location

    Conformance Expectation: SHOULD

    Resource Specific Documentation:

    Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle


    MessageDefinition

    Conformance Expectation: SHOULD

    Supported Profiles: Da Vinci Notifications MessageDefinition Profile

    Profile Interaction Summary:

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

    Fetch and Search Criteria:

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


    MessageHeader

    Conformance Expectation: SHALL

    Supported Profiles: Da Vinci Notifications MessageHeader Profile, Da Vinci Admit Notification MessageHeader Profile, Da Vinci Discharge Notification MessageHeader Profile

    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 MessageHeader resource using:
      GET [base]/MessageHeader/[id]


    Organization

    Conformance Expectation: SHOULD

    Resource Specific Documentation:

    Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle


    Patient

    Conformance Expectation: SHOULD

    Resource Specific Documentation:

    Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle


    Practitioner

    Conformance Expectation: SHOULD

    Resource Specific Documentation:

    Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle


    PractitionerRole

    Conformance Expectation: SHOULD

    Resource Specific Documentation:

    Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle