Versions Compared

Old Version 8

changes.mady.by.user Vinayak Pawar

Saved on

compared with

New Version 9

changes.mady.by.user Vinayak Pawar

Saved on

Key

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

...

Use this API to find matching participants in the OpenSpecimen database. Use HTTP POST method to invoke this API by passing below details in JSON format. The API will attempt to find matching participants based on below input parameters.


Parameter
Details
lastName

Last name of the participant. Used in conjunction with birthDate.

uidCountry specific unique ID of the participant. For example, in US, this could be SSN. In India this could be Aadhar number / PAN etc
birthDateParticipant's date of birth. Used in conjunction with lastName.
pmiParticipant's MRN and name of site that assigned the MRN. Refer below example for the field structure.
empiEnterprise wide unique ID assigned to the participant.
reqRegInfoBoolean specifying whether the registration details of matched participants needs to be populated in response.

 

http[s]:<host>:<port>/openspecimen/rest/ng/participants/match

...

Below is the example of the match participants request-response:

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


Code Block
{
  "lastName" : "Dep",
  "pmi" :  {
    "mrn" : "324r6",
    "siteName" : "Lab2"
  } ,
  "uid" : "123-45-6789"
}


Response


Code Block
[
  {
    "matchedAttrs": ["pmi", "uid"]
    "participant": {  
      "lastName" : "Dep",
      "pmis" : [{ 
        "mrn" : "324r6",
        "siteName" : "Lab2"
      }],
      "uid" : "123-45-6789"
      "id" : "1",

      
/** other participant attributes **/


      registeredCps: [/* populated only if reqRegInfo = true in matching request */]
    }
]


Note:

matchedAttrs contains list of input attributes against which matching participant was found. The values could any of these ["empi" | "uid" | "pmi" | "lnameAndDob"]

Error Cases :

code
Applies to
Status Message
200All resourcesMatching request executed successfully
400All requestsInvalid input parameters. Retrying request with correct parameter values might succeed.
401All requestsAuthorization failed. User doesn’t have rights to find matching participants.
500All requestsServer error. Retrying request might not succeed.