POST api/patients/existing/retrieve
Request Information
URI Parameters
None.
Body Parameters
PatientInput| Name | Description | Type | Additional information |
|---|---|---|---|
| Environment | string |
None. |
|
| APIKey | string |
None. |
|
| PhoneNumber | string |
None. |
|
| BirthDate | string |
None. |
|
| LastName | string |
None. |
|
| ChartNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Environment": "sample string 1",
"APIKey": "sample string 2",
"PhoneNumber": "sample string 3",
"BirthDate": "sample string 4",
"LastName": "sample string 5",
"ChartNumber": "sample string 6"
}
text/html, text/plain
Sample:
{"Environment":"sample string 1","APIKey":"sample string 2","PhoneNumber":"sample string 3","BirthDate":"sample string 4","LastName":"sample string 5","ChartNumber":"sample string 6"}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PatientOutput| Name | Description | Type | Additional information |
|---|---|---|---|
| Patient First Name | string |
None. |
|
| Patient Last Name | string |
None. |
|
| string |
None. |
||
| Patient Phone Number | string |
None. |
|
| Patient Mobile Number | string |
None. |
|
| Patient Work Number | string |
None. |
|
| Address | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| Patient DOB | string |
None. |
|
| Patient Chart Number | string |
None. |
|
| Guarantor First Name | string |
None. |
|
| Guarantor Last Name | string |
None. |
|
| Guarantor Phone Number | string |
None. |
|
| Guarantor DOB | string |
None. |
|
| PatID | integer |
None. |
|
| PatDB | integer |
None. |
|
| Patient Last Visit Date | string |
None. |
|
| Patient Last Visit Practice | string |
None. |
|
| Current Insurance | string |
None. |
|
| Plan Type | string |
None. |
|
| Search Status | integer |
None. |
|
| Error Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Patient First Name": "sample string 1",
"Patient Last Name": "sample string 2",
"Email": "sample string 3",
"Patient Phone Number": "sample string 4",
"Patient Mobile Number": "sample string 5",
"Patient Work Number": "sample string 6",
"Address": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"Zip": "sample string 10",
"Patient DOB": "sample string 11",
"Patient Chart Number": "sample string 12",
"Guarantor First Name": "sample string 13",
"Guarantor Last Name": "sample string 14",
"Guarantor Phone Number": "sample string 15",
"Guarantor DOB": "sample string 16",
"PatID": 1,
"PatDB": 1,
"Patient Last Visit Date": "sample string 17",
"Patient Last Visit Practice": "sample string 18",
"Current Insurance": "sample string 19",
"Plan Type": "sample string 20",
"Search Status": 21,
"Error Message": "sample string 22"
}
text/html, text/plain
Sample:
{"Patient First Name":"sample string 1","Patient Last Name":"sample string 2","Email":"sample string 3","Patient Phone Number":"sample string 4","Patient Mobile Number":"sample string 5","Patient Work Number":"sample string 6","Address":"sample string 7","City":"sample string 8","State":"sample string 9","Zip":"sample string 10","Patient DOB":"sample string 11","Patient Chart Number":"sample string 12","Guarantor First Name":"sample string 13","Guarantor Last Name":"sample string 14","Guarantor Phone Number":"sample string 15","Guarantor DOB":"sample string 16","PatID":1,"PatDB":1,"Patient Last Visit Date":"sample string 17","Patient Last Visit Practice":"sample string 18","Current Insurance":"sample string 19","Plan Type":"sample string 20","Search Status":21,"Error Message":"sample string 22"}