Support

SOAPwareExchange White Paper

Developer Information: Integrating with SOAPware via SOAPwareExchange

We’re glad to hear you’re interested in integrating with SOAPware! For your convenience we have assembled this document detailing the procedures for integration, and the integration options available to you.

At SOAPware, Inc. we have three supported levels of integration. Each level has different requirements. Please review the features of each, and use this information to determine which level of integration best suits your needs.

Bronze Level

Bronze is our most basic level of integration. At the Bronze level, the integration is uni-directional; from your system to SOAPware. A Bronze interface is required to support the transfer of General Demographic information, which at a minimum must include the following:

  • Patient Last Name
  • Patient First Name
  • Patient Birth date
  • Patient Sex
  • Patient Chart Number
  • Patient Social Security Number
  • Patient Home Address (Street 1 and 2, City, State, and Zip Code)
  • Patient Home Phone Number
  • Patient Work Phone Number

These include the fields that SOAPwareExchange will use to match the patients, and all of these fields must be present in both the PID and GDEM segments of the exported file (see the SOAPwareExchange Technical Instructions for details on file layouts). A Bronze interface is not required to support the following, but it is highly recommended:

  • Patient Marital Status
  • Patient Primary Physician
  • Patient Title
  • Patient Suffix
  • Patient Email Address
  • Patient Fax Number.

Insurance demographic information and custom demographic information is optional for a Bronze interface.

Silver Level

Silver is the intermediate level of integration. At the Silver level, the integration is bi-directional, with transfer of demographic information both from your system to SOAPware and from SOAPware to your system. A Silver interface is required to support both General and Insurance Demographic information, which at a minimum must include the following:

General Demographic

  • Patient Last Name
  • Patient First Name
  • Patient Birthdate
  • Patient Sex
  • Patient Chart Number
  • Patient Social Security Number
  • Patient Home Address (Street 1 and 2, City, State, and Zip Code)
  • Patient Home Phone Number
  • Patient Work Phone Number

Insurance Demographic

  • Primary Insurance Provider Name
  • Primary Insurance Provider Phone Number
  • Primary Insurance Policy Number
  • Name of Primary Insured

The following General Demographic fields are optional:

  • Patient Marital Status
  • Patient Primary Physician
  • Patient Title
  • Patient Suffix
  • Patient Email Address
  • Patient Fax Number

The following Insurance Demographic fields are optional:

  • Primary Insurance Expiration Date
  • Primary Insurance Contact Person
  • Primary Insurance Misc. Comments/Notes
  • Secondary Insurance Provider Name
  • Secondary Insurance Provider Phone Number
  • Secondary Insurance Policy Number
  • Name of Secondary Insured
  • Secondary Insurance Expiration Date
  • Secondary Insurance Contact Person
  • Secondary Insurance Misc. Comments/Notes

All Custom Demographic information is optional for a Silver interface. A Silver interface must also be able to accept the supported fields back from SOAPware, should updated information be provided.

Gold Level

Gold is our highest level of integration. At the Gold level, the integration is fully bi-directional, with transfer of demographic information both ways, and transfer of billing information back from SOAPware to your system. A Gold level interface is required to support both General and Insurance Demographic information, which at a minimum must include the following:

General Demographic

  • Patient Last Name
  • Patient First Name
  • Patient Birthdate
  • Patient Sex
  • Patient Chart Number
  • Patient Social Security Number
  • Patient Home Address (Street 1 and 2, City, State, and Zip Code)
  • Patient Home Phone Number
  • Patient Work Phone Number

Insurance Demographic

  • Primary Insurance Provider Name
  • Primary Insurance Provider Phone Number
  • Primary Insurance Policy Number
  • Name of Primary Insured

The following General Demographic fields are optional:

  • Patient Marital Status
  • Patient Primary Physician
  • Patient Title
  • Patient Suffix
  • Patient Email Address
  • Patient Fax Number

The following Insurance Demographic fields are optional:

  • Primary Insurance Expiration Date
  • Primary Insurance Contact Person
  • Primary Insurance Misc. Comments/Notes
  • Secondary Insurance Provider Name
  • Secondary Insurance Provider Phone Number
  • Secondary Insurance Policy Number
  • Name of Secondary Insured
  • Secondary Insurance Expiration Date
  • Secondary Insurance Contact Person
  • Secondary Insurance Misc. Comments/Notes

All Custom Demographic information is optional. A Gold interface must also be able to accept the supported fields back from SOAPware, should updated information be provided. A Gold interface is not required to utilize the CMDQUEUE and CMDQUEUENEW commands in SOAPwareExchange, but it is highly recommended. It is one of the most requested features from our users, and interfaces that provide this functionality will tend to be preferred. A Gold interface is required to accept billing information back from SOAPware in the format detailed in the SOAPwareExchange Technical Instructions.

The Interface is Written, Now What?

When your side of the interface is complete, there are certain steps that must be taken before we can list the interface on our web site and recommend it to our clients. When you requested the developer’s integration package from SOAPware, Inc., we provided you with developer’s not-for-resale copies of our software and the integration engine, SOAPwareExchange, for testing purposes. Now we will need the same from you. We will need a developer’s not-for-resale copy of your software package, and your newly-developed integration engine so that we can test the interface here. If the testing uncovers any problems in the interface, these will be forwarded to you along with the remedies required before we can recommend the interface. If no problems are discovered, we will notify you of this and prepare an entry for you on our web site, detailing the level and capabilities of your interface and providing your companies’ contact information. You will need to join our Partner’s Program in order for the ad to be placed on our site, and for our representatives to be able to recommend your interface to customers. Information on the Partner’s Program can be found at http://www.docs.com/Partners/partnerprogramIntegratInfo.htm

We provide full support for our SOAPwareExchange product, but you will need to provide customer support for your integration product. If updates to your interface engine become necessary, we will need you to provide test copies of those to us; you are similarly entitled to test copies of any updates to the SOAPwareExchange interface engine.

Questions?

If you have questions or concerns about anything detailed in this document, or run into problems while developing your interface, feel free to contact SOAPware, Inc. about these. When emailing about a problem, please always be sure to include the file that demonstrates the problem. SOAPwareExchange problems should be addressed to support@soapware.comwith SOAPwareExchange in the subject line, and the output file from your interface attached as a plain text file.