Notification Forwarder CapabilityStatement

• Implementation Guide Version: 1.0.0
• FHIR Version: 4.0.1
• Supported formats: xml, json
• Published: 2020-09-14
• Published by: HL7 International - Infrastructure and Messaging Work Group

This CapabilityStatement describes the expected capabilities of a Da Vinci Intermediary when forwarding Unsolicited Notifications transacted with the $process-message in the client mode.

SHALL Support the Following Implementation Guides:

• http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1

FHIR RESTful Capabilities

The Da Vinci Notification Intermediary SHALL:

1. Support the notification framework defined in this Guide for the Intermediary forwarding notifications.
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 Intermediary 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

RESTful Capabilities by Resource/Profile:

Summary of Search Criteria

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: SHALL

Supported Profiles: Da Vinci Admit/Transfer/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

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

Coverage

Conformance Expectation: SHALL

Supported Profiles: Da Vinci Admit/Transfer/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: SHALL

Supported Profiles: ​Da Vinci Admit/Transfer/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

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

Location

Conformance Expectation: SHALL

Supported Profiles: US Core Location 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 Location resource using:
  GET [base]/Location/[id]

MessageHeader

Conformance Expectation: SHALL

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

Resource Specific Documentation:

Forwarding notifications using the Da Vinci Unsolicited Notifications framework is a point to point FHIR RESTful transaction. The intermediary SHALL always modify the MessageHeader as described below and MAY change the other contents of the bundle per agreement between the Intermediary and Sender or Receiver. When forwarding the notification, the Intermediary SHALL:

1. Create a new message bundle with a new Bundle.id and newMessageHeader.id
2. Update the MessageHeader.sender to reflect the Intermediary as the new Sender
3. Replace the resource in the Bundle with the resource referenced by the updated MessageHeader.sender element.
4. Update the MessageHeader.destination to reflect the new Recipient/Intermediary.

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: SHALL

Supported Profiles: US Core Organization 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 Organization resource using:
  GET [base]/Organization/[id]

Patient

Conformance Expectation: SHALL

Supported Profiles: US Core Patient 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 Patient resource using:
  GET [base]/Patient/[id]

Practitioner

Conformance Expectation: SHALL

Supported Profiles: US Core Practitioner 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 Practitioner resource using:
  GET [base]/Practitioner/[id]

PractitionerRole

Conformance Expectation: SHOULD

Supported Profiles: US Core PractitionerRole 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 PractitionerRole resource using:
  GET [base]/PractitionerRole/[id]

Provenance

Conformance Expectation: SHALL

Supported Profiles: US Core Provenance Profile

Resource Specific Documentation:

The Provenance resource is required to record changes to the Vinci Notification message bundle when forwarding the notification. The Intermediary SHALL add a US Core Provenance Profile to the message bundle. The Provenance.target references the MessageHeader and following the guidance provided in Basic Provenance for HIE Redistribution and Transformation:

• Provenance.agent.type = "author" set to the Sender
• If no change to the bundle contents: Provenance.agent.type = "transmitter" set to the Intermediary
• If changes to the bundle contents: Provenance.agent.type = "assembler" set to the Intermediary

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