Patient Web Service

Patient

Click here for a complete list of operations.

GetPatientFullMedicationHistory2

Refer to the Ensora eRx Update1 category of web services for newer versions of this web method.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v7/WebServices/Patient.asmx HTTP/1.1
Host: preproduction.newcropaccounts.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://secure.newcropaccounts.com/V7/webservices/GetPatientFullMedicationHistory2"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPatientFullMedicationHistory2 xmlns="https://secure.newcropaccounts.com/V7/webservices">
      <credentials>
        <PartnerName>string</PartnerName>
        <Name>string</Name>
        <Password>string</Password>
      </credentials>
      <accountRequest>
        <AccountId>string</AccountId>
        <SiteId>string</SiteId>
      </accountRequest>
      <patientRequest>
        <PatientId>string</PatientId>
      </patientRequest>
      <prescriptionHistoryRequest>
        <StartHistory>dateTime</StartHistory>
        <EndHistory>dateTime</EndHistory>
        <PrescriptionStatus>string</PrescriptionStatus>
        <PrescriptionSubStatus>string</PrescriptionSubStatus>
        <PrescriptionArchiveStatus>string</PrescriptionArchiveStatus>
      </prescriptionHistoryRequest>
      <patientInformationRequester>
        <UserType>string</UserType>
        <UserId>string</UserId>
      </patientInformationRequester>
    </GetPatientFullMedicationHistory2>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPatientFullMedicationHistory2Response xmlns="https://secure.newcropaccounts.com/V7/webservices">
      <GetPatientFullMedicationHistory2Result>
        <result>
          <Status>Unknown or OK or Fail or NotFound</Status>
          <Message>string</Message>
          <XmlResponse>string</XmlResponse>
          <RowCount>int</RowCount>
          <Timing>int</Timing>
        </result>
        <patientDrugDetail>
          <PatientDrugDetail2>
            <AccountName>string</AccountName>
            <ExternalAccountID>string</ExternalAccountID>
            <SiteID>string</SiteID>
            <FullName>string</FullName>
            <ExternalPatientID>string</ExternalPatientID>
            <PrescriptionDate>string</PrescriptionDate>
            <DrugID>string</DrugID>
            <DrugTypeID>string</DrugTypeID>
            <DrugName>string</DrugName>
            <Strength>string</Strength>
            <StrengthUOM>string</StrengthUOM>
            <DosageNumberDescription>string</DosageNumberDescription>
            <DosageForm>string</DosageForm>
            <Route>string</Route>
            <DosageFrequencyDescription>string</DosageFrequencyDescription>
            <Dispense>string</Dispense>
            <TakeAsNeeded>string</TakeAsNeeded>
            <DispenseAsWritten>string</DispenseAsWritten>
            <Refills>string</Refills>
            <Status>string</Status>
            <PrescriptionGuid>string</PrescriptionGuid>
            <OrderGuid>string</OrderGuid>
            <PrescriptionNotes>string</PrescriptionNotes>
            <ExternalPhysicianID>string</ExternalPhysicianID>
            <PhysicianName>string</PhysicianName>
            <DateMovedToPreviousMedications>string</DateMovedToPreviousMedications>
            <HealthPlanID>string</HealthPlanID>
            <HealthplanTypeID>string</HealthplanTypeID>
            <FormularyCoverage>string</FormularyCoverage>
            <FormularyStatus>string</FormularyStatus>
          </PatientDrugDetail2>
          <PatientDrugDetail2>
            <AccountName>string</AccountName>
            <ExternalAccountID>string</ExternalAccountID>
            <SiteID>string</SiteID>
            <FullName>string</FullName>
            <ExternalPatientID>string</ExternalPatientID>
            <PrescriptionDate>string</PrescriptionDate>
            <DrugID>string</DrugID>
            <DrugTypeID>string</DrugTypeID>
            <DrugName>string</DrugName>
            <Strength>string</Strength>
            <StrengthUOM>string</StrengthUOM>
            <DosageNumberDescription>string</DosageNumberDescription>
            <DosageForm>string</DosageForm>
            <Route>string</Route>
            <DosageFrequencyDescription>string</DosageFrequencyDescription>
            <Dispense>string</Dispense>
            <TakeAsNeeded>string</TakeAsNeeded>
            <DispenseAsWritten>string</DispenseAsWritten>
            <Refills>string</Refills>
            <Status>string</Status>
            <PrescriptionGuid>string</PrescriptionGuid>
            <OrderGuid>string</OrderGuid>
            <PrescriptionNotes>string</PrescriptionNotes>
            <ExternalPhysicianID>string</ExternalPhysicianID>
            <PhysicianName>string</PhysicianName>
            <DateMovedToPreviousMedications>string</DateMovedToPreviousMedications>
            <HealthPlanID>string</HealthPlanID>
            <HealthplanTypeID>string</HealthplanTypeID>
            <FormularyCoverage>string</FormularyCoverage>
            <FormularyStatus>string</FormularyStatus>
          </PatientDrugDetail2>
        </patientDrugDetail>
      </GetPatientFullMedicationHistory2Result>
    </GetPatientFullMedicationHistory2Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v7/WebServices/Patient.asmx HTTP/1.1
Host: preproduction.newcropaccounts.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetPatientFullMedicationHistory2 xmlns="https://secure.newcropaccounts.com/V7/webservices">
      <credentials>
        <PartnerName>string</PartnerName>
        <Name>string</Name>
        <Password>string</Password>
      </credentials>
      <accountRequest>
        <AccountId>string</AccountId>
        <SiteId>string</SiteId>
      </accountRequest>
      <patientRequest>
        <PatientId>string</PatientId>
      </patientRequest>
      <prescriptionHistoryRequest>
        <StartHistory>dateTime</StartHistory>
        <EndHistory>dateTime</EndHistory>
        <PrescriptionStatus>string</PrescriptionStatus>
        <PrescriptionSubStatus>string</PrescriptionSubStatus>
        <PrescriptionArchiveStatus>string</PrescriptionArchiveStatus>
      </prescriptionHistoryRequest>
      <patientInformationRequester>
        <UserType>string</UserType>
        <UserId>string</UserId>
      </patientInformationRequester>
    </GetPatientFullMedicationHistory2>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetPatientFullMedicationHistory2Response xmlns="https://secure.newcropaccounts.com/V7/webservices">
      <GetPatientFullMedicationHistory2Result>
        <result>
          <Status>Unknown or OK or Fail or NotFound</Status>
          <Message>string</Message>
          <XmlResponse>string</XmlResponse>
          <RowCount>int</RowCount>
          <Timing>int</Timing>
        </result>
        <patientDrugDetail>
          <PatientDrugDetail2>
            <AccountName>string</AccountName>
            <ExternalAccountID>string</ExternalAccountID>
            <SiteID>string</SiteID>
            <FullName>string</FullName>
            <ExternalPatientID>string</ExternalPatientID>
            <PrescriptionDate>string</PrescriptionDate>
            <DrugID>string</DrugID>
            <DrugTypeID>string</DrugTypeID>
            <DrugName>string</DrugName>
            <Strength>string</Strength>
            <StrengthUOM>string</StrengthUOM>
            <DosageNumberDescription>string</DosageNumberDescription>
            <DosageForm>string</DosageForm>
            <Route>string</Route>
            <DosageFrequencyDescription>string</DosageFrequencyDescription>
            <Dispense>string</Dispense>
            <TakeAsNeeded>string</TakeAsNeeded>
            <DispenseAsWritten>string</DispenseAsWritten>
            <Refills>string</Refills>
            <Status>string</Status>
            <PrescriptionGuid>string</PrescriptionGuid>
            <OrderGuid>string</OrderGuid>
            <PrescriptionNotes>string</PrescriptionNotes>
            <ExternalPhysicianID>string</ExternalPhysicianID>
            <PhysicianName>string</PhysicianName>
            <DateMovedToPreviousMedications>string</DateMovedToPreviousMedications>
            <HealthPlanID>string</HealthPlanID>
            <HealthplanTypeID>string</HealthplanTypeID>
            <FormularyCoverage>string</FormularyCoverage>
            <FormularyStatus>string</FormularyStatus>
          </PatientDrugDetail2>
          <PatientDrugDetail2>
            <AccountName>string</AccountName>
            <ExternalAccountID>string</ExternalAccountID>
            <SiteID>string</SiteID>
            <FullName>string</FullName>
            <ExternalPatientID>string</ExternalPatientID>
            <PrescriptionDate>string</PrescriptionDate>
            <DrugID>string</DrugID>
            <DrugTypeID>string</DrugTypeID>
            <DrugName>string</DrugName>
            <Strength>string</Strength>
            <StrengthUOM>string</StrengthUOM>
            <DosageNumberDescription>string</DosageNumberDescription>
            <DosageForm>string</DosageForm>
            <Route>string</Route>
            <DosageFrequencyDescription>string</DosageFrequencyDescription>
            <Dispense>string</Dispense>
            <TakeAsNeeded>string</TakeAsNeeded>
            <DispenseAsWritten>string</DispenseAsWritten>
            <Refills>string</Refills>
            <Status>string</Status>
            <PrescriptionGuid>string</PrescriptionGuid>
            <OrderGuid>string</OrderGuid>
            <PrescriptionNotes>string</PrescriptionNotes>
            <ExternalPhysicianID>string</ExternalPhysicianID>
            <PhysicianName>string</PhysicianName>
            <DateMovedToPreviousMedications>string</DateMovedToPreviousMedications>
            <HealthPlanID>string</HealthPlanID>
            <HealthplanTypeID>string</HealthplanTypeID>
            <FormularyCoverage>string</FormularyCoverage>
            <FormularyStatus>string</FormularyStatus>
          </PatientDrugDetail2>
        </patientDrugDetail>
      </GetPatientFullMedicationHistory2Result>
    </GetPatientFullMedicationHistory2Response>
  </soap12:Body>
</soap12:Envelope>