Get a specific Patient By ID, externalID, externalGUID, MRN
GET {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}
You can retrieve a specific patient's details by using a known identifier such as ID, external id (EID), external guid (EGUID), or medical record number (MRN).
HTTP URL: https://api.live.welkincloud.io/gh/sb-demo/patients/{identifier}?type={type}
HTTP Response Codes:
- 200: Successfully retrieved the patient's details
- 400: Bad request - the request could not be understood or was missing required parameters
- 500: Internal server error - something went wrong on the server
Here are a few examples illustrating how you can use different identifiers to retrieve a patient:
- https://api.live.welkincloud.io/gh/sb-demo/patients/someId?type=EID
- https://api.live.welkincloud.io/gh/sb-demo/patients/123e4567-e89b-12d3-a456-426655440000?type=EGUID
- https://api.live.welkincloud.io/gh/sb-demo/patients/someMRN?type=MRN
- https://api.live.welkincloud.io/gh/sb-demo/patients/someId?type=EID&expand=true
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
type | string | Type of identifier: ID, EID, EGUID, MRN (default ID) | |
expand | null | If true, request will return dto with territorialTeam field (default false) |
Request Body
{"firstName"=>"patientName", "lastName"=>"patientLastName", "email"=>"test@gmail.com"}