Package | hl7.fhir.us.davinci-alerts |
Type | CapabilityStatement |
Id | notification-forwarder |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/davinci-alerts/https://build.fhir.org/ig/HL7/davinci-alerts/CapabilityStatement-notification-forwarder.html |
URL | http://hl7.org/fhir/us/davinci-alerts/CapabilityStatement/notification-forwarder |
Version | 1.1.0 |
Status | active |
Date | 2024-12-06T17:35:39.140594-08:00 |
Name | NotificationForwarderCapabilityStatement |
Title | Notification Forwarder CapabilityStatement |
Realm | us |
Authority | hl7 |
Description | This CapabilityStatement describes the expected capabilities of a Da Vinci Intermediary when forwarding Unsolicited Notifications transacted with the `$process-message` in the client mode. |
Copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
Kind | requirements |
No resources found
CapabilityStatement | |
us-core-client | US Core Client CapabilityStatement |
ImplementationGuide | |
hl7.fhir.us.davinci-hrex | Da Vinci Health Record Exchange (HRex) |
hl7.fhir.us.core | US Core Implementation Guide |
StructureDefinition | |
admit-notification-messageheader | Da Vinci Admit Notification MessageHeader Profile |
adt-notification-condition | Da Vinci Admit/Discharge/Transfer Notification Condition Profile |
adt-notification-coverage | Da Vinci Admit/Discharge/Transfer Notification Coverage Profile |
adt-notification-encounter | Da Vinci Admit/Discharge/Transfer Notification Encounter Profile |
discharge-notification-messageheader | Da Vinci Discharge Notification MessageHeader Profile |
notifications-bundle | Da Vinci Notifications Bundle Profile |
notifications-messageheader | Da Vinci Notifications MessageHeader Profile |
transfer-notification-messageheader | Da Vinci Transfer Notification MessageHeader Profile |
us-core-location | US Core Location Profile |
us-core-organization | US Core Organization Profile |
us-core-patient | US Core Patient Profile |
us-core-practitioner | US Core Practitioner Profile |
us-core-practitionerrole | US Core PractitionerRole Profile |
us-core-provenance | US Core Provenance Profile |
Note: links and images are rebased to the (stated) source
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]
{ "resourceType": "CapabilityStatement", "id": "notification-forwarder", "text": { "status": "additional", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "inm" } ], "url": "http://hl7.org/fhir/us/davinci-alerts/CapabilityStatement/notification-forwarder", "version": "1.1.0", "name": "NotificationForwarderCapabilityStatement", "title": "Notification Forwarder CapabilityStatement", "status": "active", "experimental": false, "date": "2024-12-06T17:35:39.140594-08:00", "publisher": "HL7 International / Infrastructure And Messaging", "contact": [ { "name": "HL7 International / Infrastructure And Messaging", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/inm" }, { "system": "email", "value": "inm@lists.hl7.org" } ] } ], "description": "This CapabilityStatement describes the expected capabilities of a Da Vinci Intermediary when forwarding Unsolicited Notifications transacted with the `$process-message` in the client mode.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US" } ] } ], "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License", "kind": "requirements", "instantiates": [ "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|3.1.1", "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|6.1.0", "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|7.0.0" ], "_instantiates": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] } ], "fhirVersion": "4.0.1", "format": [ "json", "xml" ], "_format": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "implementationGuide": [ "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1", "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|6.1.0", "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|7.0.0", "http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex|1.1.0" ], "_implementationGuide": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] } ], "rest": [ { "mode": "client", "documentation": "The Da Vinci Notification Intermediary **SHALL**:\n\n1. Support the notification framework defined in this Guide for the Intermediary forwarding notifications.\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Support json source formats for all Da Vinci Notification interactions.\n1. Declare a CapabilityStatement identifying the scenarios, transactions and profiles supported.\n\nThe Da Vinci Notifications Intermediary **SHOULD**:\n\n1. Support the admission/discharge use case defined in this Guide.\n1. Support xml source formats for all Da Vinci Notification interactions.\n1. Identify the Da Vinci or US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance.", "security": { "description": "1. For general security consideration refer to the [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). \n1. For security considerations specific to this guide refer to the [Privacy, Safety, and Security](security.html) page for requirements and recommendations.\n" }, "resource": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Bundle", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/notifications-bundle|1.1.0" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Condition", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/adt-notification-condition|1.1.0" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Coverage", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/adt-notification-coverage|1.1.0" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Encounter", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/adt-notification-encounter|1.1.0" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Location", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "MessageHeader", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/notifications-messageheader|1.1.0", "http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/admit-notification-messageheader|1.1.0", "http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/transfer-notification-messageheader|1.1.0", "http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/discharge-notification-messageheader|1.1.0" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "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**:\n\n1. Create a new message bundle with a new `Bundle.id` and new`MessageHeader.id`\n1. Update the `MessageHeader.sender` to reflect the Intermediary as the new Sender\n1. Replace the resource in the Bundle with the resource referenced by the updated `MessageHeader.sender` element.\n1. Update the `MessageHeader.destination` to reflect the new Recipient/Intermediary.", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Organization", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Patient", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Practitioner", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "type": "PractitionerRole", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Provenance", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "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](https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-provenance.html) to the message bundle. The `Provenance.target` references the MessageHeader and following the guidance provided in [Basic Provenance for HIE Redistribution and Transformation](https://www.hl7.org/fhir/us/core/basic-provenance.html#hie-redistribution):\n\n- `Provenance.agent.type` = \"author\" set to the Sender\n- If *no* change to the bundle contents:\n `Provenance.agent.type` = \"transmitter\" set to the Intermediary\n- If changes to the bundle contents:\n `Provenance.agent.type` = \"assembler\" set to the Intermediary", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "vread" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "patch" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "delete" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-instance" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "history-type" } ] } ], "operation": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "process-message", "definition": "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message", "documentation": "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**:\n\n1. Create a new message bundle with a new `Bundle.id` and new `MessageHeader.id`\n1. Update the `MessageHeader.sender` to reflect the Intermediary as the new Sender\n1. Update the `MessageHeader.destination.url` elements to reflect the new Recipient/Intermediary.\n1. 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].\n - `Provenance.agent.type` = \"author\" set to the Sender\n - If *no* change to the bundle contents:\n\n `Provenance.agent.type` = \"transmitter\" set to the Intermediary\n - If changes to the bundle contents:\n\n `Provenance.agent.type` = \"assembler\" set to the Intermediary" } ] } ] }