Find Associated Client Identifiers Query


Used to query the PCR for all identifiers associated with a particular primary (definitional) person identifier. This interaction occurs when the consuming system and/or user has a unique primary (definitional) person identifier (e.g. PCR Enterprise ID (EID), Ontario health card number (HCN) / medical record numbers (MRN) for standard model hospital, or corporate ID (CORPID) for a corporate model hospital) in addition to the registered source (i.e. OID) for that identifier which is required to perform the interaction.  As the receiver of the interaction request, the PCR will respond with the list of all active and inactive associated person identifiers.  For example, given a primary client identifier (e.g. Ontario HCN OID & value), this service will return any other identifiers that may be associated with that number (e.g. hospital MRNs).

 

When this interaction sends a query to the PCR requesting all other identifiers associated with a specific person identifier, only one identifier must be present in the query.

 


Message Type

PRPA_IN101105CA

Category

Query

Standard

HL7v3



Interactions

 

Interaction

Trigger Event

Transmission Wrapper

Control Event Wrapper

Payload

PRPA_IN101105CA Find Associated Client Identifiers Query

PRPA_TE101105CA

Find Associated Identifiers Query

MCCI_MT002100CA

Request Transport Wrapper

MFMI_MT700751CA

Registry Query Request Wrapper - Human Initiated

PRPA_MT101101CA

Query by Client ID

PRPA_IN101106CA Find Associated Client Identifiers Response

PRPA_TE101106CA

Find Associated Identifiers Response

MCCI_MT002300CA

Application Ack Transport Wrapper

MFMI_MT700746CA

Registry Query Response Wrapper - Device Initiated With Role Payload

PRPA_MT101106CA

Find Associated IDs Response

PRPA_MT101101CA

Query by Client ID

 


Input:

Query by one of these primary IDs (Same input criteria as “Get Client Demographics”):

  1. PCR Enterprise ID (EID) aka Enterprise Client ID (ECID)
  1. Health Card Number (HCN)
  1. Corporate ID (CORPID) for corporate model hospitals
  1. Medical Record Number (MRN) for standard model hospitals

 

A source OID (ID Issuer) & corresponding ID value must be provided in the request.

For example, for PCR EID:

OID (ID Issuer) = 2.16.840.1.113883.3.239.20 (eHealth Ontario PCR Enterprise Identifier (EID))

ID = 123456

 

Output:

This interaction will be returned by the query fulfilling application in response to the Find Associated Client Identifiers Query (PRPA_IN101105CA) and includes all active, inactive, and merged identifiers associated with a particular person identifier in the Provincial CR. Logically deleted identifiers are not returned in the Find Associated Client Identifiers Response If there are no records in the response, refer to the interaction Acknowledgement and Detected Issue Event for information about a reason for it.

 

Returns the following business attributes (where they exist depending on PCR data density for the given client):

  • PCR EID
  • Ontario Health Card Number
  • Non-Ontario (Out-of-Province) Health Card Number(s)
  • Corporate ID(s)
  • Medical Record Number(s)

 


Sample Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>urn:hl7-org:v3:PRPA_IN101105CA.MR200903</wsa:Action>
<wsa:ReplyTo>
<wsa:Address>http://schemas.xmlsoap.org/ws/2005/08/addressing/role/anonymous</wsa:Address>
</wsa:ReplyTo>
<wsa:MessageID>uuid:ee80516a-ea98-4445-ad69-7edb55dc95bd</wsa:MessageID>
<wsa:To>www.example.com</wsa:To>
</S:Header>
<S:Body>
<PRPA_IN101105CA ITSVersion="XML_1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:hl7-org:v3">
<realmCode code="CA" />
<id specializationType="II.TOKEN" root="CEEF2B21-AD9A-4B6F-BE63-BDD9EBD12C21" />
<creationTime specializationType="TS.FULLDATETIME" value="20180417170403.386-0400" />
<responseModeCode code="I" />
<versionCode code="V3-2008N" />
<interactionId specializationType="II.PUBLIC" root="2.16.840.1.113883.1.6" extension="PRPA_IN101105CA" />
<profileId root="2.16.840.1.113883.2.20.2" extension="R02.04.03" />
<profileId root="2.16.840.1.113883.3.239.7" extension="V03.00" />
<processingCode code="D" />
<processingModeCode code="T" />
<acceptAckCode code="NE" />
<receiver typeCode="RCV">
<telecom specializationType="TEL.URI" value="http://142.222.17.102:8080/on" />
<device classCode="DEV" determinerCode="INSTANCE">
<id specializationType="II.BUS" root="2.16.840.1.113883.3.239.2" use="BUS" />
<name mediaType="text/plain" representation="TXT">eHealth Ontario Integration Facility</name>
<agent classCode="AGNT">
<agentOrganization classCode="ORG" determinerCode="INSTANCE">
<id specializationType="II.BUS" root="2.16.840.1.113883.3.239" use="BUS" />
</agentOrganization>
</agent>
</device>
</receiver>
<sender typeCode="SND">
<telecom specializationType="TEL.URI" value="http://innovation-lab.ca" />
<device classCode="DEV" determinerCode="INSTANCE">
<id specializationType="II.BUS" root="2.16.840.1.113883.3.239.4" extension="UniqueSenderIdentifier" use="BUS" />
<name mediaType="text/plain" representation="TXT">eHealth Ontario Portal Application</name>
<desc mediaType="text/plain" representation="TXT">I hereby accept the service agreement here: https://innovation-lab.ca/media/1147/innovation-lab-terms-of-use.pdf</desc>
</device>
</sender>
<controlActEvent classCode="CACT" moodCode="EVN">
<id specializationType="II.BUS" root="a2d0e1d8-e239-46b2-af29-589359a4eced" use="BUS" />
<code code="PRPA_TE101105CA" codeSystem="2.16.840.1.113883.1.18" />
<statusCode code="completed" />
<effectiveTime operator="I">
<low value="20180417170403.386-0400" />
</effectiveTime>
<author typeCode="AUT" contextControlCode="AP">
<time specializationType="TS.FULLDATETIME" value="20180417170403.386-0400" />
<assignedEntity1 classCode="ASSIGNED">
<id root="2.16.840.1.113883.19.4.207" extension="222339999" displayable="true" use="BUS" />
<assignedPerson classCode="PSN" determinerCode="INSTANCE">
<name specializationType="PN.BASIC" use="L">
<prefix partType="PFX">Dr.</prefix>
<given partType="GIV">Fay</given>
<given partType="GIV">F</given>
<family partType="FAM">Family</family>
</name>
<asHealthCareProvider classCode="PROV">
<id specializationType="II.PUBLIC" root="2.16.840.1.113883.4.41" extension="200202888" displayable="true" use="BUS" />
</asHealthCareProvider>
</assignedPerson>
</assignedEntity1>
</author>
<queryByParameter>
<queryId specializationType="II.TOKEN" root="A9217A0D-AC20-4C7C-AD86-2F9DCF3555CA" />
<initialQuantity specializationType="INT.POS" value="10" />
<parameterList>
<clientIDBus>
<value specializationType="II.BUS" root="2.16.840.1.113883.3.239.20" extension="133000" />
</clientIDBus>
</parameterList>
</queryByParameter>
</controlActEvent>
</PRPA_IN101105CA>
</S:Body>
</S:Envelope>


*a valid UniqueSenderIdentifier needs to be replaced in the example above