Shared Health Specification and Guide Version 3.0 Revision C

<Conformance xmlns="http://hl7.org/fhir">
  <id value="conformance-common-pos"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Shared Health Common Point of Service</h2>
      <p>(Requirements Definition)</p>
      <p>http://sharedhealth.exchange/fhir/Conformance/conformance-common-pos Published: 2016-06-03 (draft)</p>
      <p>Published by: <b>Shared Health</b>
      </p>
      <p>This role defines the base capabilities of Electronic Medical Record Systems (EMRs), Pharmacy Management Systems (PMSs) and other Point of Service    systems that participate in any of the Shared Health FHIR-based 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 posting messages to the inbox and querying messages received together with EMR support.</p>
      <p>
        <b>Security:</b>
      </p>
      <p>Refer to the Shared Health Common Component implementation guide</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>
            <tr>
              <th>Organization (<a href="http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr.html">Profile</a>)</th>
              <td>
                <a href="#Organization-search-type" title="Allows the retrieval of zero or more organizations (clinics/pharmacies) that match specified search criteria and, if desired, associated practitioners">SHALL</a>
              </td>
              <td>
                <a href="#Organization-read" title="Allows retrieval of a specific organization (clinic or pharmacy) from the registry">SHOULD</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>
            <tr>
              <th>Practitioner (<a href="http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-tpr.html">Profile</a>)</th>
              <td>
                <a href="#Practitioner-search-type" title="Allows the retrieval of zero or more practitioners that match specified search criteria and, if desired, associated organizations">SHALL</a>
              </td>
              <td>
                <a href="#Practitioner-read" title="Allows retrieval of a specific practitioner (clinic or pharmacy) from the registry">SHOULD</a>
              </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.  Batch is restricted to POSTs to Bundle.</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>
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/2016may/organization.html">Organization</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="Organization-read"> </a>
                <span>read</span>
              </th>
              <td>SHOULD</td>
              <td>
                <p>Allows retrieval of a specific organization (clinic or pharmacy) from the registry</p>
              </td>
            </tr>
            <tr>
              <th>
                <a name="Organization-search-type"> </a>
                <span>search-type</span>
              </th>
              <td>SHALL</td>
              <td>
                <p>Allows the retrieval of zero or more organizations (clinics/pharmacies) that match specified search criteria and, if desired, associated practitioners</p>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
      <h4>Search</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Parameter</th>
              <th>Conformance</th>
              <th>Type</th>
              <th>Definition &amp; Chaining</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>identifier</th>
              <td>SHALL</td>
              <td>token</td>
              <td/>
            </tr>
            <tr>
              <th>role</th>
              <td>SHALL</td>
              <td>token</td>
              <td>
                <p>Must be present if and only if identifier is not present</p>
              </td>
            </tr>
            <tr>
              <th>address-state</th>
              <td>SHALL</td>
              <td>string</td>
              <td>
                <p>Must be present if and only if role is present.  Only exact search is supported</p>
              </td>
            </tr>
            <tr>
              <th>address-city</th>
              <td>SHALL</td>
              <td>string</td>
              <td>
                <p>Must be present if address-state is present and address-postalcode is not present.  Only exact search is supported</p>
              </td>
            </tr>
            <tr>
              <th>address-postalcode</th>
              <td>SHALL</td>
              <td>string</td>
              <td>
                <p>Must be present if address-state is present and address-city is not present.</p>
              </td>
            </tr>
            <tr>
              <th>address-line</th>
              <td>SHOULD</td>
              <td>string</td>
              <td>
                <p>May only be present if address-state is present.  Only exact search is supported</p>
              </td>
            </tr>
            <tr>
              <th>name</th>
              <td>SHOULD</td>
              <td>string</td>
              <td>
                <p>May only be present if address-state is present.  Only contains search supported</p>
              </td>
            </tr>
            <tr>
              <th>partof</th>
              <td>SHOULD</td>
              <td>reference</td>
              <td>
                <p>May only be present if address-state is present.  Only supports searching on the 'name' chained parameter, which will match on the Reference.display element.  Only contains search supported</p>Chaining: name</td>
            </tr>
            <tr>
              <th>telecom-phone</th>
              <td>SHOULD</td>
              <td>string</td>
              <td>
                <p>May only be present if address-state is present.  Only exact search is supported</p>
              </td>
            </tr>
            <tr>
              <th>telecom-fax</th>
              <td>SHOULD</td>
              <td>string</td>
              <td>
                <p>May only be present if address-state is present.  Only exact search is supported</p>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/2016may/practitioner.html">Practitioner</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="Practitioner-read"> </a>
                <span>read</span>
              </th>
              <td>SHOULD</td>
              <td>
                <p>Allows retrieval of a specific practitioner (clinic or pharmacy) from the registry</p>
              </td>
            </tr>
            <tr>
              <th>
                <a name="Practitioner-search-type"> </a>
                <span>search-type</span>
              </th>
              <td>SHALL</td>
              <td>
                <p>Allows the retrieval of zero or more practitioners that match specified search criteria and, if desired, associated organizations</p>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
      <h4>Search</h4>
      <p>Supported Includes: Practitioner:organization</p>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Parameter</th>
              <th>Conformance</th>
              <th>Type</th>
              <th>Definition &amp; Chaining</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>identifier</th>
              <td>SHALL</td>
              <td>token</td>
              <td/>
            </tr>
            <tr>
              <th>organization</th>
              <td>SHALL</td>
              <td>reference</td>
              <td>
                <p>Must be present if and only if identifier is not present.  If present, chained parameter address-state and one of address-city and address-postalcode must be present.  Only searching by chained parameters are supported.</p>Chaining: address-state, address-city, address-postalcode, address-line</td>
            </tr>
            <tr>
              <th>name</th>
              <td>SHOULD</td>
              <td>string</td>
              <td>
                <p>May only be present if organization is present.  Only contains search supported</p>
              </td>
            </tr>
            <tr>
              <th>telecom-phone</th>
              <td>SHOULD</td>
              <td>string</td>
              <td>
                <p>May only be present if organization is present.  Only exact search is supported</p>
              </td>
            </tr>
            <tr>
              <th>telecom-fax</th>
              <td>SHOULD</td>
              <td>string</td>
              <td>
                <p>May only be present if organization is present.  Only exact search is supported</p>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </div>
  </text>
  <url
       value="http://sharedhealth.exchange/fhir/Conformance/conformance-common-pos"/>
  <version value="3.0 Revision C"/>
  <name value="Shared Health Common Point of Service"/>
  <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 Electronic Medical Record Systems (EMRs), Pharmacy Management Systems (PMSs) and other Point of Service    systems that participate in any of the Shared Health FHIR-based services"/>
  <kind value="requirements"/>
  <fhirVersion value="1.4.0"/>
  <acceptUnknown value="extensions"/>
  <format value="xml"/>
  <rest>
    <mode value="client"/>
    <documentation
                   value="At present, support is limited to the Bundle resource for posting messages to the inbox and querying messages received together with EMR support."/>
    <security>
      <description
                   value="Refer to the Shared Health Common Component implementation guide"/>
    </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>
    <resource>
      <type value="Organization"/>
      <profile>
        <reference
                   value="http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr"/>
      </profile>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Allows retrieval of a specific organization (clinic or pharmacy) from the registry"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Allows the retrieval of zero or more organizations (clinics/pharmacies) that match specified search criteria and, if desired, associated practitioners"/>
      </interaction>
      <searchRevInclude value="Practitioner:organization"/>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Organization-identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="role"/>
        <definition
                    value="http://sharedhealth.exchange/fhir/SearchParameter/sp-organization-type"/>
        <type value="token"/>
        <documentation
                       value="Must be present if and only if identifier is not present"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="address-state"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Organization-address-state"/>
        <type value="string"/>
        <documentation
                       value="Must be present if and only if role is present.  Only exact search is supported"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="address-city"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Organization-address-city"/>
        <type value="string"/>
        <documentation
                       value="Must be present if address-state is present and address-postalcode is not present.  Only exact search is supported"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="address-postalcode"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Organization-address-postalcode"/>
        <type value="string"/>
        <documentation
                       value="Must be present if address-state is present and address-city is not present."/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="address-line"/>
        <definition
                    value="http://sharedhealth.exchange/fhir/SearchParameter/sp-organization-address-line"/>
        <type value="string"/>
        <documentation
                       value="May only be present if address-state is present.  Only exact search is supported"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="name"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Organization-name"/>
        <type value="string"/>
        <documentation
                       value="May only be present if address-state is present.  Only contains search supported"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="partof"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Organization-partof"/>
        <type value="reference"/>
        <documentation
                       value="May only be present if address-state is present.  Only supports searching on the &#39;name&#39; chained parameter, which will match on the Reference.display element.  Only contains search supported"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="telecom-phone"/>
        <definition
                    value="http://sharedhealth.exchange/fhir/SearchParameter/sp-organization-telecom-phone"/>
        <type value="string"/>
        <documentation
                       value="May only be present if address-state is present.  Only exact search is supported"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="telecom-fax"/>
        <definition
                    value="http://sharedhealth.exchange/fhir/SearchParameter/sp-organization-telecom-fax"/>
        <type value="string"/>
        <documentation
                       value="May only be present if address-state is present.  Only exact search is supported"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Practitioner"/>
      <profile>
        <reference
                   value="http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-tpr"/>
      </profile>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Allows retrieval of a specific practitioner (clinic or pharmacy) from the registry"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Allows the retrieval of zero or more practitioners that match specified search criteria and, if desired, associated organizations"/>
      </interaction>
      <searchInclude value="Practitioner:organization"/>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Practitioner-identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="organization"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Practitioner-organization"/>
        <type value="reference"/>
        <documentation
                       value="Must be present if and only if identifier is not present.  If present, chained parameter address-state and one of address-city and address-postalcode must be present.  Only searching by chained parameters are supported."/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="name"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Practitioner-name"/>
        <type value="string"/>
        <documentation
                       value="May only be present if organization is present.  Only contains search supported"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="telecom-phone"/>
        <definition
                    value="http://sharedhealth.exchange/fhir/SearchParameter/sp-practitioner-telecom-phone"/>
        <type value="string"/>
        <documentation
                       value="May only be present if organization is present.  Only exact search is supported"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="telecom-fax"/>
        <definition
                    value="http://sharedhealth.exchange/fhir/SearchParameter/sp-practitioner-telecom-fax"/>
        <type value="string"/>
        <documentation
                       value="May only be present if organization is present.  Only exact search is supported"/>
      </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.  Batch is restricted to POSTs to Bundle."/>
    </interaction>
  </rest>
</Conformance>