catissuecoreopenspecimen/rest/ng/participants
Use this resource to create new participant in the caTissue OpenSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.
...
Parameter | Details | |
|---|---|---|
| firstName | First name of the participant | |
| middleName | Middle name of the participant | |
| lastName | Last name of the participant | |
| ssn | Social security number 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 | Patient's ethnicity status. permissible values are: {Hispanic or Latino, Not Hispanic or Latino, Not Reported, Unknown} | |
| Sex GenotypesexGenotype | 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. |
http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/participants
Use this URL to add participant in caTissue OpenSpecimen application.
Result:
The response of this request will contains the details of the created participant.
...
| URL | http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/participants |
| Method | POST |
| content-type | application/json |
| Method | POST |
| json | { "ethnicity" : "Unknown", "firstName" : "Jhon", "gender" : "Male Gender", "lastName" : "Dep", "pmis" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "ssnuid" : "123-45-6789" } |
Response | { "activityStatus" : "Active", "ethnicity" : "Unknown", "firstName" : "Jhon", "gender" : "Male Gender", "id" : "1", "lastName" : "Dep", "pmis" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "ssnuid" : "123-45-6789" } |
Error Cases :
...