Sign in

v1

latestSwagger 2.02026-08-061791731.4 MB
Patient Demographics

{{baseUrl}}/persons/lookup

Gets a list of persons/patients based on various search criteria. Since these results are returned from a /persons/ endpoint, the "id" of each result (whose value is a guid) is a personId and can be used as the value of personId in all other routes that require a personId.

Using the /persons/lookup route:

-At least one query parameter must be provided as lookup criteria. -Use of multiple criteria is allowed, and will results will include person records matching all criteria. -The two "quickSearch" parameters are exceptions to the above; see the quickSearchId & quickSearchInput parameter descriptions for details.

get/persons/lookup

Query parameters

namestring required
firstNamestring required
lastNamestring required
middleNamestring required
priorLastNamestring required
addressLine1string required
citystring required
zipstring required
sexstring required
currentGenderstring required
dateOfBirthstring required
externalIdstring required
externalSystemIdstring required
excludeExpiredstring required
isNextMdEnabledstring required
searchPatientsOnlystring required
quickSearchIdstring required
quickSearchInputstring required
$expandstring required

Headers

Acceptstring required

Response

OK

idstring required
firstNamestring required
lastNamestring required
middleNamestring required
nicknamestring required
addressLine1string required
addressLine2string required
citystring required
statestring required
zipstring required
countrystring required
homePhonestring required
dateOfBirthstring required
sexstring required
currentGenderstring required
socialSecurityNumberstring required
personNumberstring required
medicalRecordNumberstring required
otherIdNumberstring required
isEnterpriseChartstring required
isPatientstring required
canAddToInclusionListstring required

Example response

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "nickname": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "homePhone": "<string>",
  "dateOfBirth": "<string>",
  "sex": "<string>",
  "currentGender": "<string>",
  "socialSecurityNumber": "<string>",
  "personNumber": "<string>",
  "medicalRecordNumber": "<string>",
  "otherIdNumber": "<string>",
  "isEnterpriseChart": "<string>",
  "isPatient": "<string>",
  "canAddToInclusionList": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}