IPrimeSuiteAPI REST API Documentation


PatientHistoriesGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<HistoryGetRequest>
  <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>
</HistoryGetRequest>

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"?>
<HistoryGetResponse>
  <Reproductive>
    <MenstrualHistory>
      <TamponNumber>0</TamponNumber>
      <PregnancyTestOffice>7</PregnancyTestOffice>
      <PregnancyTestHome>3</PregnancyTestHome>
      <PadNumber>0</PadNumber>
      <OnHRT>false</OnHRT>
      <MenstrualHistoryID>0</MenstrualHistoryID>
      <MensesDuration>0</MensesDuration>
      <MenopauseStatus>2</MenopauseStatus>
      <MenarcheAge>0</MenarcheAge>
      <AgeMenopause>0</AgeMenopause>
      <LastMenstrualPeriodCertainty>String Content</LastMenstrualPeriodCertainty>
      <LastMenstrualPeriod>0001-01-01T00:00:00</LastMenstrualPeriod>
      <CycleInterval>0</CycleInterval>
      <Clots>false</Clots>
      <BreakThroughBleeding>false</BreakThroughBleeding>
      <MethodOfBirthControl>9</MethodOfBirthControl>
      <Flow>1</Flow>
    </MenstrualHistory>
    <PregnancyHistory>
      <PreMatureCount>0</PreMatureCount>
      <PregnancyHistoryDetails>
        <Complications>false</Complications>
        <Note>String Content</Note>
        <Location>String Content</Location>
        <PreTermLabor>false</PreTermLabor>
        <TypeOfDelivery>1</TypeOfDelivery>
        <PregnancyHistoryDetailID>0</PregnancyHistoryDetailID>
        <HourLabour>0</HourLabour>
        <Gender>0</Gender>
        <GA>0</GA>
        <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
        <BirthWeight>String Content</BirthWeight>
        <Anesthesia>5</Anesthesia>
      </PregnancyHistoryDetails>
      <PregnancyCount>0</PregnancyCount>
      <MultiplesCount>0</MultiplesCount>
      <LivingCount>0</LivingCount>
      <FullTermCount>0</FullTermCount>
      <EctopicsCount>0</EctopicsCount>
      <BirthOrder>0</BirthOrder>
      <AbSpontaneousCount>0</AbSpontaneousCount>
      <AbInducedCount>0</AbInducedCount>
    </PregnancyHistory>
  </Reproductive>
  <Histories>
    <DateOnSet>String Content</DateOnSet>
    <PL>String Content</PL>
    <SectionDescription>String Content</SectionDescription>
    <SectionID>0</SectionID>
    <CategoryDescription>String Content</CategoryDescription>
    <Caption>String Content</Caption>
    <CategoryID>0</CategoryID>
    <Code>String Content</Code>
    <CodeSystem>String Content</CodeSystem>
    <CreateDate>0001-01-01T00:00:00</CreateDate>
    <CreateByID>0</CreateByID>
    <HistoryItemID>0</HistoryItemID>
    <LastChangedID>0</LastChangedID>
    <lastChangedName>String Content</lastChangedName>
    <Note>String Content</Note>
    <Problem>
      <ProblemStatus>1001</ProblemStatus>
      <ProblemListID>0</ProblemListID>
      <PatientID>0</PatientID>
      <LastChargedDate>0001-01-01T00:00:00</LastChargedDate>
      <LastChargedByUserID>0</LastChargedByUserID>
      <Section>String Content</Section>
      <DateResolved>String Content</DateResolved>
      <ProblemID>0</ProblemID>
      <Description>String Content</Description>
      <Type>String Content</Type>
      <Category>String Content</Category>
      <Modifiers>0</Modifiers>
    </Problem>
    <HistoryItemCodes>
      <Code>String Content</Code>
      <CodeSystem>String Content</CodeSystem>
    </HistoryItemCodes>
  </Histories>
  <Medications>
    <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>
  </Medications>
  <Vitals>
    <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>
  </Vitals>
</HistoryGetResponse>

Response Format: Json

Response Example (schema):

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