Integration Points Overview
The following table provides an overview of the integration points that are available for exchanging data with OHI Enterprise Policy Administration:
Integration Point | Purpose | Inbound/Outbound | Realtime/Batch |
---|---|---|---|
Access Tokens |
Returns OAuth2 access tokens |
Outbound |
Realtime |
Activity |
Start and monitor activities |
Inbound |
Realtime |
Attached Data |
Create or modify additional information related to the policy, without affecting its status or reprocessing the policy |
Inbound |
Realtime |
Base View Generation |
Starts the generation of base views |
N.A. |
Request |
Control Task Processing |
The "taskprocessing" resource can be used to:
|
Both |
Realtime |
Credentials |
Manage credentials |
Both |
Realtime |
Current Properties |
Shows currently set properties and their values |
Outbound |
Realtime |
Data File Set |
Uploading of files |
Inbound |
Both |
Data Replication of Persons |
Replicate changes in person data to Claims and/or Authorizations |
Outbound |
Batch |
Enrollment Status Response |
Supply applications with realtime enrollment data |
Outbound |
Request |
Financial Message |
Send a notification message to an external system once all the financial messages for a financial transaction set are written to the data file |
Outbound |
Request |
Group Client Integration Point |
Create and update group clients and their group accounts |
Inbound |
Request |
Key Stores |
Configure key stores |
Both |
Realtime |
Note |
Retrieve, create and update notes |
Both |
Request |
Objects |
Fetches the meta model of the objects in the application as zip |
Inbound |
Realtime |
Policy In |
Create and update policies |
Inbound |
Request |
Policy Account |
Create and fetch policy accounts |
Inbound/Outbound |
Request |
Policy Account Transaction |
Create and fetch a policy account transaction for a policy account |
Inbound/Outbound |
Request |
Policy Account Transaction List |
Create a list of policy account transactions for a list of policy accounts |
Inbound |
Batch |
Property Definitions |
Retrieve all available system property definitions |
Outbound |
Realtime |
Provider In |
Create and update provider (individual, organization and group) information |
Inbound |
Both |
Provisioning |
Provision OHI Enterprise Policy Administration with user and user roles |
Inbound |
Request |
Quote |
Provide premium quotes to portals |
Outbound |
Request |
Reference Sheet Line |
Create, update and delete reference sheet lines |
Inbound |
Both |
Registration |
Create and update payment and bill registrations |
Inbound |
Batch |
Relation In |
Create and update relation (person and organizations) information |
Inbound |
Both |
User Information |
Provides the ability to fetch the user information (user preferences, access restriction grants, etc.) and to update the user preferences of the logged in user |
Both |
Request |
Dataexchange |
Allow the exchange of data sets between application environments without having to access the application screens. |
Both |
Request |
The following table lists additional usage characteristics of those integration points and places them into context:
Integration Point | Usage Frequency | Must Have or Option |
---|---|---|
Access Tokens |
Frequently |
Must Have when using OAuth |
Activity |
Frequently to start premium calculation or output generation for example. |
Must Have |
Attached Data |
Incidentally |
Optional |
Base View Generation |
Incidentally |
Optional |
Credentials |
Incidentally |
Must Have when securing REST |
Current Properties |
Incidentally |
Optional |
Data File Set |
Frequently |
Must Have |
Data Replication of Persons |
Frequently if enabled |
Optional |
Data Set Operations / Config Migration |
Incidentally when configuration needs to change |
Recommended |
Enrollment Status Response |
Frequently |
Must Have |
Financial Message |
Frequently |
Must Have |
Group Client Integration Point |
Incidentally |
Optional |
Key Stores |
Incidentally |
Must Have when securing REST |
Note |
Incidentally |
Optional |
Policy In |
Frequently |
Optional |
Policy Account |
Frequently |
Optional |
Policy Account Transaction |
Frequently |
Optional |
Policy Account Transaction List |
Frequently |
Optional |
Property Definitions |
Incidentally |
Optional |
Provider In |
Frequently |
Optional |
Provisioning |
Incidentally, to give new users access to the system |
Must Have |
Quote |
Frequently |
Optional |
Reference Sheet Line |
Incidentally |
Optional |
Registration |
Incidentally |
Optional |
Relation In |
Incidentally |
Optional |
User Information |
Frequently |
Must Have |
Details about individual integration points can be found in the implementation- and integration guides of OHI Enterprise Policy Administration.