U.S. Department of Health and Human Services

Menu

Healthfinder API
Terms of Use

Terms of Use

  1. The API can be used on demand, or the content can be queried and pulled into a separate database
    managed by an organization with an account ID. If the content is pulled into a new database, we ask that
    the organization query the healthfinder.gov API twice a month to check for new content updates. The
    healthfinder.gov content is frequently updated every 2 weeks, typically around the 15th and last day of each month.
  2. To leverage the API the developer must register and use a validate API key.
  3. healthfinder.gov content is frequently updated every 2 weeks, typically around the 15th and last day of each month.
  4. To properly use the healthfinder.gov API, we ask that the following code is embedded wherever healthfinder.gov content appears on your site.
  5. The healthfinder.gov logo and URL must be displayed as the content source wherever healthfinder.gov content is used.
    1. The logo and URL only need to appear once on a Web page where healthfinder.gov content appears. Please reference healthfinder.gov as the source and provide credit and the link to healthfinder.gov. The URL does not need to be displayed; wrapping the URL around the healthfinder.gov logo is the proper format.
    2. Code:
      <HealthfinderLogo>http://healthfinder.gov/prevention/glmedia/bw_hf_logo.gif</HealthfinderLogo>
      <HealthfinderUrl>http://healthfinder.gov</HealthfinderUrl>
    3. Example of the healthfinder.gov logo applied on a page using healthfinder.gov content
  6. Last Updated Date
    1. Inform visitors of the last time the content was updated.
    2. Code:
      <LastUpdated>9/1/2011 12:00:00 AM</LastUpdated>
  7. Analytics
    1. healthfinder.gov would like to collect basic analytics information on the application and usage data of the healthfinder.gov content. The analytics collects the following:
      1. The URL where the content is displayed
      2. How many times the content has been loaded
      3. Code:
        <Analytics><script type='text/javascript' src='http://healthfinder.gov/developers/Scripts/hf_search_api_analytics.js'></script> </Analytics>

Usage Requirements

  1. healthfinder.gov content can be presented anywhere on your Web site.
  2. Do not manipulate or alter the healthfinder.gov content.
  3. If the content is mashed up or presented with other content, please ensure that the content provides related value, is consistent with the healthfinder content, and does not harm the integrity of the healthfinder.gov content.
  4. Use best practices based on usage to determine when to use the healthfinder.gov API in real-time versus using the API to gather the healthfinder.gov content and storing it in a local database.

Implementation Requirements

  1. Required: Include the healthfinder.gov logo and a link to the healthfinder site in each topic and tool presented.
  2. Required: Embed the analytics code once on each page where topic(s) or tool(s) are presented.
  3. Optional: Include the "last updated" date near the healthfinder.gov content.

Account Creation

  1. To use the API, an account must be created.
  2. The account API key must be passed as part of the query when using the API.