Versions Compared

Old Version 13

changes.mady.by.user Vinayak Pawar

Saved on

compared with

New Version 14

changes.mady.by.user Vinayak Pawar

Saved on

Key

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

...

Parameter
Details
lastName

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

uidCountry specific social security or national 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. By default, the value of this flag is false.

 

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

...

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",
  "reqRegInfo": true
}


Response


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

      /** other participant attributes **/

      /* registeredCps array is populated only if reqRegInfo = true in matching request */
      "registeredCps": [
        {
          "cpShortTitle": "Lung Cancer",
          "registrationDate": 1437282466892,
          "ppid": "LC-007",
          "cprId": 17018
        }
        /* other registrations, if any */
      ]
    }
]


...