IPrimeSuiteAPI REST API Documentation


PatientMedicationGet


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Patient/PatientMedicationGet

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MedicationGetRequest>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
  <PatientID>0</PatientID>
</MedicationGetRequest>

Request Json Example (schema):

{
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  },
  "PatientID": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MedicationGetResponse>
  <PatientMedictions>
    <SIG>String Content</SIG>
    <DateStarted>0001-01-01T00:00:00</DateStarted>
    <ExpiredDate>0001-01-01T00:00:00</ExpiredDate>
    <Medication>
      <MedicationName>String Content</MedicationName>
      <DrugName>String Content</DrugName>
      <MedicationId>0</MedicationId>
      <MEDID>0</MEDID>
      <MedicationDescription>String Content</MedicationDescription>
      <NameType>String Content</NameType>
      <DoseFormID>0</DoseFormID>
      <DoseForm>String Content</DoseForm>
      <RouteID>0</RouteID>
      <Route>String Content</Route>
      <SIG>String Content</SIG>
      <NumRefills>String Content</NumRefills>
      <DoseQuantity>String Content</DoseQuantity>
      <ManExist>String Content</ManExist>
      <DispenseAmount>String Content</DispenseAmount>
      <FrequencyCode>String Content</FrequencyCode>
      <FreqDescription>String Content</FreqDescription>
      <InterUnitID>0</InterUnitID>
      <Interval>0</Interval>
      <DurationUnitID>0</DurationUnitID>
      <DurationUnit>String Content</DurationUnit>
      <ShowDuration>String Content</ShowDuration>
      <IndAvail>String Content</IndAvail>
      <Duration>String Content</Duration>
      <GCNSeqNo>0</GCNSeqNo>
      <MedicationStrength>String Content</MedicationStrength>
      <MedicationStrengthUnit>String Content</MedicationStrengthUnit>
      <DEACode>String Content</DEACode>
      <RMID>0</RMID>
      <Calculate>String Content</Calculate>
      <DispenseUnit>String Content</DispenseUnit>
      <OSID>0</OSID>
      <SIGModeID>0</SIGModeID>
      <OptionNumber>0</OptionNumber>
      <DoseRouteID>0</DoseRouteID>
      <DoseRoute>String Content</DoseRoute>
      <DoseUnitID>0</DoseUnitID>
      <UseForm>String Content</UseForm>
      <Prospective>String Content</Prospective>
      <DispenseAsWritten>0</DispenseAsWritten>
      <SampleGiven>0</SampleGiven>
      <AdministeredInOffice>0</AdministeredInOffice>
      <External>0</External>
      <StatusID>0</StatusID>
      <uid>0</uid>
      <Notify>0</Notify>
      <NotifyCareProviderID>0</NotifyCareProviderID>
      <NotifyCareProviderID2>0</NotifyCareProviderID2>
      <Class1>0</Class1>
      <ActionID>0</ActionID>
      <Dosage>String Content</Dosage>
      <DosageUnits>String Content</DosageUnits>
      <DrugNameID>String Content</DrugNameID>
      <MNID>String Content</MNID>
      <HowOftenTaken>String Content</HowOftenTaken>
      <HowTaken>String Content</HowTaken>
      <Maintenance>String Content</Maintenance>
      <PackageType>String Content</PackageType>
    </Medication>
    <OrderingDocumentID>0</OrderingDocumentID>
    <OriginalPatientMedicationID>0</OriginalPatientMedicationID>
    <PatientMedicationId>0</PatientMedicationId>
    <FillStatus>String Content</FillStatus>
    <FillStatusID>0</FillStatusID>
    <FillStatusReason>String Content</FillStatusReason>
    <FillStatusReasonID>0</FillStatusReasonID>
  </PatientMedictions>
</MedicationGetResponse>

Response Format: Json

Response Example (schema):

Could not generate example for response. Failed with error: Specified cast is not valid.