IPrimeSuiteAPI REST API Documentation


PrescriptionActionHxListGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

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

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,
  "PageSize": 0,
  "PageStart": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PrescriptionActionHxListGetResponse>
  <PrescriptionActionHxs>
    <RXBGroupID>0</RXBGroupID>
    <TemplateID>0</TemplateID>
    <TemplateVersionID>0</TemplateVersionID>
    <FormatName>String Content</FormatName>
    <PrintDate>String Content</PrintDate>
    <DrugName>String Content</DrugName>
    <UserName>String Content</UserName>
    <EPrescribed>0</EPrescribed>
    <PrinterName>String Content</PrinterName>
    <InterfaceEventID>0</InterfaceEventID>
    <ClinicalPatMedID>0</ClinicalPatMedID>
    <InterfaceEventTypeID>0</InterfaceEventTypeID>
    <eRxRequestStatus>0</eRxRequestStatus>
  </PrescriptionActionHxs>
  <TotalRows>0</TotalRows>
</PrescriptionActionHxListGetResponse>

Response Format: Json

Response Example (schema):

{
  "PrescriptionActionHxs": [
    {
      "RXBGroupID": 0,
      "TemplateID": 0,
      "TemplateVersionID": 0,
      "FormatName": "String Content",
      "PrintDate": "String Content",
      "DrugName": "String Content",
      "UserName": "String Content",
      "EPrescribed": 0,
      "PrinterName": "String Content",
      "InterfaceEventID": 0,
      "ClinicalPatMedID": 0,
      "InterfaceEventTypeID": 0,
      "eRxRequestStatus": 0
    }
  ],
  "TotalRows": 0
}