Provider Person Search (SPP)


This describes the generic use case category for searching for provider person summary information. Regardless of the specific business scenario, the message flow for requesting and obtaining provider person summary information remains the same. The difference lies in the combination of query parameter items (resulting in a pre-defined SPP search type/options) that is employed by the user.


Message Type

PRPM_IN986010ON

Category

Query

Standard

HL7V3



Interactions

Scenario Details:

User of System requests the retrieval of provider summary information, using specific pre-defined combinations of provider person data items as query parameters.

1. A ‘Provider Person Search Query Request (PRPM_IN986010ON)’ message is sent from via the External System (via HIAL) to the provider registry system.

2. A ‘Provider Person Search Query Response (PRPM_IN986011ON)’ message is sent from the provider registry system to the External System, with a list of matching providers.


Mandatory fields:

1.  Search by profession/specialty:

- Profession

- Address (at least one)

* Municipality

* Postal Code

2.  Search by license:

- License Source

- License Number

 

Message Flow:

1.  The query request message (PRPM_IN986010ON) contains the parameter items as shown below:

 

Query Parameter Item

sample Value

Representation in a message

administrativeGender code

F

<v3:administrativeGender>

<v3:value code="F" codeSystem="2.16.840.1.113883.5.1"/>

</v3:administrativeGender>

alternateIdentifier

999444663

<v3:alternateIdentifier>

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

</v3:alternateIdentifier>

languageOption code

eng

<v3:languageOptionCode>

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

</v3:languageOptionCode>

licenseNumber

C1234506

<v3:licenseNumber>

                  <v3:value>extension=”C1234506”

                  root=” 2.16.840.1.113883.4.347”</v3:value>

</v3:licenseNumber>

Address (municipalityName and postalCode)

 

 

Mississauga

 

M6P 1B8

<v3:address>

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

                 <v3:value><v3:postalCode>M6P 1B8</v3:city></v3:value>

</v3:address>            

professionActiveIndicator code

active

<v3: professionStatusCode>

                  <v3:value code="active"/>

</v3: professionStatusCode>

providerFirstName

Hans

<v3:providerFirstName>

                  <v3:value use="L">

                                    <v3:given>Hans</v3:given>

                  </v3:value>

</v3:providerFirstName>

providerLanguage code

eng

<v3:providerLanguageCode>

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

</v3:providerLanguageCode>

providerLastName

GoodDoctor

<v3:providerLastName>

                  <v3:value use="L">

                  <v3:family>GoodDoctor</v3:family>

                  </v3:value>

</v3:providerLastName>

providerPersonID

102334556778

<v3:providerPersonID>

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

</v3:providerPersonID>

providerRoleProfession code

MD

<v3:providerRoleProfession>

<v3:value code="MD" codeSystem="2.16.840.1.113883.2.20.5.3"/>

</v3:providerRoleProfession>

providerRoleSpecialty code

360

<v3:providerRoleSpecialty>

<v3:value code="360" codeSystem="2.16.840.1.113883.2.50.5.4 "/>

</v3:providerRoleSpecialty>

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>

    

2.  The query response message (PRPM_IN986011ON) contains the parameter items as shown below

 

HL7 Attribute name:

- UPI

- Alternate Identifier Type code

- Alternate Identifier

- Alternate identifier Source OID

- Multiple Alternate Identifier Indicator Code

- Provider Official Registry Name

- Gender

- Provider Communication Language

- Profession Role Class Type

- Profession Role Class Code

- Profession Active Indicator

- Multiple Profession Indicator Code

- Communication Language code

- License Number

- License Origin OID

- License Certificate Class Code

- License Restriction Type Code

- Specialty Role Class Type

- Multiple Specialty Indicator Code

- Address

- Address Postal Code

- Address Additional Locator

- Address Street Address Line 1

- Address Street Address Line 2

- Address Street Address Line 3

- Address Street Address Line 4

- Multiple Practice Address Indicator Code

 

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


Sample Message

<S:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
  <wsa:MessageID>uuid:3ccde69c-e05c-4485-8d58-464cbb1f3574</wsa:MessageID>
  <wsa:ReplyTo>
   <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>
  </wsa:ReplyTo>
  <wsa:To>http://lite.innovation-lab.ca:7102/ppr</wsa:To>
  <wsa:Action>http://ehealth.gov.on.ca/ProviderService/searchForProviderPersonByIDRequest</wsa:Action>
 </S:Header>
 <S:Body>
  <ns2:searchForProviderPersonByIDRequest xsi:schemaLocation="http://ehealth.gov.on.ca/ProviderService ..\ProviderService.xsd" xmlns:v3="urn:hl7-org:v3" xmlns:ns2="http://ehealth.gov.on.ca/ProviderService">
   <v3:realmCode code="CA" />
   <v3:id root="5b903ddb-1cb3-4e37-9bf5-becf5dd5d30d" specializationType="II.TOKEN" />
   <v3:creationTime specializationType="TS.FULLDATETIME" value="20150723161757.821-0400" />
   <v3:responseModeCode code="I" />
   <v3:versionCode code="V3-2008N" />
   <v3:interactionId displayable="true" extension="PRPM_IN986010ON" root="2.16.840.1.113883.1.6" />
   <v3:profileId extension="V02.00" root="2.16.840.1.113883.3.239.7" use="BUS" />
   <v3:processingCode code="P" />
   <v3:processingModeCode code="T" />
   <v3:acceptAckCode code="NE" />
   <v3:receiver typeCode="RCV">
    <v3:device classCode="DEV" determinerCode="INSTANCE">
     <v3:id root="2.16.840.1.113883.3.239.2" specializationType="II.BUS" />
    </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 classCode="CACT" moodCode="EVN">
    <v3:id root="bc5aea9d-f50f-4e0d-956c-791236ace956" specializationType="II.BUS" />
    <v3:code code="PRPM_TE986010ON" codeSystem="2.16.840.1.113883.1.18" />
    <v3:statusCode code="completed" />
    <v3:effectiveTime operator="I">
     <v3:low value="20150723161757.821-0400" inclusive="true" />
    </v3:effectiveTime>
    <v3:author typeCode="AUT" contextControlCode="AP">
     <v3:time specializationType="TS.FULLDATETIME" value="20150723161757.821-0400" />
     <v3:authorRole classCode="ROL" />
    </v3:author>
    <v3:pertinentInformation typeCode="PERT" contextControlCode="AP" contextConductionInd="false">
     <v3:authorizationToken classCode="VERIF" moodCode="EVN">
      <v3:id root="ID5b903ddb-1cb3-4e37-9bf5-becf5dd5d30d" />
     </v3:authorizationToken>
    </v3:pertinentInformation>
    <v3:queryByParameter>
     <v3:queryId root="Aefac5cc-9804-4866-9f3b-f6cdbae294a5" specializationType="II.TOKEN" />
     <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>Vineland</v3:city>
        <v3:postalCode>L0R2C0</v3:postalCode>
       </v3:value>
      </v3:address>
      <v3:providerRoleProfession>
       <v3:value code="NU" codeSystem="2.16.840.1.113883.3.239.5.6" />
      </v3:providerRoleProfession>
      <v3:providerRoleSpecialty>
       <v3:value code="NP" codeSystem="2.16.840.1.113883.2.20.5.4" />
      </v3:providerRoleSpecialty>
      <v3:searchOption>
       <v3:value code="2" codeSystem="2.16.840.1.113883.3.239.5.18" />
      </v3:searchOption>
     </v3:parameterList>
    </v3:queryByParameter>
   </v3:controlActEvent>
  </ns2:searchForProviderPersonByIDRequest>
 </S:Body>
</S:Envelope>