Shared Health Specification and Guide Version 5.0

 

Provider Registry

(Requirements Definition)

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

Published by: Shared Health

This role defines the capabilities of the Provider Registry. The Provider Registry serves as the source of truth for Practitioner information about prescribers as well as Organization information about clinics and pharmacies. The Provider Registry provides read-only access to these records for other systems in the support of electronic message delivery and other healthcare-related communications.

General

FHIR Version: $ver$
Supported formats: xml

REST behavior

At present, support is limited to read-only access to the Organization and Practitioner resources.

Security:

Refer to the PrescribeIT® implementation guide

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete
Organization (Profile) SHALL SHALL (current only)
Practitioner (Profile) SHALL SHALL (current only)


Organization

Interactions

Name Conformance Description
  read SHALL

Allows retrieval of a specific organization (clinic or pharmacy) from the registry

  search-type SHALL

Allows the retrieval of zero or more organizations (clinics/pharmacies) that match specified search criteria and, if desired, associated practitioners

Search

Parameter Conformance Type Definition & Chaining
identifier SHALL token
role SHALL token

Must be present if and only if identifier is not present

address-state SHALL string

Must be present if and only if role is present. Only exact search is supported

address-city SHALL string

Must be present if address-state is present and address-postalcode is not present. Only exact search is supported

address-postalcode SHALL string

Must be present if address-state is present and address-city is not present.

address-line SHALL string

May only be present if address-state is present. Only exact search is supported

name SHALL string

May only be present if address-state is present. Only contains search supported

partof SHALL reference

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

Chaining: name
telecom-phone SHALL string

May only be present if address-state is present. Only exact search is supported

telecom-fax SHALL string

May only be present if address-state is present. Only exact search is supported



Practitioner

Interactions

Name Conformance Description
  read SHALL

Allows retrieval of a specific practitioner (clinic or pharmacy) from the registry

  search-type SHALL

Allows the retrieval of zero or more practitioners that match specified search criteria and, if desired, associated organizations

Search

Supported Includes: Practitioner:organization

Parameter Conformance Type Definition & Chaining
identifier SHALL token
organization SHALL reference

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.

Chaining: address-state, address-city, address-postalcode, address-line
name SHALL string

May only be present if organization is present. Only contains search supported

telecom-phone SHALL string

May only be present if organization is present. Only exact search is supported

telecom-fax SHALL string

May only be present if organization is present. Only exact search is supported

Raw XML


<Conformance xmlns="http://hl7.org/fhir">
  <id value="conformance-tpr"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Provider Registry</h2>
      <p>(Requirements Definition)</p>
      <p>http://sharedhealth.exchange/fhir/Conformance/conformance-tpr Published: 2016-06-03 (draft)</p>
      <p>Published by: <b>Shared Health</b>
      </p>
      <p>This role defines the capabilities of the Provider Registry.  The Provider Registry serves as the source of truth for Practitioner information about prescribers as well as Organization information about clinics and pharmacies.  The Provider Registry provides read-only access to these records for other systems in the support of electronic message delivery and other healthcare-related communications.</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 read-only access to the Organization and Practitioner resources.</p>
      <p>
        <b>Security:</b>
      </p>
      <p>Refer to the PrescribeIT® 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>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">SHALL</a>
              </td>
              <td>(current only)</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">SHALL</a>
              </td>
              <td>(current only)</td>
              <td/>
              <td/>
              <td/>
              <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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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-tpr"/>
  <version value="5.0"/>
  <name value="Provider Registry"/>
  <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 capabilities of the Provider Registry.  The Provider Registry serves as the source of truth for Practitioner information about prescribers as well as Organization information about clinics and pharmacies.  The Provider Registry provides read-only access to these records for other systems in the support of electronic message delivery and other healthcare-related communications."/>
  <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 read-only access to the Organization and Practitioner resources."/>
    <security>
      <description value="Refer to the PrescribeIT® eRx implementation guide"/>
    </security>
    <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="SHALL"/>
        </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>
      <versioning value="no-version"/>
      <readHistory value="false"/>
      <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="SHALL"/>
        </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="SHALL"/>
        </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="SHALL"/>
        </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="SHALL"/>
        </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="SHALL"/>
        </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="SHALL"/>
        </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>
      <versioning value="no-version"/>
      <readHistory value="false"/>
      <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="SHALL"/>
        </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="SHALL"/>
        </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="SHALL"/>
        </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>
  </rest>
</Conformance>