Search

Beta

POST

/patient-merge/v1/search

POST

/patient-merge/v1/search

$ curl -X POST https://pre-api.joincandidhealth.com/patient-merge/v1/search \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "mrns": [
>     "mrns",
>     "mrns"
>   ]
> }'

1 {
2   "items": [
3     {
4       "alternative_patient_mrn": "alternative_patient_mrn",
5       "deactivated": true,
6       "id": "id",
7       "organization_id": "organization_id",
8       "primary_patient_mrn": "primary_patient_mrn",
9       "updated_at": "2024-01-15T09:30:00Z",
10       "updating_user_id": "updating_user_id",
11       "version": 1
12     },
13     {
14       "alternative_patient_mrn": "alternative_patient_mrn",
15       "deactivated": true,
16       "id": "id",
17       "organization_id": "organization_id",
18       "primary_patient_mrn": "primary_patient_mrn",
19       "updated_at": "2024-01-15T09:30:00Z",
20       "updating_user_id": "updating_user_id",
21       "version": 1
22     }
23   ],
24   "total": 1,
25   "next_page_token": "next_page_token",
26   "prev_page_token": "prev_page_token"
27 }

Returns a page of patient merge records for the given MRNs. A merge is included when the MRN matches either the alternative or the primary patient MRN.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

mrnslist of stringsRequired

The patient MRNs to fetch merges for.

limitintegerOptional

The max number of records to return. Defaults to 100, capped at 1000.

page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

Response

This endpoint returns an object.

itemslist of objects

totalinteger

next_page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

Errors

400

Bad Request Error