Sign in

v1

latestSwagger 2.02026-08-061791731.4 MB
Clinical Notes

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

Gets a list of documents for the specified person id after performing additional OData query operations.

get/persons/{personId}/chart/documents

Path parameters

personIdstring required

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

Query parameters

$topstring required
$filterstring required
$orderbystring required
$skipstring required
$inlinecountstring required
$countstring required

Headers

Acceptstring required

Response

OK

idstring required
personIdstring required
descriptionstring required
itemTypestring required
createTimestampstring required
createTimestampTimezonestring required
modifyTimestampstring required
modifyTimestampTimezonestring required
encounterIdstring required
isRestrictedstring required
signoffStatusstring required

Example response

{
  "id": "<string>",
  "personId": "<string>",
  "description": "<string>",
  "itemType": "<string>",
  "createTimestamp": "<string>",
  "createTimestampTimezone": "<string>",
  "modifyTimestamp": "<string>",
  "modifyTimestampTimezone": "<string>",
  "encounterId": "<string>",
  "isRestricted": "<string>",
  "signoffStatus": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}