Page Comparison

openspecimen/rest/ng/participants/match

Use this resource API to get find matching participants in the OpenSpecimen applicationdatabase. Use HTTP POST method to call invoke this API by passing the below details in JSON format. This will match against the below attributes only.

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

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.
uidSocial	security number of participantCountry specific unique ID of the participant. For example, in US, this could be SSN. In India this could be Aadhar number / PAN etc
birthDate	Participant's date of birth of participant
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.
empi	Any other unique identifier for patient, like enterprise master patient index number. Used in conjunction with lastName.
pmi	Participant's MRN and name of site that assigned the MRN. Refer below example for the field structure.
empi	Enterprise wide unique ID assigned to the participant.
reqRegInfo	Boolean specifying whether the registration details of matched participants needs to be populated in response.

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

Use this URL to add participant find matching participants in OpenSpecimen applicationdatabase.

Result:

The response of this request will contains the details of the created participantmatching request is either an empty array or list of matched participants.

Below is the example of the create participant:

match participants request-response:

URL

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

Method

POST

content-type

application/json

Method

POST

jsonBody

Code Block
{


  "lastName" : "Dep",

"pmis" : [ {


  "pmi" :  {
    "mrn" : "324r6",


    "siteName" : "Lab2"

} ],


  } ,
  "uid" : "123-45-6789"

Response

[

1]

0:

{

Code Block
[ { "matchedAttrs": [

1] 0:

"pmi

"

", "uid"]
    "participant": {

  
      "lastName" : "Dep",


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


        "siteName" : "Lab2"

} ],

"id" : "1",


      }],
      "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"]

...

code	Applies to	Status Message
200	All resources	Participant registered Matching request executed successfully
400	All requests	Invalid parameters, e.g duplicate SSN, duplicate MRN, invalid race etcinput parameters. Retrying request with correct parameter values might succeed.
401	All requests	Authorization failed, . User doesn’t have privileges to register Participantsrights to find matching participants.
500	All requestsInternal	server error, Encountered server error while performing operationsServer error. Retrying request might not succeed.

Versions Compared

Old Version 7

New Version 8

Key