Building on the Platform
...
Patient Demographics
Cross-Reference Patient

Patient Identifier Query

2min

Application clients can use the Patient Identifier Query to retrieve previously-stored Patient Identifiers with their cross-references from Founda's Patient Identifier Cross-Reference Manager.

Profile

The Patient Identifier Query interaction with the Founda Platform is based on the IHE PIXm profile. To indicate that the request and response should comply with ITI-83, the base URL for an ITI-83 operation contains the $ihe-pix parameter.

Interaction

In order to query for all the Patient Identifier Cross-References, the Identifier of the source patient identifier system should be passed inside the query parameters. This is sent to the Patient endpoint with a GET request, for example: https://api.<region>.founda.com/1/health/organizations/<org-x>/fhir/4/Patient/$ihe-pix?sourceIdentifier=urn:oid:1.3.6.1.4.1.21367.13.20.1000|IHERED

Optional: add a targetSystem to the query parameters to specify the target system of which you want to query the identifier, for example: https://api.<region>.founda.com/1/health/organizations/<org-x>/fhir/4/Patient/$ihe-pix?sourceIdentifier=urn:oid:1.3.6.1.4.1.21367.13.20.1000|IHERED&targetSystem=urn:oid:1.3.6.1.4.1.21367.13.20.2000

Depending on the region you are in.

Example API call