Predefined Methods

This section describes the pre-defined methods available per object. These pre-defined methods can be divided into two categories: methods that are available on all or many objects, called generic methods, and methods that are only available on particular objects, called specific methods.

Generic Methods

Please refer to the OHI Claims Adjudication Implementation Guide for the list of available generic methods.

Specific Methods

In this section, the methods are described that are only available on specific objects. For each method, the following information is given:

  • The purpose of the method.

  • On which object(s) the method can be called.

  • Description of the parameters.

  • An example of the usage.

getParameterValue

Gets the parameter value of a product that is defined for a parameter alias at a given point in time. If a value is defined at the parameter alias value level, then it will also return that value.

Availability

This method is available on product objects.

Parameters

In / Out Type Description

In

String

The code of the parameter alias. Mandatory.

In

Date

As of date for time validity. Optional.

Out

List

The parameter value list defined for the parameter alias in context of the product. Null if no parameter value is defined.

Example

parameterValue = product.getParameterValue('PCP_COPAY','2014-01-21')

getProductLimitRenewalPeriod

Gets the product limit renewal period of a product that is defined for a limit at a given point in time.

Availability

This method is available on product objects.

Parameters

In / Out Type Description

In

String

The code of the limit. Mandatory.

Out

Product Limit Renewal Period

The product limit renewal period defined for the limit in context of the product. Null if no product limit renewal period is defined.

Example

productLimitRenewalPeriod = product.getproductLimitRenewalPeriod('DEDUCTIBLE')

getProductProviderGroup

Gets the product provider group of a product that is defined for a provider group at a given point in time.

Availability

This method is available on product objects.

Parameters

In / Out Type Description

In

String

The code of the provider group. Mandatory.

In

Date

As of date for time validity. Optional.

Out

Product Provider Group

The product provider group defined for the provider group in context of the product. Null if no product provider group is defined.

Example

productProviderGroup = product.getProductProviderGroup('NY NETWORK','2014-01-21')

getProductServiceDefinition

Gets the product service definition of a product that is defined for a service definition at a given point in time.

Availability

This method is available on product objects.

Parameters

In / Out Type Description

In

String

The code of the service option. Mandatory.

In

String

The code of the service. Mandatory.

In

String

The code of the service definition. Mandatory.

In

String

The type of the service definition ("A","C","R","W"). Mandatory

In

Date

As of date for time validity. Mandatory.

Out

Product Service Definition

The product service definition defined for the service definition in context of the product. Null if no product service definition is defined.

Example

productServiceDefinition = product.getproductServiceDefinition('PHYSICAL THERAPY','SERVICES','PROFESSIONAL','C','2014-01-21')