Da Vinci Unsolicited Notifications
1.1.0-preview - STU1
Da Vinci Unsolicited Notifications
1.1.0-preview - STU1
Da Vinci Unsolicited Notifications, published by HL7 International - Infrastructure and Messaging Work Group. This is not an authorized publication; it is the continuous build for version 1.1.0-preview). This version is based on the current content of https://github.com/HL7/davinci-alerts/ and changes regularly. See the Directory of published versions
| Active as of 2020-09-14 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="notification-forwarder"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Notification Forwarder CapabilityStatement</h2><ul><li>Implementation Guide Version: 1.0.0</li><li>FHIR Version: 4.0.1</li><li>Supported formats: xml, json</li><li>Published: 2020-09-14</li><li>Published by: HL7 International - Infrastructure and Messaging Work Group</li></ul><p>This CapabilityStatement describes the expected capabilities of a Da Vinci Intermediary when forwarding Unsolicited Notifications transacted with the <code>$process-message</code> in the client mode.</p><h3 id="igs" class="no_toc">SHALL Support the Following Implementation Guides:</h3><ul><li><a href="http%3A//hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core%7C3.1.1">http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1</a></li></ul><h3 id="behavior">FHIR RESTful Capabilities</h3><p>The Da Vinci Notification Intermediary <strong>SHALL</strong>:</p><ol><li>Support the notification framework defined in this Guide for the Intermediary forwarding notifications.</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Support json source formats for all Da Vinci Notification interactions.</li><li>Declare a CapabilityStatement identifying the scenarios, transactions and profiles supported.</li></ol><p>The Da Vinci Notifications Intermediary <strong>SHOULD</strong>:</p><ol><li>Support the admission/discharge use case defined in this Guide.</li><li>Support xml source formats for all Da Vinci Notification interactions.</li><li>Identify the Da Vinci or US Core profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li></ol><p id="security"><strong>Security:</strong></p><ol><li>For general security consideration refer to the <a href="http://build.fhir.org/secpriv-module.html">Security and Privacy Considerations</a>.</li><li>For security considerations specific to this guide refer to the <a href="security.html">Security</a> page for requirements and recommendations.</li></ol><p><strong>Summary of System Wide Operations</strong></p><li><strong>SHALL</strong> support the <a href="http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"><code>$process-message</code></a> operation.</li><h3 id="resource--details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class="grid"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href="#bundle">Bundle</a></td><td><a href="StructureDefinition-notifications-bundle.html">Da Vinci Notifications Bundle Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#condition">Condition</a></td><td><a href="StructureDefinition-adt-notification-condition.html">Da Vinci Admit/Transfer/Discharge Notification Condition Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#coverage">Coverage</a></td><td><a href="StructureDefinition-adt-notification-coverage.html">Da Vinci Admit/Transfer/Discharge Notification Coverage Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#encounter">Encounter</a></td><td><a href="StructureDefinition-adt-notification-encounter.html">Da Vinci Admit/Transfer/Discharge Notification Encounter Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#location">Location</a></td><td><a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-location">US Core Location Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#messageheader">MessageHeader</a></td><td><a href="StructureDefinition-notifications-messageheader.html">Da Vinci Notifications MessageHeader Profile</a>,
<a href="StructureDefinition-admit-notification-messageheader.html">Da Vinci Admit Notification MessageHeader Profile</a>,
<a href="StructureDefinition-transfer-notification-messageheader.html">Da Vinci Transfer Notification MessageHeader Profile</a>,
<a href="StructureDefinition-discharge-notification-messageheader.html">Da Vinci Discharge Notification MessageHeader Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#organization">Organization</a></td><td><a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization">US Core Organization Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#patient">Patient</a></td><td><a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient">US Core Patient Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#practitioner">Practitioner</a></td><td><a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner">US Core Practitioner Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#practitionerrole">PractitionerRole</a></td><td><a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole">US Core PractitionerRole Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#provenance">Provenance</a></td><td><a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance">US Core Provenance Profile</a></td><td>
</td><td>
</td><td>
</td><td>
</td></tr></tbody></table><br></br><h4 id="bundle" class="no_toc">Bundle</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="StructureDefinition-notifications-bundle.html">Da Vinci Notifications Bundle Profile</a>
</p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a Bundle resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Bundle/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="condition" class="no_toc">Condition</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="StructureDefinition-adt-notification-condition.html">Da Vinci Admit/Transfer/Discharge Notification Condition Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a Condition resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Condition/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="coverage" class="no_toc">Coverage</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="StructureDefinition-adt-notification-coverage.html">Da Vinci Admit/Transfer/Discharge Notification Coverage Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a Coverage resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Coverage/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="encounter" class="no_toc">Encounter</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="StructureDefinition-adt-notification-encounter.html">Da Vinci Admit/Transfer/Discharge Notification Encounter Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a Encounter resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Encounter/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="location" class="no_toc">Location</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-location">US Core Location Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a Location resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Location/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="messageheader" class="no_toc">MessageHeader</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="StructureDefinition-notifications-messageheader.html">Da Vinci Notifications MessageHeader Profile</a>,
<a href="StructureDefinition-admit-notification-messageheader.html">Da Vinci Admit Notification MessageHeader Profile</a>,
<a href="StructureDefinition-transfer-notification-messageheader.html">Da Vinci Transfer Notification MessageHeader Profile</a>,
<a href="StructureDefinition-discharge-notification-messageheader.html">Da Vinci Discharge Notification MessageHeader Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Forwarding notifications using the Da Vinci Unsolicited Notifications framework is a point to point FHIR RESTful transaction. The intermediary <strong>SHALL</strong> always modify the MessageHeader as described below and <strong>MAY</strong> change the other contents of the bundle per agreement between the Intermediary and Sender or Receiver. When forwarding the notification, the Intermediary <strong>SHALL</strong>:</p><ol><li>Create a new message bundle with a new <code>Bundle.id</code> and new<code>MessageHeader.id</code></li><li>Update the <code>MessageHeader.sender</code> to reflect the Intermediary as the new Sender</li><li>Replace the resource in the Bundle with the resource referenced by the updated <code>MessageHeader.sender</code> element.</li><li>Update the <code>MessageHeader.destination</code> to reflect the new Recipient/Intermediary.</li></ol></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a MessageHeader resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/MessageHeader/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="organization" class="no_toc">Organization</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization">US Core Organization Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a Organization resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Organization/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="patient" class="no_toc">Patient</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient">US Core Patient Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a Patient resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Patient/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="practitioner" class="no_toc">Practitioner</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner">US Core Practitioner Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a Practitioner resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Practitioner/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="practitionerrole" class="no_toc">PractitionerRole</h4><p>Conformance Expectation: <strong>SHOULD</strong></p><p>Supported Profiles:
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole">US Core PractitionerRole Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>Required resource type to carry information regarding admission and discharge event in the Da Vinci Notification message bundle</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support
<code>create</code>,
<code>search-type</code>,
<code>read</code>,
<code>vread</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>MAY</strong> be capable of fetching a PractitionerRole resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/PractitionerRole/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><h4 id="provenance" class="no_toc">Provenance</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance">US Core Provenance Profile</a>
</p><p>Resource Specific Documentation:</p><blockquote><p>The Provenance resource is required to record changes to the Vinci Notification message bundle when forwarding the notification. The Intermediary <strong>SHALL</strong> add a <a href="https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-provenance.html">US Core Provenance Profile</a> to the message bundle. The <code>Provenance.target</code> references the MessageHeader and following the guidance provided in <a href="https://www.hl7.org/fhir/us/core/basic-provenance.html#hie-redistribution">Basic Provenance for HIE Redistribution and Transformation</a>:</p><ul><li><code>Provenance.agent.type</code> = "author" set to the Sender</li><li>If <em>no</em> change to the bundle contents:
<code>Provenance.agent.type</code> = "transmitter" set to the Intermediary</li><li>If changes to the bundle contents:
<code>Provenance.agent.type</code> = "assembler" set to the Intermediary</li></ul></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support
<code>search-type</code>,
<code>read</code>,
<code>vread</code>.</li><li><strong>MAY</strong> support
<code>create</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-instance</code>,
<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Client <strong>SHOULD</strong> be capable of fetching a Provenance resource using:
<br></br>
<code class="highlighter-rouge">GET [base]/Provenance/[id]</code>
</li><br></br> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr></hr><br></br></div>
</text>
<url
value="http://hl7.org/fhir/us/davinci-alerts/CapabilityStatement/notification-forwarder"/>
<version value="1.1.0-preview"/>
<name value="NotificationForwarderCapabilityStatement"/>
<title value="Notification Forwarder CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2020-09-14"/>
<publisher
value="HL7 International - Infrastructure and Messaging Work Group"/>
<contact>
<name
value="HL7 International - Infrastructure and Messaging Work Group"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/inm"/>
</telecom>
<telecom>
<system value="email"/>
<value value="inm@lists.hl7.org"/>
</telecom>
</contact>
<description
value="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 value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<copyright
value="Used by permission of HL7 International, all rights reserved Creative Commons License"/>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<patchFormat value="application/json-patch+json"/>
<implementationGuide
value="http://hl7.org/fhir/us/davinci-alerts/ImplementationGuide/hl7.fhir.us.davinci-alerts|1.0.0"/>
<implementationGuide
value="http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1"/>
<rest>
<mode value="client"/>
<documentation
value="The Da Vinci Notification Intermediary **SHALL**:
1. Support the notification framework defined in this Guide for the Intermediary forwarding notifications.
1. Implement the RESTful behavior according to the FHIR specification.
1. Support json source formats for all Da Vinci Notification interactions.
1. 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.
1. Support xml source formats for all Da Vinci Notification interactions.
1. Identify the Da Vinci or US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance."/>
<security>
<description
value="1. For general security consideration refer to the [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html).
1. For security considerations specific to this guide refer to the [Security](security.html) page for requirements and recommendations.
"/>
</security>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Bundle"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/notifications-bundle"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Condition"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/adt-notification-condition"/>
<documentation
value="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 value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Coverage"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/adt-notification-coverage"/>
<documentation
value="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 value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Encounter"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/adt-notification-encounter"/>
<documentation
value="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 value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Location"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"/>
<documentation
value="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 value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="MessageHeader"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/notifications-messageheader"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/admit-notification-messageheader"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/transfer-notification-messageheader"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/discharge-notification-messageheader"/>
<documentation
value="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 new`MessageHeader.id`
1. Update the `MessageHeader.sender` to reflect the Intermediary as the new Sender
1. Replace the resource in the Bundle with the resource referenced by the updated `MessageHeader.sender` element.
1. Update the `MessageHeader.destination` to reflect the new Recipient/Intermediary."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Organization"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"/>
<documentation
value="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 value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Patient"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/>
<documentation
value="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 value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Practitioner"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"/>
<documentation
value="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 value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="PractitionerRole"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"/>
<documentation
value="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 value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Provenance"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"/>
<documentation
value="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):
- `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"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
</resource>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="process-message"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"/>
</operation>
</rest>
</CapabilityStatement>
IG © 2023+ HL7 International - Infrastructure and Messaging Work Group. Package hl7.fhir.us.davinci-alerts#1.1.0-preview based on FHIR 4.0.1. Generated 2023-05-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change