GET api/PatientMedicationUpdates?patientMedicationUpdateRequestId={patientMedicationUpdateRequestId}&patientMedicationRecordId={patientMedicationRecordId}

Returns a patient medication.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientMedicationUpdateRequestId

Unique ID of patient medication update request.

 integer

None.
patientMedicationRecordId

Unique ID of patient medication record.

 integer

None.

Body Parameters

None.

Response Information

Resource Description

PatientMedicationUpdateRequestModel
NameDescriptionTypeAdditional information
PatientMedicationUpdateRequestId

Unique ID of the patient medication update request (Read Only).

 integer

None.
PatientMedicationRecordId

Unique ID of the patient medication record (Read Only).

 integer

None.
MedicationId

Unique ID of medication (Required).

 integer

None.
MedicationExternalId

ID of the medication in the integrating system.

 string

None.
MedicationName

Name of the medication.

 string

None.
MedicationDosageId

Unique ID of the medication dosage (Required).

 integer

None.
MedicationDosageExternalId

ID of the medication dosage in the integrating system.

 string

None.
MedicationDosageName

Name of the medication dosage.

 string

None.
MedicationFormTypeId

Unique ID of medication from type (Required).

 integer

None.
MedicationFormTypeExternalId

ID of the medication form type in the integrating system.

 string

None.
MedicationFormTypeName

Name of the medication form type.

 string

None.
MedicationFrequencyId

Unique ID of medication frequency (Required).

 integer

None.
MedicationFrequencyExternalId

ID of the medication frequency in the integrating system.

 string

None.
MedicationFrequencyName

Name of the medication frequency.

 string

None.
MedicationRouteId

Unique ID of medication route (Required).

 integer

None.
MedicationRouteExternalId

ID of the medication route in the integrating system.

 string

None.
MedicationRouteName

Name of the medication route.

 string

None.
StartDate

Start date of the medication.

 string

None.
EndDate

End date of the medication.

 string

None.
Notes

Comments about the medication.

 string

None.
EyeMedication

Indicates if mediation is for eye or non-eye (Required).

 boolean

None.
Operation

Indicates the type of operations. Possible values: Unchanged, Added, Updated, Deleted.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "PatientMedicationUpdateRequestId": 1,
  "PatientMedicationRecordId": 1,
  "MedicationId": 1,
  "MedicationExternalId": "sample string 1",
  "MedicationName": "sample string 2",
  "MedicationDosageId": 1,
  "MedicationDosageExternalId": "sample string 3",
  "MedicationDosageName": "sample string 4",
  "MedicationFormTypeId": 1,
  "MedicationFormTypeExternalId": "sample string 5",
  "MedicationFormTypeName": "sample string 6",
  "MedicationFrequencyId": 1,
  "MedicationFrequencyExternalId": "sample string 7",
  "MedicationFrequencyName": "sample string 8",
  "MedicationRouteId": 1,
  "MedicationRouteExternalId": "sample string 9",
  "MedicationRouteName": "sample string 10",
  "StartDate": "sample string 11",
  "EndDate": "sample string 12",
  "Notes": "sample string 13",
  "EyeMedication": true,
  "Operation": "sample string 15"
}

application/xml, text/xml

Sample: 
<PatientMedicationUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientMedications">
  <EndDate>sample string 12</EndDate>
  <EyeMedication>true</EyeMedication>
  <MedicationDosageExternalId>sample string 3</MedicationDosageExternalId>
  <MedicationDosageId>1</MedicationDosageId>
  <MedicationDosageName>sample string 4</MedicationDosageName>
  <MedicationExternalId>sample string 1</MedicationExternalId>
  <MedicationFormTypeExternalId>sample string 5</MedicationFormTypeExternalId>
  <MedicationFormTypeId>1</MedicationFormTypeId>
  <MedicationFormTypeName>sample string 6</MedicationFormTypeName>
  <MedicationFrequencyExternalId>sample string 7</MedicationFrequencyExternalId>
  <MedicationFrequencyId>1</MedicationFrequencyId>
  <MedicationFrequencyName>sample string 8</MedicationFrequencyName>
  <MedicationId>1</MedicationId>
  <MedicationName>sample string 2</MedicationName>
  <MedicationRouteExternalId>sample string 9</MedicationRouteExternalId>
  <MedicationRouteId>1</MedicationRouteId>
  <MedicationRouteName>sample string 10</MedicationRouteName>
  <Notes>sample string 13</Notes>
  <Operation>sample string 15</Operation>
  <PatientMedicationRecordId>1</PatientMedicationRecordId>
  <PatientMedicationUpdateRequestId>1</PatientMedicationUpdateRequestId>
  <StartDate>sample string 11</StartDate>
</PatientMedicationUpdateRequestModel>