openspecimen/rest/ng/participants/{participant_id}
Use this resource to update an existing participant's details in the OpenSpecimen application. Use HTTP PUT method to call this API by passing the below details in JSON format.
Here participant_id refers to the actual identifier of the participant to which user wants to update/modify.
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} |
| ethnicities | Patient's ethnicity status. permissible values are: {Hispanic or Latino, Not Hispanic or Latino, Not Reported, Unknown} |
| 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/{participant_id}
Use this URL to update the participant for the given identifier.
Result:
The response of this request will contains the details of the updated participant.
Below is the example of the update participant:
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/participants/1 |
| Method | PUT |
| content-type | application/json |
| 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" : "John",
"gender" : "Male Gender",
"id" : "1",
"lastName" : "Depp",
"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 etc |
| 401 | All requests | Authorization failed, User doesn’t have privileges to register Participants |
| 404 | All requests | Participant not found, Participant with the given identifier is not present in the system |
| 500 | All requests | Internal server error, Encountered server error while performing operations |