You can use the patient check end-point to determine if a patient already exists in the PainChek system.
curl -X GET \
https://ua.ap.painchek.com/api/patients/check/?first_name=Fred&last_name=Smith&birth_date=1939-04-20
This check can be very useful for initial loads or migration purposes. It allows a third party system to look for existing PainChek patients so that the records in each system can be linked together.
Parameters
|
Field |
Type |
|---|---|
|
first_name |
Mandatory String |
|
last_name |
Mandatory String |
|
birth_date |
Mandatory YYYY-MM-DD |
Return Fields
The following table documents the parameters returned by the end-point:
|
Field
|
Type
|
Contents
|
|---|---|---|
| found | Mandatory Boolean | true (if one or more matches are found), false otherwise |
| match_count | Mandatory Integer | The number of matches found |
| uuids | Mandatory list | An array containing the UUIDs of all of the matched patients. If there are no matches, an empty list is returned. |
The following sections show some sample returns under different conditions:
Return - No Matches
{
"found": false,
"match_count": 0,
"uuids": []
}
Return - Single Match
{
"found": true,
"match_count": 1,
"uuids": [
"6c5ec627-9838-4bdd-bebc-02940a853811"
]
}
Return - Multiple Matches
{
"found": true,
"match_count": 2,
"uuids": [
"6c5ec627-9838-4bdd-bebc-02940a853811",
"cc42fbb9-efcd-4fd4-a3f6-cf7b028bdb90"
]
}