Formulary2 Web Service

Formulary2

Click here for a complete list of operations.

FormularyComposite

Identifies the coverage status for a list of drugs based on a particular formulary plan.

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/Formulary2.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/FormularyComposite"

<?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>
    <FormularyComposite 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>
      <patientInformationRequester>
        <UserType>string</UserType>
        <UserId>string</UserId>
      </patientInformationRequester>
      <healthplanID>string</healthplanID>
      <healthplanTypeID>string</healthplanTypeID>
      <eligibilityIndex>string</eligibilityIndex>
      <drugConcept>string</drugConcept>
      <drugConceptType>string</drugConceptType>
      <includeSchema>string</includeSchema>
    </FormularyComposite>
  </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>
    <FormularyCompositeResponse xmlns="https://secure.newcropaccounts.com/V7/webservices">
      <FormularyCompositeResult>
        <Status>Unknown or OK or Fail or NotFound</Status>
        <Message>string</Message>
        <XmlResponse>string</XmlResponse>
        <RowCount>int</RowCount>
        <Timing>int</Timing>
      </FormularyCompositeResult>
    </FormularyCompositeResponse>
  </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/Formulary2.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>
    <FormularyComposite 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>
      <patientInformationRequester>
        <UserType>string</UserType>
        <UserId>string</UserId>
      </patientInformationRequester>
      <healthplanID>string</healthplanID>
      <healthplanTypeID>string</healthplanTypeID>
      <eligibilityIndex>string</eligibilityIndex>
      <drugConcept>string</drugConcept>
      <drugConceptType>string</drugConceptType>
      <includeSchema>string</includeSchema>
    </FormularyComposite>
  </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>
    <FormularyCompositeResponse xmlns="https://secure.newcropaccounts.com/V7/webservices">
      <FormularyCompositeResult>
        <Status>Unknown or OK or Fail or NotFound</Status>
        <Message>string</Message>
        <XmlResponse>string</XmlResponse>
        <RowCount>int</RowCount>
        <Timing>int</Timing>
      </FormularyCompositeResult>
    </FormularyCompositeResponse>
  </soap12:Body>
</soap12:Envelope>