v1

latestSwagger 2.02026-08-061791731.4 MB

Medications

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

Gets a list of patient medication for the specified person id and encounter id after applying additional OData query operations.

get/persons/{personId}/chart/encounters/{encounterId}/medications

Path parameters

personIdstring required

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

encounterIdstring required

(Required) (Required) The id of the encounter for which the medications are retrieved

Query parameters

$topstring required

$filterstring required

$orderbystring required

$skipstring required

$inlinecountstring required

$countstring required

Headers

Acceptstring required

Response

NextPageLinkstring required

Countstring required

Example response

{
  "Items": [
    {
      "id": "<string>",
      "personId": "<string>",
      "providerId": "<string>",
      "fdbName": "<string>",
      "medicationName": "<string>",
      "genericName": "<string>",
      "brandName": "<string>",
      "isGenericSelected": "<string>",
      "dose": "<string>",
      "route": "<string>",
      "doseForm": "<string>",
      "originalStartDate": "<string>",
      "startDate": "<string>",
      "stopDate": "<string>",
      "sigDescription": "<string>",
      "enterpriseId": "<string>",
      "practiceId": "<string>",
      "encounterId": "<string>",
      "sourceProductId": "<string>",
      "lastAuditType": "<string>",
      "representativeNdcIndicator": "<string>",
      "privacyIndicator": "<string>",
      "isHidden": "<string>",
      "deaClassCode": "<string>",
      "medicationId": "<string>",
      "ndcId": "<string>",
      "createTimestamp": "<string>",
      "createTimestampTimezone": "<string>",
      "rxNormCode": "<string>",
      "status": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    },
    {
      "id": "<string>",
      "personId": "<string>",
      "providerId": "<string>",
      "fdbName": "<string>",
      "medicationName": "<string>",
      "genericName": "<string>",
      "brandName": "<string>",
      "isGenericSelected": "<string>",
      "dose": "<string>",
      "route": "<string>",
      "doseForm": "<string>",
      "originalStartDate": "<string>",
      "startDate": "<string>",
      "stopDate": "<string>",
      "sigDescription": "<string>",
      "enterpriseId": "<string>",
      "practiceId": "<string>",
      "encounterId": "<string>",
      "sourceProductId": "<string>",
      "lastAuditType": "<string>",
      "representativeNdcIndicator": "<string>",
      "privacyIndicator": "<string>",
      "isHidden": "<string>",
      "deaClassCode": "<string>",
      "medicationId": "<string>",
      "ndcId": "<string>",
      "createTimestamp": "<string>",
      "createTimestampTimezone": "<string>",
      "rxNormCode": "<string>",
      "status": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    }
  ],
  "NextPageLink": "<string>",
  "Count": "<string>"
}