IPrimeSuiteAPI REST API Documentation


MedicationDiscontinueSave


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MedicationDiscontinueSaveRequest>
  <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>
  <DiscontinueMedication>
    <RemoveFromActiveMedication>0</RemoveFromActiveMedication>
    <PatientID>0</PatientID>
    <CareProviderID>0</CareProviderID>
    <ClinicalPatMedID>0</ClinicalPatMedID>
    <RemovalReason>0</RemovalReason>
    <RemovalDate>String Content</RemovalDate>
    <DiscontinuedComment>String Content</DiscontinuedComment>
    <AllergicReactionNotes>String Content</AllergicReactionNotes>
    <AdverseEventNotes>String Content</AdverseEventNotes>
    <DrugNameID>0</DrugNameID>
    <DrugName>String Content</DrugName>
  </DiscontinueMedication>
</MedicationDiscontinueSaveRequest>

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"
    }
  },
  "DiscontinueMedication": {
    "RemoveFromActiveMedication": 0,
    "PatientID": 0,
    "CareProviderID": 0,
    "ClinicalPatMedID": 0,
    "RemovalReason": 0,
    "RemovalDate": "String Content",
    "DiscontinuedComment": "String Content",
    "AllergicReactionNotes": "String Content",
    "AdverseEventNotes": "String Content",
    "DrugNameID": 0,
    "DrugName": "String Content"
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MedicationDiscontinueSaveResponse>
  <ClinicalPatMedID>0</ClinicalPatMedID>
  <DiscontinuedStatus>String Content</DiscontinuedStatus>
</MedicationDiscontinueSaveResponse>

Response Format: Json

Response Example (schema):

{
  "ClinicalPatMedID": 0,
  "DiscontinuedStatus": "String Content"
}