v1

latestSwagger 2.02026-08-061791731.4 MB

Patient Demographics

{{baseUrl}}/persons/:personId/chart/encounters

While this route does not directly return USCDI data, knowledge of an encounterId is sometimes necessary to utilize other routes to obtain USCDI data.

This route returns a list of encounters (each identified by "id", which in all other routes will be an {encounterId} whose value is a guid) for the specified person id after applying additional OData query operations.

get/persons/{personId}/chart/encounters

Path parameters

personIdstring required

(Required) (Required) The id of the patient whose encounters are being retrieved

Query parameters

$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>"
}