POST api/Demographics/detailedethnicity/get
Returns the detailed ethnicity of the patient from InteliChart demographics.
Request Information
URI Parameters
None.
Body Parameters
BaseRequest| Name | 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
Sample:
{
"PersonUid": "sample string 1",
"StartDate": "2026-02-08T18:04:12.1421106-05:00",
"EndDate": "2026-02-08T18:04:12.1421106-05:00"
}
Response Information
Resource Description
DetailedEthnicityResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 | |
| Ethnicities |
List of detailed ethniticites of a patient. |
Collection of Ethnicity |
Response Formats
application/json, text/json
Sample:
{
"Ethnicities": [
{
"Name": "sample string 1",
"Code": "sample string 2"
},
{
"Name": "sample string 1",
"Code": "sample string 2"
}
],
"ErrorMessage": "sample string 1",
"ErrorType": "sample string 2",
"Success": true
}