Organizations Integration Point
When organizations and their details are primary maintained outside Oracle Health Insurance, Oracle Health Insurance needs an up-to-date copy of these organizations The Organizations Integration Point enables external parties to create and maintain these copies.
Operations
This specific API supports the following operations
|
|
|
|
The generic organizations API supports, in addition to the standard generic API operations, the GET
and the PATCH
operation on /generic/organizations/key/{key}
.
This enables retrieving and updating an organization based on its code (the {key}).
Rules
Uniqueness
An organization’s code is unique within the persons, organizations and banks in the application. An organization’s identifier of a unique identifier type is unique within the persons, organizations and banks in the application.
Create or Update Behavior
The organization code in combination with the identifier type drives whether the API creates a new organization or updates an existing organization.
-
If the identifier type in the request is empty and the organization code in the request matches the organization code of an existing organization, Oracle Health Insurance considers the details to be an update to that existing organization.
-
If the combination of the identifier type and the organization code in the request match the identifier type and value of an existing organization, Oracle Health Insurance considers the details to be an update to that existing organization.
-
If the identifier type in the request is empty and the organization code in the request does not match the organization code of an exiting organization, Oracle Health Insurance adds a new organization with the provided organization code and details.
-
If the combination of the identifier type and the organization code in the request does not match the identifier type and value of an existing organization, Oracle Health Insurance adds a new organization with a generated organization code[1] and stores the organization code from the request as an identifier of the specified identifier type.
-
If the organization code in the request is empty, Oracle Health Insurance adds a new organization with a generated organization code[1].
-
Oracle Health Insurance enforces organization codes to be unique across all relations, regardless of the source of the relation. However, identifier types can be non-unique. If the combination of the identifier type and the organization code in the request matches multiple organizations, the application returns error message REL-IP-RELA-027: "Multiple relations matched on identifier {identifier}" and does not update or create any organization.
Request Messages
Each request message can contain the details of one organization.
The details of exactly what information needs to be in a given request message varies based on factors such as whether details have been sent before and the category of details that have been added or updated.
For details on how values in the request messages are handled, refer Property Representation and Handling (PUT, POST, PATCH).
Organization
The system accepts the organization request message in the following format:
Organization Request Message (click to open)
<organization code="" identifierTypeCode="" name="" phoneNumberBusiness="" phoneNumberMobile="" phoneNumberPrivate="" emailAddress1="" emailAddress2="" faxNumber="" outputLanguageCode="" preferredLanguageCode="" endDate="" > <relationIdentifierList> <relationIdentifier identifierTypeCode="" identifier="" enabled="" /> </relationIdentifierList> <relationLinkList> <relationLink relationLinkTypeCode="" direction="" relationCode="" enabled="" /> </relationLinkList> <addressList> <address addressTypeCode="" street="" houseNumber="" numberAddition="" additionalPart1="" additionalPart2="" additionalPart3="" city="" postalCode="" countryRegionCode="" countryCode="" startDate="" endDate="" /> </addressList> <bankAccounts> <bankAccount bankAccountNumber="" bankAccountNumberDebit="" bankCode="" bankAccountValidationCode="" specialName="" indPreferred="" startDate="" endDate="" /> </bankAccounts> <relationTagList> <relationTag tagTypeCode="" startDate="" endDate="" /> </relationTagList> <relationLobAccessRestrictionList> <relationLobAccessRestriction accessRestrictionCode="" /> </organization>
Response Messages
The Oracle Health Insurance application creates the response messages in response to request messages it receives from external interfaces. Please refer to the "Response Messages" section in the HTTP API/IP Concepts as part of the Developer Guide for more details.
Batches
This integration point supports the handling of multiple requests ('File Based Import') in one go. Please refer to the File Based Import section in the documentation for more details.
Organization
An organization batch request message has the following structure:
<organizations> <organization/> -- refer to Organization Request for details </organizations>
An organization batch response message has the following structure:
<organizationsResponse> <resultMessages/> </organizationsResponse>
Refer to the "Activity Integration Point" section in the HTTP API Integration Points part of the Developer Guide for more details. The elementId attribute that is included as part of the result messages element contains the code of the organization for which the messages are raised.
Error Messages
The following error messages that are specific to the relation interface may be returned in the response messages:
Code | Severity | Message |
---|---|---|
REL-IP-RELA-008 |
Fatal |
Language code {code} is unknown |
REL-IP-RELA-009 |
Fatal |
Country code {code} is unknown |
REL-IP-RELA-010 |
Fatal |
Bank code {code} is unknown |
REL-IP-RELA-011 |
Fatal |
Bank account validation code {code} is unknown |
REL-IP-RELA-012 |
Fatal |
Country region code {code} is unknown |
REL-IP-RELA-018 |
Fatal |
Identifier type code {code} is unknown |
REL-IP-RELA-019 |
Fatal |
Address type code {code} is unknown |
REL-IP-RELA-025 |
Fatal |
Marital Status Type Code {code} is unknown |
REL-IP-RELA-026 |
Fatal |
Relation link type code {code} is unknown |
REL-IP-RELA-027 |
Fatal |
Multiple relations matched on identifier {identifier} |
In addition, functional business rule messages may be returned as well as the standard messages related to dynamic fields and dynamic records. Refer to the Response Messages for more information.