IPrimeSuiteAPI REST API Documentation


PrescriptionHistoryGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PrescriptionHistoryGetRequest>
  <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>
  <ClinicalPatMedIDs>
    <ClinicalPatMedID>0</ClinicalPatMedID>
  </ClinicalPatMedIDs>
  <PatientID>0</PatientID>
  <PageSize>0</PageSize>
  <PageStart>0</PageStart>
</PrescriptionHistoryGetRequest>

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"
    }
  },
  "ClinicalPatMedIDs": [
    {
      "ClinicalPatMedID": 0
    }
  ],
  "PatientID": 0,
  "PageSize": 0,
  "PageStart": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PrescriptionHistoryGetResponse>
  <PatientPrescriptionHistories>
    <PrescriptionHistories>
      <ClinicalPatMeds>
        <CreateDate>String Content</CreateDate>
        <DiscontinuedReasonID>0</DiscontinuedReasonID>
        <RemovalReasonID>0</RemovalReasonID>
        <ClinicalPatMedID>0</ClinicalPatMedID>
        <OriginalPatMedID>0</OriginalPatMedID>
        <ParentID>0</ParentID>
        <UserName>String Content</UserName>
        <Status>String Content</Status>
        <PrescriptionStatus>String Content</PrescriptionStatus>
        <StartDT>String Content</StartDT>
        <ExpireDate>String Content</ExpireDate>
        <EffectiveDT>String Content</EffectiveDT>
        <SupervisorID>0</SupervisorID>
        <Comment>String Content</Comment>
        <UserID>0</UserID>
        <ValidScript>0</ValidScript>
        <CareProviderID>0</CareProviderID>
        <CareProviderName>String Content</CareProviderName>
        <PrintedDate>String Content</PrintedDate>
        <EPrescribedDate>String Content</EPrescribedDate>
        <PharmacyVerified>String Content</PharmacyVerified>
        <PharmacyID>0</PharmacyID>
        <PharmacyName>String Content</PharmacyName>
        <PharmacyNote>String Content</PharmacyNote>
        <SendMethod>String Content</SendMethod>
        <SentDate>String Content</SentDate>
        <DiscontinuedDate>String Content</DiscontinuedDate>
        <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>
        <Vital>
          <SPO2>String Content</SPO2>
          <BloodPressureDiastolic>0</BloodPressureDiastolic>
          <BloodPressurePosition>String Content</BloodPressurePosition>
          <BloodPressureSystolic>0</BloodPressureSystolic>
          <CuffSize>String Content</CuffSize>
          <DateTimeTaken>0001-01-01T00:00:00</DateTimeTaken>
          <HeadCircumference>String Content</HeadCircumference>
          <HeartRate>0</HeartRate>
          <HeartRateRegularity>String Content</HeartRateRegularity>
          <Height>0</Height>
          <Laterality>String Content</Laterality>
          <Resprate>0</Resprate>
          <Temperature>0</Temperature>
          <TemperatureMethod>String Content</TemperatureMethod>
          <UserID>0</UserID>
          <UserName>String Content</UserName>
          <VitalGroupID>0</VitalGroupID>
          <VitalID>0</VitalID>
          <VitalSite>String Content</VitalSite>
          <Weight>0</Weight>
          <OxygenDevice>0</OxygenDevice>
          <FractionOfInspiredOxygen>0</FractionOfInspiredOxygen>
          <OxygenFlowRate>0</OxygenFlowRate>
          <IsOrthostatic>false</IsOrthostatic>
        </Vital>
        <Indication>
          <Code>String Content</Code>
          <Description>String Content</Description>
        </Indication>
        <PrescriptionAlerts>
          <OverrideReasonID>0</OverrideReasonID>
          <AlertType>String Content</AlertType>
          <ScreenMessage>String Content</ScreenMessage>
          <OverrideReasonDescription>String Content</OverrideReasonDescription>
        </PrescriptionAlerts>
        <RemovalReason>String Content</RemovalReason>
        <DiscontinuedReason>String Content</DiscontinuedReason>
        <ERXStatus>String Content</ERXStatus>
        <FillStatus>String Content</FillStatus>
        <FillStatusID>0</FillStatusID>
        <FillStatusReason>String Content</FillStatusReason>
        <FillStatusReasonID>0</FillStatusReasonID>
      </ClinicalPatMeds>
    </PrescriptionHistories>
  </PatientPrescriptionHistories>
</PrescriptionHistoryGetResponse>

Response Format: Json

Response Example (schema):

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