A patient can be queried for based on the known demographics of that patient by sending a GET or a POST request to the Patient endpoint, depending on your region: <region>.founda.com/1/health/organizations/<org-x>/fhir/4/Patient
The amount of patients that are returned in the response depends on the amount of matching patients that result from the API call: 0, 1 or N. In the case of N matches, the application can implement a heuristic to select the correct patient. Once the right patient is identified, its unique identifier can be used to retrieve the patient resource - as explained in the "Retrieve Patient by identifier" section.
A combination of the parameters listed below can be used as search parameters.
Resource (logical) identifier for the patient
Search for active (true) or inactive (false) patients
Family name or last name of the patient
Given name of the patient
A patient identifier, formatted as: <system>|<value>. Multiple identifiers can be added.
Patient's birthday, e.g. "2000-10-01"
A known address for the patient
The city the patient lives in
The country the patient lives in
The postal code of the patient's address
The state the patient lives in
The patient's gender, from value set: http://hl7.org/fhir/R4/valueset-administrative-gender.html
The patient's mother's maiden name
The profile transaction URL that the request is for, e.g. https://profiles.ihe.net/ITI/PDQm.
The Retrieve Patient interaction with the Founda Platform is based on the IHE PDQm profile. To indicate that the request and response should comply with ITI-78, the _profile parameter should be included to the search set: .../Patient?_profile=https://profiles.ihe.net/ITI/PDQm.