openspecimen/rest/ng/participants/match
Use this API to find matching participants in search 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 parametersdatabase that match one or more of the matching field.
Parameter | Details |
|---|---|
| lastName | Last name of the participant. Used in conjunction with birthDate. |
| uid | Country 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 |
| birthDate | Participant's date of birth. 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. By default, the value of this flag is false. |
...
http[s]:<host>:<port>/openspecimen/rest/ng/participants/match
...