Provider Organization Search (SPO)


This is a business transaction that is used by external systems to request and receive summary information from the Ontario Provincial Provider Registry (PPR), about provider organizations.

Depending on the parameter item values used and the data entitlement of the user type, the length and breadth of those query parameter values and query response values will vary. However, the nature of the interaction between the sending and receiving systems remain the same.

The interaction between the requesting and responding systems are depicted in a sequence diagram below. In addition, the full complement of data items that can be returned to the requester is also listed in a table on the following page.


Message Type

PRPM_IN996010ON

Category

Query

Standard

HL7V3



Interactions

Scenario Details:

User or System requests the retrieval of provider summary information, using specific pre-defined combinations of provider organization data items as query parameters.The acceptable combinations of parameter items constitute search types as listed above.

 

 1.  A ‘Provider Organization Search Query Request (PRPM_IN996000ON)’ message is sent via the HIAL to the provider registry system.  

 2.  A ‘Provider Organization Search Query Response (PRPM_IN996100ON)’ message is sent from the provincial provider registry system to the User / System application, with a list of matching organization summary records. The list contains the full complement of summary information deemed entitled to be received by the User or System


Mandatory fields:

1.  Search by name:

- Organization Name

- Municipality

2.  Search by alternate id:

- Alternate ID Source

- Alternate ID

Message Flow:

1.  Search Provider Organization Query Sample (PRPM_IN996000ON)– Full complement of parameter items

 

Query Parameter Item

Sample Value

Representation in a message

alternateIdentifier

22338899

<v3:alternateIdentifier>

<v3:value extension="22338899" root="2.16.840.1.113883.3.239.13.36"/>

</v3:alternateIdentifier>

Address (municipalityName, postal code, address line)

Mississauga

<v3:address>

                  <v3:value><v3:city></Mississauga</v3:city></</v3:value>

</v3:address>            

organizationActiveIndicator code

Active

<v3:organizationActiveIndicator>

                  <v3:value code="active"/>

</v3:organizationActiveIndicator>

providerLHIN code

6

<v3:providerLHIN>

                  <v3:value>6</v3:value>

</v3:providerLHIN>

providerOrganizationID

102444556778

<v3:providerOrganizationID>

<v3:value extension="102444556778" root="2.16.840.1.113883.3.239.9 "/>

</v3:providerOrganizationD>

providerOrganizationName

GoodHealth Diabetes Clinic

<v3:providerOrganizationName>                                                       <v3:value>GoodHealth Diabetes Clinic</v3:value>

</v3:providerOrganizationName>

providerOrganizationRole code

HOS

<v3:providerOrganizationRole>

<v3:value code="HOS" codeSystem="2.16.840.1.113883.3.239.5.17"/>

</v3:providerorganizationRole>

searchOption code

1, 2, 3, 4, 5

<v3:searchOption>

<v3:value code="1" codeSystem="2.16.840.1.113883.3.239.5.18 "/>

</v3:searchOption>

languageOption code

eng          

<v3:languageOptionCode>

<v3:value code="eng " codeSystem="1.0.639.2"/>

</v3:languageOptionCode>

 

2.  Provider Organization Search Query Response (PRPM_IN996100ON)– Full Complement of Data Elements

 

Data Element name

- UPI

- Alternate Identifier Type

- Alternate Identifier

- Alternate Identifier Origin code

- Multiple Alternate Identifier Indicator

- Organization Name

- Organization Operational Status Code

- Organization Role Class code

- Organization Status Code (Active/Inactive Indicator)

- Organization Site ID

- Organization Site Address

- Organization Site Telephone

- Organization Site Fax

- Organization Site Address LHIN Code

- Organization Site Address LHIN Name

 

 For the full details on these interactions, please refer to our full PPR Standards documentation


Sample Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <S:Header>
  <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">75eca3e6-b19d-434c-9f3f-51fc8472565f</wsa:MessageID>
  <wsa:ReplyTo xmlns:wsa="http://www.w3.org/2005/08/addressing">
   <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>
  </wsa:ReplyTo>
  <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">ProviderRegistry/SearchForProviderOrganization/V4</wsa:Action>
  <wsa:To xmlns:wsa="http://www.w3.org/2005/08/addressing">http://lite.innovation-lab.ca:7102/ppr</wsa:To>
 </S:Header>
 <S:Body>
  <ns2:searchForProviderOrganizationByIDRequest xsi:schemaLocation="http://ehealth.gov.on.ca/ProviderService ..\ProviderService.xsd" xmlns:ns2="http://ehealth.gov.on.ca/ProviderService" xmlns:v3="urn:hl7-org:v3">
   <v3:realmCode code="CA" />
   <v3:id root="59B11710-634C-D526-74E9-357966068701" />
   <v3:creationTime value="20090224225241.656-0700" />
   <v3:responseModeCode code="I" />
   <v3:versionCode code="V3-2008N" />
   <v3:interactionId displayable="true" extension="PRPM_IN996010ON" root="2.16.840.1.113883.1.6" />
   <v3:profileId use="BUS" root="2.16.840.1.113883.3.239.7" extension="V02.00" />
   <v3:processingCode code="P" />
   <v3:processingModeCode code="T" />
   <v3:acceptAckCode code="NE" />
   <v3:receiver>
    <v3:device>
     <v3:id use="BUS" root="2.16.840.1.113883.3.239.2" />
    </v3:device>
   </v3:receiver>
   <v3:sender>
    <v3:device>
     <v3:id specializationType="II.BUS" root="2.16.840.1.113883.3.239.4" use="BUS" />
    </v3:device>
   </v3:sender>
   <v3:controlActEvent>
    <v3:id root="464A7657-1441-42EB-95FD-19E3FAAE0B25" />
    <v3:code codeSystem="2.16.840.1.113883.1.18" code="PRPM_TE996010ON" />
    <v3:statusCode code="completed" />
    <v3:effectiveTime>
     <v3:low value="20090224225214.625-0700" />
    </v3:effectiveTime>
    <v3:author>
     <v3:time value="20090125092236.4764-0400" />
     <v3:authorRole classCode="ROL" />
    </v3:author>
    <v3:pertinentInformation>
     <v3:authorizationToken>
      <v3:id root="IDb4c5b32c-032b-4c8a-9960-4a8309c9b538" />
     </v3:authorizationToken>
    </v3:pertinentInformation>
    <v3:queryByParameter>
     <v3:queryId root="E9B94DB8-CC0A-4598-A5E5-BBF9D6FF81F7" />
     <v3:responseModalityCode code="R" />
     <v3:initialQuantity value="10" />
     <v3:initialQuantityCode code="RD" codeSystem="2.16.840.1.113883.5.1112" />
     <v3:parameterList>
      <v3:address>
       <v3:value>
        <v3:city>Toronto</v3:city>
       </v3:value>
      </v3:address>
      <v3:organizationActiveIndicator>
       <v3:value code="active" />
      </v3:organizationActiveIndicator>
      <v3:providerOrganizationName>
       <v3:value>Island Top Hospital</v3:value>
      </v3:providerOrganizationName>
      <v3:searchOption>
       <v3:value code="1" codeSystem="2.16.840.1.113883.2.20.3.96" />
      </v3:searchOption>
     </v3:parameterList>
    </v3:queryByParameter>
   </v3:controlActEvent>
  </ns2:searchForProviderOrganizationByIDRequest>
 </S:Body>
</S:Envelope>