Versions Compared

Key

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



Warning

The create participant API has been removed starting v5.0. The API was inadvertently exposed to the users. Please use Create Registration API instead.


openspecimen/rest/ng/participants

...

Below are the attributes which need to be sent in the request body:

 


Parameter
Details
firstNameFirst name of the participant
middleNameMiddle name of the participant
lastNameLast name of the participant
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 (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}

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>/openspecimen/rest/ng/participants

...

Below is the example of the create participant:

 

 



URLhttp[s]:<host>:<port>/openspecimen/rest/ng/participants
MethodPOST
content-typeapplication/json
MethodPOST
json


Code Block
languagejs

{
  "firstName" : "Jhon",
  "gender" : "Male Gender",
  "lastName" : "Dep",
  "pmis" : [
	 { "mrn" : "324r6",
        "siteName" : "Lab2"
     } 
   ],
  "race" : [ "Asian" ],
  "ethnicities" : [ "Hispanic or Latino"],
  "uid" : "123-45-6789"
}



Response


Code Block
languagejs
{
  "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
200All resourcesParticipant registered successfully
400All requestsInvalid parameters, e.g  duplicate SSN, duplicate MRN, invalid race etc
401All requestsAuthorization failed, User doesn’t have privileges to register Participants
500All requestsInternal server error, Encountered server error while performing operations

...