GET api/PatientMedications/search?active={active}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of medications of a patient.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
active

Indicates whether to get the active medications or not.

boolean

Default value is True

page

Page number requested (search results are paginated).

integer

Default value is 1

itemsPerPage

Items to return on each page. See page parameter above.

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfPatientMedicationModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of PatientMedicationModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "PatientMedicationId": "04d669d7-c2d5-42c5-812f-53a8f640b2d8",
      "DoctorId": "fdb69a05-f7be-47bd-9694-fbc0697eccdf",
      "DoctorName": "sample string 2",
      "Active": true,
      "Name": "sample string 4",
      "Instructions": "sample string 5",
      "LastRefillRequest": "sample string 6",
      "LastRefillStatus": "sample string 7"
    },
    {
      "PatientMedicationId": "04d669d7-c2d5-42c5-812f-53a8f640b2d8",
      "DoctorId": "fdb69a05-f7be-47bd-9694-fbc0697eccdf",
      "DoctorName": "sample string 2",
      "Active": true,
      "Name": "sample string 4",
      "Instructions": "sample string 5",
      "LastRefillRequest": "sample string 6",
      "LastRefillStatus": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfPatientMedicationModely579f2rt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientMedications">
    <d2p1:PatientMedicationModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DoctorId>fdb69a05-f7be-47bd-9694-fbc0697eccdf</d2p1:DoctorId>
      <d2p1:DoctorName>sample string 2</d2p1:DoctorName>
      <d2p1:Instructions>sample string 5</d2p1:Instructions>
      <d2p1:LastRefillRequest>sample string 6</d2p1:LastRefillRequest>
      <d2p1:LastRefillStatus>sample string 7</d2p1:LastRefillStatus>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:PatientMedicationId>04d669d7-c2d5-42c5-812f-53a8f640b2d8</d2p1:PatientMedicationId>
    </d2p1:PatientMedicationModel>
    <d2p1:PatientMedicationModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DoctorId>fdb69a05-f7be-47bd-9694-fbc0697eccdf</d2p1:DoctorId>
      <d2p1:DoctorName>sample string 2</d2p1:DoctorName>
      <d2p1:Instructions>sample string 5</d2p1:Instructions>
      <d2p1:LastRefillRequest>sample string 6</d2p1:LastRefillRequest>
      <d2p1:LastRefillStatus>sample string 7</d2p1:LastRefillStatus>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:PatientMedicationId>04d669d7-c2d5-42c5-812f-53a8f640b2d8</d2p1:PatientMedicationId>
    </d2p1:PatientMedicationModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfPatientMedicationModely579f2rt>