By demographics
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.
Parameter | Type | Required | Description |
|---|---|---|---|
_id | string | | Resource (logical) identifier for the patient |
active | boolean | | Search for active (true) or inactive (false) patients |
family | string | | Family name or last name of the patient |
given | string | | Given name of the patient |
identifier | token | | A patient identifier, formatted as: <system>|<value>. Multiple identifiers can be added. |
telecom | token | | Telecommunication details |
birthdate | date | | Patient's birthday, e.g. "2000-10-01" |
address | string | | A known address for the patient |
address-city | string | | The city the patient lives in |
address-country | string | | The country the patient lives in |
address-postalcode | string | | The postal code of the patient's address |
address-state | string | | The state the patient lives in |
gender | token | | The patient's gender, from value set: http://hl7.org/fhir/R4/valueset-administrative-gender.html |
mothersMaidenName | string | | The patient's mother's maiden name |
_profile | | Yes | 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.
