openspecimen/rest/ng/participants
Use this resource to create new participant in the OpenSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.
Below are the attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
| firstName | First name of the participant |
| middleName | Middle name of the participant |
| lastName | Last name of the participant |
| uid | Unique identifier of participant e.g Social Security Number |
| birthDate | date of birth of participant |
| vitalStatus | Vital status of the participant. |
| deathDate | date of death participant |
| gender | gender of the participant, permissible values are {Male Gender, Female Gender, Unknown, Unspecified} |
| race | Patient's racial origination, permissible values are: {American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or other Pacific Islander, Not Reported, Unknown, White} |
ethnicity (Prior to v4.0) ethnicities (From v4.0) | Patient's ethnicity status. permissible values are: {Hispanic or Latino, Not Hispanic or Latino, Not Reported, Unknown} Note: Starting v4.0, ethnicity is a multi-value field in Participant. |
| sexGenotype | The genetic constitution of the individual; the characterization of the genes. Permissible values are: {XX Genotype, XY Genotype, XXX, Klinefelter’s Syndrome, XXXY syndrome, XXYY syndrome, Mosaic including XXXXY, Penta X syndrome} |
| pmis | collection of Participant's medical record number used in their medical treatment. |
| mrn | Participant's medical record number used in their medical treatment. |
| siteName | Name of the physical location. |
| empi | Any other unique identifier for patient, like enterprise master patient index number |
http[s]:<host>:<port>/openspecimen/rest/ng/participants
Use this URL to add participant in OpenSpecimen application.
Result:
The response of this request will contains the details of the created participant.
Below is the example of the create participant:
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/participants |
| Method | POST |
| content-type | application/json |
| Method | POST |
| json |
{
"firstName" : "Jhon",
"gender" : "Male Gender",
"lastName" : "Dep",
"pmis" : [
{ "mrn" : "324r6",
"siteName" : "Lab2"
}
],
"race" : [ "Asian" ],
"ethnicities" : [ "Hispanic or Latino"],
"uid" : "123-45-6789"
}
|
Response | {
"firstName" : "Jhon",
"gender" : "Male Gender",
"id" : "1",
"lastName" : "Dep",
"pmis" : [
{ "mrn" : "324r6",
"siteName" : "Lab2"
}
],
"race" : [ "Asian" ],
"ethnicities" : [ "Hispanic or Latino"],
"uid" : "123-45-6789",
"activityStatus" : "Active",
}
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Participant registered successfully |
| 400 | All requests | Invalid parameters, e.g duplicate SSN, duplicate MRN, invalid race etc |
| 401 | All requests | Authorization failed, User doesn’t have privileges to register Participants |
| 500 | All requests | Internal server error, Encountered server error while performing operations |