v1

latestSwagger 2.02026-08-061791731.4 MB

Clinical Notes

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

Gets the document details for the given person id and document id.

get/persons/{personId}/chart/documents/{documentId}

Path parameters

personIdstring required

(Required) (Required) The id of the patient whose document is being retrieved

documentIdstring required

(Required) (Required) The id of the document being retrieved

Headers

Acceptstring required

Response

idstring required

personIdstring required

descriptionstring required

itemTypestring required

createTimestampstring required

createTimestampTimezonestring required

modifyTimestampstring required

modifyTimestampTimezonestring required

encounterIdstring required

categoriesstring[] required

totalPagesstring required

icsDateOfServicestring required

encounterTimestampstring required

appCreatedBystring required

docTypeIdstring 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>",
  "categories": [
    "<string>",
    "<string>"
  ],
  "totalPages": "<string>",
  "icsDateOfService": "<string>",
  "encounterTimestamp": "<string>",
  "appCreatedBy": "<string>",
  "docTypeId": "<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>"
    }
  ]
}