Shared Health Specification and Guide Version 5.0

Provider and Location Registry - Introduction

The Provider Registry provides searchable access to practitioners (prescribers) and organizations (clinics and pharmacies). It provides a standard FHIR RESTful interface supporting both read and search capabilities.

Organization and Practitioner reads and queries are executed based upon the context; either PrescribeIT® or SharedHealth (MedDialog). As such, the endpoints for a given record will be different for each. For a given practitioner or organization record, there will be two endpoints and the vendor must select and use the appropriate endpoint depending on the type of query or message. In the messages, references will be the full URL

A summary of their function is found in the table below:

3.56.1 Search Parameters

When performing a search, the requester must specify one or more search criteria to filter the set of organizations that can be returned. The table below summarizes the search parameters that can be used and which resources they can be used for. (Note that parameters sent in the URL must be appropriately escaped.)

There are four types of searches supported: 1) Identifier Search (GET), 2) Discrete Fields Search, 3) Elastic Search, and 4) Bulk Searches (Supporting Periodic Sync of Matched Records and Bulk Update of Unmatched Records)

On a Search response, we return a searchset bundle. If the "_revinclude=Practitioner:organization" parameter is specified then the service should return full Practitioner resources for each of the organizations.

The structure of the Organization Query Response

3.56.1 Group No 1 (identifier search)

For the GET response, you only get one and only one resource. The resource is returned directly not wrapped in a bundle. Details on the response can be found here.

3.56.2 Group No 2 Organization Search - Discrete fields

Startwith Rules*: A "startwith" search will search across each word within the name (eg Organization or Practitioner name) rather than the start of the name as a whole. For example: If searching for a query string = "pharm", the result set would include both "Pharmacy ABC" and "Sue's Pharmacy" because the search tokenizes the names and therefore searches across the words "Pharmacy" and "ABC" in the first instance and "Sue's" and "Pharmacy" in the second instance.

For a Discrete field search, the query may return multiple resources in a searchset bundle. Details on the response can be found here.

3.56.3 Group No 3 Organization Search Elastic

Startwith Rules*: A "startwith" search will search across each word within the name (eg Organization or Practitioner name) rather than the start of the name as a whole. For example: If searching for a query string = "pharm", the result set would include both "Pharmacy ABC" and "Sue's Pharmacy" because the search tokenizes the names and therefore searches across the words "Pharmacy" and "ABC" in the first instance and "Sue's" and "Pharmacy" in the second instance.

For an elastic search, the result may include multiple resources, returned in a searchset bundle. Details on the response can be found here.

Example of search combinations.

Note: you cannot combine exact and contains parameters, you are only allowed one of them.

3.56.4 Group No 4 Bulk TPR Queries

Periodic Sync of Matched Records

Once an EMR has matched a PrescribeIT pharmacy to a local record, the EMR does not typically search TPR for the pharmacy again as the information to communicate to the pharmacy (i.e. CPRID) is held in the local system. This means that the information can get out of sync over time, specifically, the status of the PrescribeIT related services (i.e. PrescribeIT and Clinician Communications). It is important that the clinics have the up to date information so that the system can send the prescription or a message to the pharmacy electronically when possible. In order to assist the EMR's in keeping the information up to date, a new style of TPR query has been introduced for this purpose.

Supported parameters are:

• role=OUTPHARM (required, 1..1)
• identifier (required, 1..*)
• _lastUpdated (optional, 0..1) "gt" is mandatory as this is the only supported date prefix. Example (non-encoded): &_lastUpdated=gt2020-10-01T10:00:00

Example:

POST https://api.sharedhealth.exchange/rest/v1/preconf/THP/TPR_vs1/Organization

Body:

role=OUTPHARM&identifier=35738945,348343000,0303030303,656565656&_lastUpdated=gt2020-10-01T10%3A00%3A00

(non-encoded) role=OUTPHARM&identifier=35738945,348343000,0303030303,656565656&_lastUpdated=gt2020-10-01T10:00:00

Bulk Update of Unmatched Records

For clinics coming onto PrescribeIT initially there is a need to do a bulk search and link of anypharmacies in the local address bookthat are PrescribeIT enabled. In addition, the EMR may implement a method for the user to initiate a Bulk Update in the event they want to do an ad hoc search for possible matches. To determine a match, the EMR will conduct a TPR search using the fax numbers stored in the local address book to see if there is a match in the Provider Registry. If an exact match is found, the CPRID for the pharmacy will be added to the clinic's address book and the EMR will indicate it is PrescribeIT enabled.

The full 10-digit fax number will be sent which will include the area code and number. This is an exact match search and can accommodate an unlimited number of fax numbers in a single request. The request must include which type of organization to search (Organization Type = OUTPHARM).

Supported parameters are:

• role=OUTPHARM (required, 1..1)
• telecom-fax:exact (required, 1..*)

Example:

POST https://api.sharedhealth.exchange/rest/v1/preconf/THP/TPR_vs1/Organization

Body:

role=OUTPHARM&telecom-fax%3Aexact=5555551212,905673435,4162004566