Medical Screening Flow

This section documents use-cases about embedding medical screening flow and providing a more tightly integrated user experience for white label integrated purchase paths without having to implement the medical screening flow.

Overview

Medical screening allows you to redirect to an nib hosted medical screening flow if medical screening of pre-existing conditions is required. The questions required for entering medical screening flow include the following:

• Traveller medical screening (Opted in) - Whether each traveller has opted into medical screening
• Travel Mode - If traveller has opted in, need to set the the travel mode against the quote. (Air, Cruise, Both, None)

The stages for the purchase path is outlined below. It is recommended to redirect to the medical screening after entering the traveller details.

Determining whether a product has medical screening

• Once a plan is selected, and if this plan has travel clear configured then a new travel clear object is created for a given policy holder.

• This travel clear object can then be used to drive conditional behaviour relating to medical screening.

1
"quote": {
2
        "id": "274ba4ce-8937-462a-949a-1e87e845a23c",
3
           ....
4
     "input": {
5
       policyHolders": [
6
       {
7
           ....
8
         "firstName": "TestUser4733_FN",
9
         "lastName": "TestUser4733_LN",
10
         "travelClearOption": {
11
                "travelClearScreeningId": "00000000-0000-0000-0000-000000000000",
12
                "travelClearOptInForScreening": false,
13
                "travelClearOptInForCover": false,
14
                "travelClearScreeningPremium": 0,
15
                "travelClearPremium": 0,
16
                "travelClearExcess": 0,
17
         },
18
     },
19
    ], 
20
    "travelMode" : "Air" 
21
    }
22
}

Redirection flow

Opting in travellers to travel clear medical screening

To opt travellers into travel clear medical screening the following request needs to be passed as part of updating the quote in the traveller details quote API update, travelClearOptInForScreening attribute is a boolean flag that opts the traveller into medical screening.

1
"policyHolders": [
2
{
3
  ...
4
  "firstName": "TestUser4733_FN",
5
  "lastName": "TestUser4733_LN",
6
  "travelClearOption": {
7
    "travelClearOptInForScreening": true // This opts the traveller into medical screening
8
  }
9
}

Redirect into Medical Screening

The following segment shows the sample redirect url:

1
example partner domain = example.com.au
2
subdomain = medicalscreening.example.com.au
3
url = https://medicalscreening.example.com.au?token=<token>

For exact path url that is specific to a partner please reach out to the nib partnership team.

Sequence flow

The flow for redirecting to medical screening flow from a purchase path is typically the following.

• Preconditions - In the purchase path flow, if the user has opted in for medical screening and if the travel mode is choosen then the user is allowed to perform medical screening.
• Fetch Token - To redirect the user securely to our self hosted medical screening flow there is a need to fetch an interchange token for a given Quote ID.
• Time to Live - Time to live (ttl) is the duration in minutes that this token should be valid for. Default is 30 min. This is an optional parameter.
• Redirect to URL - The purchase path then needs to append the token received as a query string to the Medical Screening redirection URL and redirects the request for user to proceed with the medical screening process.

Redirect into Purchase Path

• Redirection - Post the completion of the medical screening of pre-existing conditions the token will be generated for a Quote and the request will be redirected back for requesting payments.
• Fetch Quote ID - The token from the redirect URL can be used to fetch the Quote ID by making a call to the interchange token end point.

To incorporate the payments page with the medical screening information here are the updated properties of the quote object that can be used.

Field mapping

The following provides a mapping for the key elements.

API response sample

NOTE: the final Quote premium will be updated based on the medical screening outcome and should be refreshed for this purpose that is exposed by the Quote object.

1
    "quote": {
2
        "id": "274ba4ce-8937-462a-949a-1e87e845a23c",
3
           ....
4
     "input": {
5
       policyHolders": [
6
       {
7
           ....
8
         "firstName": "TestUser4733_FN",
9
         "lastName": "TestUser4733_LN",
10
         "travelClearOption": {
11
                "travelClearOptInForScreening": true,
12
                "travelClearOptInForCover": true,
13
                "travelClearScreeningPremium": 85.71,
14
                "travelClearScreeningExcess": 100.00,
15
                "travelClearOutcomeDecision": "Limited cover offered"
16
         },
17
     },
18
    ], 
19
    "travelMode" : "Air" 
20
    }
21
}