Da Vinci Unsolicited Notifications, published by HL7 International / Infrastructure And Messaging. This guide is not an authorized publication; it is the continuous build for version 1.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-alerts/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-alerts/CapabilityStatement/notification-forwarder | Version: 1.1.0-preview | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: NotificationForwarderCapabilityStatement | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.47.13.1 | ||||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
This CapabilityStatement describes the expected capabilities of a Da Vinci Intermediary when forwarding Unsolicited Notifications transacted with the $process-message
in the client mode.
Raw OpenAPI-Swagger Definition file | Download
The Da Vinci Notification Intermediary SHALL:
The Da Vinci Notifications Intermediary SHOULD:
meta.profile
attribute for each instance.Security:
Summary of System Wide Operations
$process-message
operation.The Intermediary SHALL notify the Recipient or Intermediary using the $process-message operation.Forwarding notifications using this 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:
- Create a new message bundle with a new
Bundle.id
and newMessageHeader.id
- Update the
MessageHeader.sender
to reflect the Intermediary as the new Sender- Update the
MessageHeader.destination.url
elements to reflect the new Recipient/Intermediary.- Add a [US Core Provenance Profile] with
Provenance.target
pointing to MessageHeader and using the guidance provided in [Basic Provenance for HIE Redistribution and Transformation].
Provenance.agent.type
= "author" set to the SenderIf no change to the bundle contents:
Provenance.agent.type
= "transmitter" set to the IntermediaryIf changes to the bundle contents:
Provenance.agent.type
= "assembler" set to the Intermediary
Resource Type | Supported Profiles | Supported Searches | Supported _includes | Supported _revincludes | Supported Operations |
---|---|---|---|---|---|
Bundle | Da Vinci Notifications Bundle Profile | - | - | - | - |
Condition | Da Vinci Admit/Transfer/Discharge Notification Condition Profile | - | - | - | - |
Coverage | Da Vinci Admit/Transfer/Discharge Notification Coverage Profile | - | - | - | - |
Encounter | Da Vinci Admit/Transfer/Discharge Notification Encounter Profile | - | - | - | - |
Location | US Core Location Profile | - | - | - | - |
MessageHeader | Da Vinci Notifications MessageHeader Profile, Da Vinci Admit Notification MessageHeader Profile, Da Vinci Transfer Notification MessageHeader Profile, Da Vinci Discharge Notification MessageHeader Profile | - | - | - | - |
Organization | US Core Organization Profile | - | - | - | - |
Patient | US Core Patient Profile | - | - | - | - |
Practitioner | US Core Practitioner Profile | - | - | - | - |
PractitionerRole | US Core PractitionerRole Profile | - | - | - | - |
Provenance | US Core Provenance Profile | - | - | - | - |
Conformance Expectation: SHALL
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Bundle/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Condition/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Coverage/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Encounter/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Location/[id]
Conformance Expectation: SHALL
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:
- Create a new message bundle with a new
Bundle.id
and newMessageHeader.id
- Update the
MessageHeader.sender
to reflect the Intermediary as the new Sender- Replace the resource in the Bundle with the resource referenced by the updated
MessageHeader.sender
element.- Update the
MessageHeader.destination
to reflect the new Recipient/Intermediary.
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/MessageHeader/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Organization/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Patient/[id]
Conformance Expectation: SHALL
Resource Specific Documentation:
Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Practitioner/[id]
Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle
Supported Profiles:
Profile Interaction Summary:
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/PractitionerRole/[id]
Conformance Expectation: SHALL
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
Supported Profiles:
Profile Interaction Summary:
search-type
, read
, vread
.create
, update
, patch
, delete
, history-instance
, history-type
.Fetch and Search Criteria:
GET [base]/Provenance/[id]