Healthwise Knowledgebase API for PHP

Web server requirements

  • PHP 5+
  • DOMDocument module
  • XSLTProcessor module

Web browser requirements

A modern web browser with JavaScript enabled:

  • Google Chrome
  • Firefox
  • Internet Explorer 8+ (for a better experience, use Internet Explorer 10 or above)
  • Opera
  • Safari

Installation

Instructions for installing the Healthwise API on your website.

Locate the file "hw-config.php" inside of the "healthwise" directory.

Fill in the following variables using the API information provided by Practis:

  • $hwUrl - API URL ( typically: https://ixbapi.healthwise.net )
  • $hwKey - API Key
  • $hwKeyId - API Key ID
  • $hwLang - API Language ( typically: en-us )

Upload the "crossdomain.xml" file and the "healthwise" directory to the root of your website.

Test the HealthWise API installation by visiting the "healthwise" folder on your website. For example: http://www.example.com/healthwise/

Note:  The healthwise directory on your website must be accessible to the public (not password protected, or on an in-house development server) in order for the library to work properly.

If your example files are working, you can  customize the HealthWise API by adding your website HTML and CSS to the HealthWise landing page  "/healthwise/index.php" and the HealthWise view page "/healthwise/hw-view.php".

Optionally, if you would like search engines to ignore this content add the following meta tag to the <head> of the "/healthwise/hw-view.php" page:

<meta name="robots" content="noindex, nofollow">

Optionally, add the following message at the top of the "/healthwise/hw-view.php" page:

"Our Health Library information does not replace the advice of a doctor. Please be advised that this information is made available to assist our patients to learn more about their health. Our providers may not see and/or treat all topics found herein."

Notes

<?php include('hw-process.php'); ?>

Contains all HealthWise API functions and must be included at the top of the HealthWise landing page "/healthwise/index.php" and the HealthWise view page "/healthwise/hw-view.php".

<?php echo $hwTitle; ?>

Displays the current page title. This should appear at the beginning of the <title> tag.

<?php echo $hwHead; ?>

Displays page specific meta and script tags necessary for rendering the HealthWise content. This should appear immediately before the closing </head> tag.

<?php echo $hwSearchForm; ?>

Displays the HealthWise API search form. This can be included anywhere in the HTML template.

<?php echo $hwContent; ?>

Displays the requested HealthWise API content. This can be included anywhere in the HTML template, but should only be included on the  HealthWise view page "/healthwise/hw-view.php".

For sites that include jQuery, add this script immediately before the closing </body> tag.

<script type="text/javascript">
    (function($) {
        $.extend({
            hwData: {
                key: function(entryKey, value) {},
                clear: function(entryKey) {}
            }
        });
    })(jQuery);
</script>
Have more questions? Submit a request