API PatientRaces

See API Specification

PatientRaces GET

Version Added: 22.3.12

Gets all of the Race and Ethnicity infomation for a Patient, similarly to how it shows in the Edit Patient Information: Public Health Tab. The dental office must have Public Health enabled to record this information.

PatNum: Required.

Returned fields are detailed below:

PatientRaceNum: Primary key of the patientrace table.
PatNum: The PatNum of the patient.
CdcrecCode: CDC Race and Ethnicity unique identifier code.
descripition: Race or Ethnicity Description corresponding to the CdcrecCode.
isEthnicity: True for ethnicity or False for race information.
heirarchicalCode: Alphanumeric code that the CDC uses to organize CdcrecCodes.

Example Request
GET /patientraces?PatNum=73

Example Response:
[
{
"PatientRaceNum": 16,
"PatNum": 73,
"CdcrecCode": "2066-9",
"descrpition": "ZAIREAN",
"isEthnicity": "false",
"heirarchicalCode": "R3.03.006"
},
{
"PatientRaceNum": 17,
"PatNum": 73,
"CdcrecCode": "2120-4",
"descrpition": "EGYPTIAN",
"isEthnicity": "false",
"heirarchicalCode": "R5.02.002"
},
{
"PatientRaceNum": 18,
"PatNum": 73,
"CdcrecCode": "2186-5",
"descrpition": "NOT HISPANIC OR LATINO",
"isEthnicity": "true",
"heirarchicalCode": "E2"
}
]

200 OK
400 Bad Request (Patient is deleted, etc)
401 NotFound (Patient not found)