Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

catissuecoreopenspecimen/rest/ng/participants/{participant_id}

Use this resource to update an existing participant's details in the caTissue OpenSpecimen application. Use HTTP PUT method to call this API by passing the below details in JSON format.

...

Parameter
Details
firstNameFirst name of the participant
middleNameMiddle name of the participant
lastNameLast name of the participant
ssnSocial security number uidUnique identifier of participant e.g Social Security Number
birthDatedate of birth of participant
vitalStatusVital status of the participant.
deathDatedate 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}

pmiscollection of Participant's medical record number used in their medical treatment.
mrnParticipant's medical record number used in their medical treatment.
siteNameName of the physical location.
empiAny other unique identifier for patient, like enterprise master patient index number

 

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/participants/{participant_id}

...

URLhttp[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/participants/1
MethodPUT
content-typeapplication/json
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" : "John",

  "gender" : "Male Gender",

  "id" : "1",

  "lastName" : "Depp",

  "pmis" : [ { "mrn" : "324r6",

        "siteName" : "Lab2"

      } ],

  "race" : [ "Asian" ],

  "ssnuid" : "123-45-6789"

}

 

Error Cases :

...