v1

latestSwagger 2.02026-08-061791731.4 MB

Patient Demographics

{{baseUrl}}/persons

Gets a list of persons/patients. If OData $filter criteria for createTimestamp and/or /modifyTimestamp are not specified, the default behavior of this route is to return results for persons/patients that have been created or modified in the last 7 days.

get/persons

Query parameters

patientsOnlystring required

$topstring required

$filterstring required

$orderbystring required

$skipstring required

$inlinecountstring required

$countstring required

Headers

Acceptstring required

Response

Countstring required

NextPageLinkstring required

Example response

{
  "Count": "<string>",
  "Items": [
    {
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ],
      "checkInDateTime": "<string>",
      "checkInTimezone": "<string>",
      "checkOutDateTime": "<string>",
      "checkOutTimezone": "<string>",
      "encounterNumber": "<string>",
      "enterpriseId": "<string>",
      "id": "<string>",
      "isLocked": "<string>",
      "isSensitive": "<string>",
      "locationId": "<string>",
      "locationName": "<string>",
      "personId": "<string>",
      "practiceId": "<string>",
      "printOnStatements": "<string>",
      "referringProviderId": "<string>",
      "referringProviderName": "<string>",
      "renderingProviderId": "<string>",
      "renderingProviderName": "<string>",
      "status": "<string>",
      "suppressOutreach": "<string>",
      "suppressPortal": "<string>",
      "timestamp": "<string>",
      "timestampTimezone": "<string>"
    },
    {
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ],
      "checkInDateTime": "<string>",
      "checkInTimezone": "<string>",
      "checkOutDateTime": "<string>",
      "checkOutTimezone": "<string>",
      "encounterNumber": "<string>",
      "enterpriseId": "<string>",
      "id": "<string>",
      "isLocked": "<string>",
      "isSensitive": "<string>",
      "locationId": "<string>",
      "locationName": "<string>",
      "personId": "<string>",
      "practiceId": "<string>",
      "printOnStatements": "<string>",
      "referringProviderId": "<string>",
      "referringProviderName": "<string>",
      "renderingProviderId": "<string>",
      "renderingProviderName": "<string>",
      "status": "<string>",
      "suppressOutreach": "<string>",
      "suppressPortal": "<string>",
      "timestamp": "<string>",
      "timestampTimezone": "<string>"
    }
  ],
  "NextPageLink": "<string>"
}