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

Returns a list of medications of a patient.

Request Information

URI Parameters

Name	Description	Type	Additional 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

Name	Type	Additional 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": "02960795-f121-4702-8b2a-8bd5212b8db3",
      "DoctorId": "c7f98d4e-b236-4d7e-859a-f168a1c0df8d",
      "DoctorName": "sample string 2",
      "Active": true,
      "Name": "sample string 4",
      "Instructions": "sample string 5",
      "LastRefillRequest": "sample string 6",
      "LastRefillStatus": "sample string 7"
    },
    {
      "PatientMedicationId": "02960795-f121-4702-8b2a-8bd5212b8db3",
      "DoctorId": "c7f98d4e-b236-4d7e-859a-f168a1c0df8d",
      "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>c7f98d4e-b236-4d7e-859a-f168a1c0df8d</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>02960795-f121-4702-8b2a-8bd5212b8db3</d2p1:PatientMedicationId>
    </d2p1:PatientMedicationModel>
    <d2p1:PatientMedicationModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DoctorId>c7f98d4e-b236-4d7e-859a-f168a1c0df8d</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>02960795-f121-4702-8b2a-8bd5212b8db3</d2p1:PatientMedicationId>
    </d2p1:PatientMedicationModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfPatientMedicationModely579f2rt>