Shared Health Specification and Guide Version 5.0

 

Shared Health Common Hub

(Requirements Definition)

http://sharedhealth.exchange/fhir/Conformance/conformance-common-hub Published: 2016-06-03 (draft)

Published by: Shared Health

This role defines the base capabilities of the Shared Health message delivery hub that are leveraged by most or all of the Shared Health FHIR services

General

FHIR Version: $ver$
Supported formats: xml

REST behavior

At present, support is limited to the Bundle resource for accepting posted messages supporting querying of those messages.

Security:

Refer to the Shared Health specification

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete
Bundle (Profile) SHALL SHALL SHALL
MessageHeader Yes

General interactions

Name Capability Statement Description
  transaction SHALL

Modes:

Allows submission of a set of multiple deletion requests as part of a single request



Bundle

Interactions

Name Conformance Description
  create SHALL

Allows submitting a message to the inbox

  delete SHALL

Allows removal of a received message from the inbox.

  search-type SHALL

Allows retrieval of waiting messages from the inbox.

Search

Parameter Type Definition & Chaining
message reference

This is only supported for chaining through to event

Chaining: event


MessageHeader

Interactions

Name Description
  search-type

MessageHeader cannot be searched directly, but only by chaining through Bundle

Search

Parameter Type Definition & Chaining
event token
Raw XML


<Conformance xmlns="http://hl7.org/fhir">
  <id value="conformance-common-hub"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Shared Health Common Hub</h2>
      <p>(Requirements Definition)</p>
      <p>http://sharedhealth.exchange/fhir/Conformance/conformance-common-hub Published: 2016-06-03 (draft)</p>
      <p>Published by: <b>Shared Health</b>
      </p>
      <p>This role defines the base capabilities of the Shared Health message delivery hub that are leveraged by most or all of the Shared Health FHIR services</p>
      <h2>General</h2>
      <div class="table-wrapper">
        <table>
          <tbody>
            <tr>
              <th>FHIR Version:</th>
              <td>$ver$</td>
            </tr>
            <tr>
              <th>Supported formats:</th>
              <td>xml</td>
            </tr>
          </tbody>
        </table>
      </div>
      <h2>REST  behavior</h2>
      <p>At present, support is limited to the Bundle resource for accepting posted messages supporting querying of those messages.</p>
      <p>
        <b>Security:</b>
      </p>
      <p>Refer to the Shared Health specification</p>
      <h3>Resource summary</h3>
      <div class="table-wrapper">
        <table class="grid">
          <thead>
            <tr>
              <th>Resource</th>
              <th>Search</th>
              <th>Read</th>
              <th>Read Version</th>
              <th>Instance History</th>
              <th>Resource History</th>
              <th>Create</th>
              <th>Update</th>
              <th>Delete</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>Bundle (<a href="http://sharedhealth.exchange/fhir/StructureDefinition/profile-bundle-message.html">Profile</a>)</th>
              <td>
                <a href="#Bundle-search-type" title="Allows retrieval of waiting messages from the inbox.">SHALL</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td>
                <a href="#Bundle-create" title="Allows submitting a message to the inbox">SHALL</a>
              </td>
              <td/>
              <td>
                <a href="#Bundle-delete" title="Allows removal of a received message from the inbox.">SHALL</a>
              </td>
            </tr>
            <tr>
              <th>MessageHeader</th>
              <td>
                <a href="#MessageHeader-search-type" title="MessageHeader cannot be searched directly, but only by chaining through Bundle">Yes</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>
          </tbody>
        </table>
      </div>
      <h3>General interactions</h3>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Capability Statement</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="-transaction"> </a>
                <span>transaction</span>
              </th>
              <td>SHALL</td>
              <td>
                <p>Modes: </p>
                <p>Allows submission of a set of multiple deletion requests as part of a single request</p>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/2016may/bundle.html">Bundle</a>
      </h3>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Conformance</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="Bundle-create"> </a>
                <span>create</span>
              </th>
              <td>SHALL</td>
              <td>
                <p>Allows submitting a message to the inbox</p>
              </td>
            </tr>
            <tr>
              <th>
                <a name="Bundle-delete"> </a>
                <span>delete</span>
              </th>
              <td>SHALL</td>
              <td>
                <p>Allows removal of a received message from the inbox.</p>
              </td>
            </tr>
            <tr>
              <th>
                <a name="Bundle-search-type"> </a>
                <span>search-type</span>
              </th>
              <td>SHALL</td>
              <td>
                <p>Allows retrieval of waiting messages from the inbox.</p>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
      <h4>Search</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Parameter</th>
              <th>Type</th>
              <th>Definition &amp; Chaining</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>message</th>
              <td>reference</td>
              <td>
                <p>This is only supported for chaining through to event</p>Chaining: event</td>
            </tr>
          </tbody>
        </table>
      </div>
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/2016may/messageheader.html">MessageHeader</a>
      </h3>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="MessageHeader-search-type"> </a>
                <span>search-type</span>
              </th>
              <td>
                <p>MessageHeader cannot be searched directly, but only by chaining through Bundle</p>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
      <h4>Search</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Parameter</th>
              <th>Type</th>
              <th>Definition &amp; Chaining</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>event</th>
              <td>token</td>
              <td/>
            </tr>
          </tbody>
        </table>
      </div>
    </div>
  </text>
  <url
       value="http://sharedhealth.exchange/fhir/Conformance/conformance-common-hub"/>
  <version value="5.0"/>
  <name value="Shared Health Common Hub"/>
  <status value="draft"/>
  <date value="2016-06-03T00:00:00-04:00"/>
  <publisher value="Shared Health"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://sharedhealth.exchange"/>
    </telecom>
  </contact>
  <description
               value="This role defines the base capabilities of the Shared Health message delivery hub that are leveraged by most or all of the Shared Health FHIR services"/>
  <kind value="requirements"/>
  <fhirVersion value="1.4.0"/>
  <acceptUnknown value="extensions"/>
  <format value="xml"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="At present, support is limited to the Bundle resource for accepting posted messages supporting querying of those messages."/>
    <security>
      <description value="Refer to the Shared Health specification"/>
    </security>
    <resource>
      <type value="Bundle"/>
      <profile>
        <reference
                   value="http://sharedhealth.exchange/fhir/StructureDefinition/profile-bundle-message"/>
      </profile>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows submitting a message to the inbox"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="Allows removal of a received message from the inbox."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Allows retrieval of waiting messages from the inbox."/>
      </interaction>
      <searchParam>
        <name value="message"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Bundle-message"/>
        <type value="reference"/>
        <documentation
                       value="This is only supported for chaining through to event"/>
      </searchParam>
    </resource>
    <resource>
      <type value="MessageHeader"/>
      <interaction>
        <code value="search-type"/>
        <documentation
                       value="MessageHeader cannot be searched directly, but only by chaining through Bundle"/>
      </interaction>
      <searchParam>
        <name value="event"/>
        <definition
                    value="http://prescribeit.ca/fhir/SearchParameter/MessageHeader-event"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <code value="transaction"/>
      <documentation
                     value="Allows submission of a set of multiple deletion requests as part of a single request"/>
    </interaction>
  </rest>
</Conformance>