catissuecoreopenspecimen/rest/ng/participants/{participant_id}
Use this resource to partially update an existing participant's details in the caTissue OpenSpecimen application. Use HTTP PATCH GET 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 |
| ssn | Social security number of participant |
| 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 | Patient's ethnicity status. permissible values are: {Hispanic or Latino, Not Hispanic or Latino, Not Reported, Unknown} |
| Sex Genotype | 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. |
retrieve.
http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/participants/{participant_id}
Use this URL to partially update retrieve the participant for the given identifier.
...
| URL | http[s]:<host>:<port>/catissuecore/rest/ng/participants/1 |
| Method | PATCHGET |
| content-type | application/json |
| json { "pmis" : [ { "mrn" : "324r6","siteName" : "Lab2" } ], | "race" : [ "Asian" ], } |
| response | { "activityStatus" : "Active", "ethnicity" : "Unknown", "firstName" : "John", "gender" : "Male Gender", "id" : "1", "lastName" : "Depp", "pmis" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "ssnuid" : "123-45-6789" } |
Error Cases :
...