Skip to main content
ID
EP-3918:2024
Type
Product
Version
2.0
Access
None
Status
Active
Created date
Updated date

The HIPS Core APIs provide a set of APIs that are dependencies for various HIPS products. As of this release, the following HIPS products are compatible with HIPS Core APIs v2.0:

  • Document Authoring Adapter v1.0
  • Health Viewer v1.0
  • Structured Pathology Adapter v1.0

The HIPS Core APIs include the following functionality:

Configuration provider for HIPS products to manage configuration settings and options.

  • Provides a Config API for HIPS products to retrieve the configuration settings applicable to each HIPS product.
  • Provides a Config API for HIPS administrative tools to view and modify configuration settings for 
    HIPS products.
  • Provides a command-line interface (CLI) tool that uses the Config API to view and modify 
    configuration settings for HIPS products.
  • Provides a user interface to view and modify configuration settings for HIPS products.

Authentication provider for HIPS products to control access to HIPS APIs.

  • Provides an OAuth2 compatible Auth API to authenticate web services and background services of 
    HIPS products when connecting to other HIPS APIs.
  • Provides a secure shared sign in form for user authentication to other user interfaces, including 
    HIPS Admin Portal and Health Viewer.
  • Admin Portal for presentation of HIPS admin interfaces in a single location.
  • Enables other HIPS products to register new interfaces as they are developed without needing to 
    update HIPS Core APIs.
  • Initially includes links for setting management for HIPS products and for reviewing locked out users.

The following .zip file includes the Release Note, Functional Change Log v2.0 and Product Data Sheet. For access to additional resources in the Agency’s Collaborate Portal please email [email protected] or call 1300 901 001.

Download HIPS Core APIs v2.0

EP_3918_2024_HIPSCoreAPIs_v2.0.zip () 
Checksum: 8f040a084e8970456814b2bc26f700e354458f1faae670f7b739307385e4935e