IPrimeSuiteAPI REST API Documentation


MedicationAlertGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MedicationAlertGetRequest>
  <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>
  <Medications>
    <MEDID>String Content</MEDID>
    <MedicationName>String Content</MedicationName>
    <MedicationStrength>String Content</MedicationStrength>
    <MedicationStrengthUnit>String Content</MedicationStrengthUnit>
    <Route>String Content</Route>
    <DoseForm>String Content</DoseForm>
    <MNID>String Content</MNID>
    <Indication>
      <Code>String Content</Code>
      <Description>String Content</Description>
    </Indication>
    <DoseQuantity>String Content</DoseQuantity>
    <DispenseUnit>String Content</DispenseUnit>
    <OrderString>String Content</OrderString>
    <FrequencyCode>String Content</FrequencyCode>
  </Medications>
  <IsCheckInteraction>false</IsCheckInteraction>
</MedicationAlertGetRequest>

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,
  "Medications": [
    {
      "MEDID": "String Content",
      "MedicationName": "String Content",
      "MedicationStrength": "String Content",
      "MedicationStrengthUnit": "String Content",
      "Route": "String Content",
      "DoseForm": "String Content",
      "MNID": "String Content",
      "Indication": {
        "Code": "String Content",
        "Description": "String Content"
      },
      "DoseQuantity": "String Content",
      "DispenseUnit": "String Content",
      "OrderString": "String Content",
      "FrequencyCode": "String Content"
    }
  ],
  "IsCheckInteraction": false
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MedicationAlertGetResponse>
  <MedicationAlerts>
    <MedicationName>String Content</MedicationName>
    <Count>0</Count>
    <MsgCount>0</MsgCount>
    <PREGScreenResults>
      <AddComment>String Content</AddComment>
      <Description>String Content</Description>
      <DrugDescription>String Content</DrugDescription>
      <ScreenMessage>String Content</ScreenMessage>
      <SignificanceLevelCode>String Content</SignificanceLevelCode>
      <SignificanceLevelOld>String Content</SignificanceLevelOld>
      <SignificanceLevel>String Content</SignificanceLevel>
      <MyOrderBy>String Content</MyOrderBy>
    </PREGScreenResults>
    <LACTScreenResults>
      <AddComment>String Content</AddComment>
      <Description>String Content</Description>
      <DrugDescription>String Content</DrugDescription>
      <ExcretionEffectCode>String Content</ExcretionEffectCode>
      <ExcretionEffect>String Content</ExcretionEffect>
      <LactationEffectCode>String Content</LactationEffectCode>
      <LactationEffect>String Content</LactationEffect>
      <ScreenMessage>String Content</ScreenMessage>
      <SeverityLevelCode>String Content</SeverityLevelCode>
      <SeverityLevelOld>String Content</SeverityLevelOld>
      <SeverityLevel>String Content</SeverityLevel>
    </LACTScreenResults>
    <DrugToFoodResults>
      <AdviceMessage>String Content</AdviceMessage>
      <ClinicalResult>String Content</ClinicalResult>
      <DrugDescription>String Content</DrugDescription>
      <Interator>String Content</Interator>
      <Significance>String Content</Significance>
      <SignificanceLevel>String Content</SignificanceLevel>
      <ScreenMessage>String Content</ScreenMessage>
    </DrugToFoodResults>
    <BadItems>
      <Type>String Content</Type>
      <ID>String Content</ID>
      <Caption>String Content</Caption>
      <Reason>String Content</Reason>
    </BadItems>
    <DDCMScreenResults>
      <DrugDescription1>String Content</DrugDescription1>
      <ConditionDescription>String Content</ConditionDescription>
      <ConditionID>String Content</ConditionID>
      <DescriptionDisease>String Content</DescriptionDisease>
      <DescriptionDrug>String Content</DescriptionDrug>
      <DrugDescription>String Content</DrugDescription>
      <HitConditionDescription>String Content</HitConditionDescription>
      <ScreenMessage>String Content</ScreenMessage>
      <SeverityLevelCode>String Content</SeverityLevelCode>
      <SeverityLevel>String Content</SeverityLevel>
    </DDCMScreenResults>
    <DosageResults>
      <SingleDoseStatus>String Content</SingleDoseStatus>
      <SingleDoseMessage>String Content</SingleDoseMessage>
      <FrequencyStatus>String Content</FrequencyStatus>
      <FrequencyMessage>String Content</FrequencyMessage>
      <DurationStatus>String Content</DurationStatus>
      <DrugDescription>String Content</DrugDescription>
      <DoseSource>String Content</DoseSource>
      <DailyDoseStatus>String Content</DailyDoseStatus>
      <DailyDoseMessage>String Content</DailyDoseMessage>
      <DurationMessage>String Content</DurationMessage>
      <Messages>
        <ClinicalPatmedID>String Content</ClinicalPatmedID>
        <Source>String Content</Source>
        <Severity>String Content</Severity>
        <DrugDescription>String Content</DrugDescription>
        <MessageType>String Content</MessageType>
        <Text>String Content</Text>
      </Messages>
    </DosageResults>
    <GERIScreenResults>
      <AddComment>String Content</AddComment>
      <Description>String Content</Description>
      <DrugDescription>String Content</DrugDescription>
      <ScreenMessage>String Content</ScreenMessage>
      <SeverityLevelCode>String Content</SeverityLevelCode>
      <SeverityLevelOld>String Content</SeverityLevelOld>
      <SeverityLevel>String Content</SeverityLevel>
      <SystemCardioInd>String Content</SystemCardioInd>
      <SystemEndoInd>String Content</SystemEndoInd>
      <SystemHepaticInd>String Content</SystemHepaticInd>
      <SystemNeuroInd>String Content</SystemNeuroInd>
      <SystemPulmInd>String Content</SystemPulmInd>
      <SystemRenalInd>String Content</SystemRenalInd>
    </GERIScreenResults>
    <AllergyResults>
      <AllergyDescription>String Content</AllergyDescription>
      <DrugDescription>String Content</DrugDescription>
      <Reaction>String Content</Reaction>
      <ScreenMessage>String Content</ScreenMessage>
      <NonAllResponse>String Content</NonAllResponse>
      <Matchdescription>String Content</Matchdescription>
      <MatchType>String Content</MatchType>
    </AllergyResults>
    <DrugToDrugResults>
      <Drug1Description>String Content</Drug1Description>
      <Drug2Description>String Content</Drug2Description>
      <InteractionDescription>String Content</InteractionDescription>
      <ScreenMessage>String Content</ScreenMessage>
      <Severity>String Content</Severity>
      <SeverityLevel>String Content</SeverityLevel>
      <ClinicalEffect>String Content</ClinicalEffect>
      <ClinicalEffect2>String Content</ClinicalEffect2>
      <EDIPageReference>String Content</EDIPageReference>
    </DrugToDrugResults>
    <PEDIScreenResults>
      <AddComment>String Content</AddComment>
      <Description>String Content</Description>
      <DrugDescription>String Content</DrugDescription>
      <ScreenMessage>String Content</ScreenMessage>
      <SeverityLevelCode>String Content</SeverityLevelCode>
      <SeverityLevelOld>String Content</SeverityLevelOld>
      <SeverityLevel>String Content</SeverityLevel>
      <AgeInDaysHigh>String Content</AgeInDaysHigh>
      <AgeInDaysLow>String Content</AgeInDaysLow>
    </PEDIScreenResults>
    <DuplicateTherapy>
      <ScreenMessage>String Content</ScreenMessage>
      <ClassDecscription>String Content</ClassDecscription>
      <ClassID>String Content</ClassID>
      <Allowance>String Content</Allowance>
    </DuplicateTherapy>
    <DEAAlert>
      <ScreenMessage>String Content</ScreenMessage>
    </DEAAlert>
  </MedicationAlerts>
</MedicationAlertGetResponse>

Response Format: Json

Response Example (schema):

{
  "MedicationAlerts": [
    {
      "MedicationName": "String Content",
      "Count": 0,
      "MsgCount": 0,
      "PREGScreenResults": [
        {
          "AddComment": "String Content",
          "Description": "String Content",
          "DrugDescription": "String Content",
          "ScreenMessage": "String Content",
          "SignificanceLevelCode": "String Content",
          "SignificanceLevelOld": "String Content",
          "SignificanceLevel": "String Content",
          "MyOrderBy": "String Content"
        }
      ],
      "LACTScreenResults": [
        {
          "AddComment": "String Content",
          "Description": "String Content",
          "DrugDescription": "String Content",
          "ExcretionEffectCode": "String Content",
          "ExcretionEffect": "String Content",
          "LactationEffectCode": "String Content",
          "LactationEffect": "String Content",
          "ScreenMessage": "String Content",
          "SeverityLevelCode": "String Content",
          "SeverityLevelOld": "String Content",
          "SeverityLevel": "String Content"
        }
      ],
      "DrugToFoodResults": [
        {
          "AdviceMessage": "String Content",
          "ClinicalResult": "String Content",
          "DrugDescription": "String Content",
          "Interator": "String Content",
          "Significance": "String Content",
          "SignificanceLevel": "String Content",
          "ScreenMessage": "String Content"
        }
      ],
      "BadItems": [
        {
          "Type": "String Content",
          "ID": "String Content",
          "Caption": "String Content",
          "Reason": "String Content"
        }
      ],
      "DDCMScreenResults": [
        {
          "DrugDescription1": "String Content",
          "ConditionDescription": "String Content",
          "ConditionID": "String Content",
          "DescriptionDisease": "String Content",
          "DescriptionDrug": "String Content",
          "DrugDescription": "String Content",
          "HitConditionDescription": "String Content",
          "ScreenMessage": "String Content",
          "SeverityLevelCode": "String Content",
          "SeverityLevel": "String Content"
        }
      ],
      "DosageResults": [
        {
          "SingleDoseStatus": "String Content",
          "SingleDoseMessage": "String Content",
          "FrequencyStatus": "String Content",
          "FrequencyMessage": "String Content",
          "DurationStatus": "String Content",
          "DrugDescription": "String Content",
          "DoseSource": "String Content",
          "DailyDoseStatus": "String Content",
          "DailyDoseMessage": "String Content",
          "DurationMessage": "String Content",
          "Messages": [
            {
              "ClinicalPatmedID": "String Content",
              "Source": "String Content",
              "Severity": "String Content",
              "DrugDescription": "String Content",
              "MessageType": "String Content",
              "Text": "String Content"
            }
          ]
        }
      ],
      "GERIScreenResults": [
        {
          "AddComment": "String Content",
          "Description": "String Content",
          "DrugDescription": "String Content",
          "ScreenMessage": "String Content",
          "SeverityLevelCode": "String Content",
          "SeverityLevelOld": "String Content",
          "SeverityLevel": "String Content",
          "SystemCardioInd": "String Content",
          "SystemEndoInd": "String Content",
          "SystemHepaticInd": "String Content",
          "SystemNeuroInd": "String Content",
          "SystemPulmInd": "String Content",
          "SystemRenalInd": "String Content"
        }
      ],
      "AllergyResults": [
        {
          "AllergyDescription": "String Content",
          "DrugDescription": "String Content",
          "Reaction": "String Content",
          "ScreenMessage": "String Content",
          "NonAllResponse": "String Content",
          "Matchdescription": "String Content",
          "MatchType": "String Content"
        }
      ],
      "DrugToDrugResults": [
        {
          "Drug1Description": "String Content",
          "Drug2Description": "String Content",
          "InteractionDescription": "String Content",
          "ScreenMessage": "String Content",
          "Severity": "String Content",
          "SeverityLevel": "String Content",
          "ClinicalEffect": "String Content",
          "ClinicalEffect2": "String Content",
          "EDIPageReference": "String Content"
        }
      ],
      "PEDIScreenResults": [
        {
          "AddComment": "String Content",
          "Description": "String Content",
          "DrugDescription": "String Content",
          "ScreenMessage": "String Content",
          "SeverityLevelCode": "String Content",
          "SeverityLevelOld": "String Content",
          "SeverityLevel": "String Content",
          "AgeInDaysHigh": "String Content",
          "AgeInDaysLow": "String Content"
        }
      ],
      "DuplicateTherapy": [
        {
          "ScreenMessage": "String Content",
          "ClassDecscription": "String Content",
          "ClassID": "String Content",
          "Allowance": "String Content"
        }
      ],
      "DEAAlert": {
        "ScreenMessage": "String Content"
      }
    }
  ]
}