POST api/Demographics/patientname/get
Returns the patient's name from InteliChart demographics.
Request Information
URI Parameters
None.
Body Parameters
BaseRequestName | Description | Type | Additional information |
---|---|---|---|
PersonUid |
Encryped passcode for the authenticated user. |
string |
Required |
StartDate |
Start date of the request. A time component is not used when passing the start date. |
date |
[Optional] |
EndDate |
End date of the request. A time component is not used when passing the end date. |
date |
[Optional] |
Request Formats
application/json, text/json
{ "PersonUid": "sample string 1", "StartDate": "2024-10-07T10:22:14.2535913-04:00", "EndDate": "2024-10-07T10:22:14.2535913-04:00" }
Response Information
Resource Description
PatientNameResponseName | Description | Type | Additional information |
---|---|---|---|
FirstName |
First name of the patient. |
string | |
MiddleName |
Middle name of the patient. |
string | |
LastName |
Last name of the patient. |
string | |
PreviousLastName |
Previous last name of the patient. |
string | |
PreviousFirstName |
Previous first name of the patient. |
string | |
Suffix |
Suffix of the patient. |
string | |
ErrorMessage |
If the success property is false, the ErrorMessage property will contain error text, otherwise it will be null. |
string | |
ErrorType |
Text of the type of error that has occured (See the Error Handling section for more information). |
string | |
Success |
Represents the success of the call. |
boolean |
Response Formats
application/json, text/json
{ "FirstName": "sample string 1", "MiddleName": "sample string 2", "LastName": "sample string 3", "PreviousLastName": "sample string 4", "PreviousFirstName": "sample string 5", "Suffix": "sample string 6", "ErrorMessage": "sample string 7", "ErrorType": "sample string 8", "Success": true }