Episode Integration Point

The purpose of this integration point is to allow external systems (e.g. portals) to create, update or delete episodes for a serviced person or object.

Create or Update Episode

Episode create/update request message must be sent to the uri:http://[hostName]:[portNumber]/[api-context-root]/episodes. The request message has the following structure:

<episode
  episodeDefinitionCode=""
  startDate=""
  endDate=""
  indVoided=""
>

</episode>

The system first attempts to identify a unique episode based on the person’s or object’s code, episode definition code and start date. If such an episode exists then its details are updated, otherwise a new episode is created. An episode is bounded by the start date and end date. It is only possible to create/update episodes for a given serviced person or object and episode definition such that the outcome is episodes having non overlapping time validity.

The external system can also specify the dynamic fields configured on a episode. For details on how external system can provide values for dynamic fields and dynamic records in request messages and how they are handled by Claims, refer to the concepts in the Developer Guide.

The system sends the response once the episode is created/updated. The success or error (e.g. the person code is unknown) response structure is specified in Response Messages in the chapter 'HTTP API Integration Points' of the Common Features book.

Delete Episode

An episode can be deleted by sending a DELETE request to the uri:

http://[hostName]:[portNumber]/[api-context-root]/**__**episodes?insurableEntityType=" {usageName}"&insurableEntityCode=""”&episodeDefinitionCode =“”&startDate=“”

The system identifies a unique episode to delete based on the person or object code, episode definition code and start date. Deleting an episode is not allowed if there are episode details referencing it.

Messages

The following messages can be returned by this integration point:

Code	Severity	Text
CLA-IP-EPSO-001	Fatal	Insurable entity {usageName} with code {code} is unknown
CLA-IP-EPSO-002	Fatal	Episode definition code {code} is unknown
CLA-IP-EPSO-003	Fatal	Episode for the insurable entity {code} having the episode definition code {code} and start date {date} is unknown
CLA-IP-EPSO-004	Fatal	Episode cannot be deleted if referencing episode details exist