elaimlink – gdrfa integration register document - phase 2 (gdrfa validation).pdf · with the...

15
eClaimLink – GDRFA Integration Technical Specifications Version 1.0

Upload: doandieu

Post on 03-Aug-2019

217 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

eClaimLink – GDRFA Integration Technical Specifications Version 1.0

Page 2: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

1 | P a g e

Table of Contents

OVERVIEW 2

SCOPE 2

ABBREVIATIONS 2

IMPORTANT 3

HIGH LEVEL CYCLE 4

INVOLVED TRANSACTIONS 4

CYCLE 1 – MEMBER DETAILS VALIDATION 5

CYCLE 1 – BUSINESS PROCESS 5

CYCLE 1 – DATA FLOW 7

CYCLE 2 – MEMBER INSURANCE VALIDATION (GDRFA) 8

CYCLE 2 – BUSINESS PROCESS 8

CYCLE 2 – DATA FLOW 9

WEB SERVICE DOCUMENTATION 10

VALIDATEMEMBERUID 10

UPLOAD MEMBERREGISTER 11

WEB SERVICES RETURNED VALUES 14

MEMBER REGISTER INTEGRATION WEB SERVICES (WSDL) 14

Page 3: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

2 | P a g e

Overview

Scope

Dubai Health Authority in cooperation with the General Directorate of Residency and Foreigners Affairs –

Dubai (GDRFAD) are working towards ensuring the implementation of the mandatory Insurance Law No11

of 2013, which requires all Dubai residents to have medical insurance. The integration project will comprise

of information sharing to ensure that health insurance system stores the correct insured member

information, as well as enabling the Visa issuing staff from automatically checking the health insurance

requirement electronically for the insured resident.

The first objective of the project is to enable the health insurance companies from validating the member

information at the point of applying to acquire medical insurance, keeping their records clean and in-sync

with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior.

The second objective of the project is to enable the GDRFA employees from validating the member

insurance status at the point of issuing the visa through an automated electronic system.

eClaimLink will facilitate the needed transaction and integration points between the healthcare insurance

companies and the GDRFA systems.

Abbreviations

Below is a list of the abbreviations used within this document:

Abbreviation Description

DHA Dubai Health Authority

DHPO Dubai Health Post Office

GDRFAD General Directorate of Residency and Foreigners Affairs Dubai

Payer Healthcare Service Payer – (Insurance company)

Provider Healthcare Service Provider – (Hospital, Clinic, Center, Pharmacy, Laboratory)

Receiver Transaction receiver

Sender Transaction sender

Member/Resident Person carrying or intending to acquire a Dubai residency visa

Page 4: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

3 | P a g e

Important

The GDRFA validation will only happen for those members whose residency/visa is issued from the emirate

of Dubai (Emirate = 4), members with residencies/visas from other emirates will not be validated but are

still required to be uploaded to the Member Register.

New and Renewal Visas

The new process will be enforced on records related to members acquiring new and renewal visas:

Payers are expected to validate, and upload correct MemberRegister records for these members in

real time.

The new validation and upload process will accommodate one record at a time to allow for

performance and real time updates.

The GDRFA team will validate the insurance validity using the new direct link to the eClaimLink.

All insurance companies are expected to have new and renewed policies on the MemberRegister

system using the new validation process starting January 15th.

Back Log and Bulk Updates

A separate web service and process will be created to manage back logs and existing member records

uploads to the new repository. A detailed circular and technical specifications document will be provided

to explain the mentioned phase.

Page 5: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

4 | P a g e

High Level Cycle

Below is a diagram representing the high-level cycles covered by the GDRFAD – eClaimLink integration.

Figure 1- eClaimLink - GDRFA full integration cycle

Involved transactions

The integration cycle consists of the transactions shown below:

Transaction Description

ValidateMemberUID Transaction submitted by the Payer to validate the member information from the GDRFAD through the DHPO. To be used for members with a Dubai residency/visa only.

MemberRegister Upload Transaction utilized by the Payer to upload the insured member details as per the eClaimLink published transaction schema, business and validation rules.

MemberInsuranceInformation Transaction utilized by the GDRFAD to validate the member’s insurance coverage, from the DHPO. For GDRFA use only.

DownloadTransactionFile Transaction utilized by the payer to download a given MemberRegister file. Details published in a separate document on eClaimLink

Page 6: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

5 | P a g e

Cycle 1 – Member details validation

The diagram below shows the first half of the cycle where the member is in the process of acquiring an

insurance policy to comply with the Dubai residency visa requirements. The cycle provides a detailed

business process for the steps, checks and data flows taking place between the Payer, eClaimLink and GDRFA

systems.

Figure 2 - Member details validation cycle

Cycle 1 – Business process

1. Member visits the Payer to purchase an insurance policy.

2. Payer sends the member details to the DHPO for validation against the GDRFA database using the web

service method ValidateMemberUID (web service documentation provided in a later section)

3. DHPO performs an initial check on the member details:

Check 1: UID exists or not within the DHPO DB?

Result 1.1: UID Exists

Action 1.1: DHPO will perform Check 2.

Result 1.2: UID does not exist.

Action 1.2: DHPO will trigger Check 3.

Check 2: Member details match the internal record?

Member Details:

o Date of birth

o Gender

o Nationality

o Passport No

o UID

Result 2.1: All details match

Action 2.1: DHPO returns confirmation to the Payer including the UID and Member details.

Result 2.2: Details don’t match

Action 2.2: DHPO returns an error report to the Payer.

Page 7: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

6 | P a g e

4. GDRFA system verifies the member details:

Check 3: Member details match GDRFA records?

Result 3.1: Details match

Action 3.1: GDRFA returns a confirmation to the DHPO including the UID.

Result 3.1: Details don’t match

Action 3.1: GDRFA returns an error report to the DHPO.

5. DHPO returns a confirmation or error message to the Payer based on the checks 1, 2 or 3.

6. In case of a valid member, the Payer completes the policy sale and sends a MemberRegister

transaction to the DHPO containing the insured member policy details.

7. Once the MemberRegister is uploaded to the DHPO, the DHPO will perform a check (with the

GDRFA) to make sure all the details are matching.

Check 2: MemberRegister details match the record of the GDRFA?

Member Details:

o Date of birth

o Gender

o Nationality

o Passport No

o UID

Result 2.1: All details match

Action 2.1: DHPO returns confirmation to the Payer – MemberRegister is uploaded successfully.

Result 2.2: Details don’t match

Action 2.2: DHPO returns an error report to the Payer – MemberRegister upload fails.

8. The Payer provides the insured member with the policy material and insurance card.

Page 8: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

7 | P a g e

Cycle 1 – Data Flow

The below diagram shows the data flow between the Payer, DHPO and GDFRFA systems as per the cycle

and business process mentioned above.

Cycle 1 – Member details validation

PA

YER

eC

laim

Lin

k (D

HP

O)

GD

RFA

August.2015

START

Input member validation details

Send to DHPO

Valid Schema?

Valid

END

Generate ValidateMember XML

Send error report(schema error)

(mismatch reason)Invalid

Error report details

Fix ValidateMember XML

Member details match?

Send error report (mismatch reason)

Does notmatch

Send member UID to DHPO

Match

UID Exists in DHPO? ExistsMember details

match?

Does notmatch

Send member details to GDRFA system

Does notexist

MatchSend member UID to

Payer

Utilize valid member UID to generate

MemberRegister XML

Send to DHPO

Generate MemberRegister

XML

Valid Schema?

Send error report

Invalid

Error report details

Fix MemberRegister error

Send Upload Confirmation

MemberRegister upload

confirmation

MemberRegisterXML

Member details match?

Valid

Match

Does not match

Figure 3 - Member details validation data flow diagram

Page 9: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

8 | P a g e

Cycle 2 – Member Insurance Validation (GDRFA)

The diagram below shows the second half of the cycle where the member is in the process of issuing a

visa/residency from the GDRFA, which in order to comply with the Dubai residency visa requirements the

GDRFA will check if the member has medical insurance. The cycle provides a detailed business process for

the steps, checks and data flows taking place between the Payer, eClaimLink and GDRFA systems.

Figure 4 - Member insurance validation cycle

Cycle 2 – Business process

9. Member visits GDRFA to apply for the visa. 10. GDRFA sends member details to DHPO to validate for insurance coverage using the

MemberInsuranceInformation transaction. 11. DHPO responds back with the validity of the member insurance coverage through the checks below:

Check 1: Does UID exist in MemberRegister?

Result 1.1: UID exists in MemberRegister.

Action 1.1: DHPO will perform check 2.

Result 1.2: UID does not exist in MemberRegister.

Action 1.2: DHPO returns an error report to GDRFA.

Check 2: Member information matching?

Member information:

o Date of birth

o Gender

o UID

Result 1.1: UID + DOB + Gender match.

Action 1.1: DHPO will perform Check 3.

Result 1.2: UID + DOB + Gender mismatch.

Action 1.2: DHPO returns an error report to GDRFA.

Page 10: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

9 | P a g e

Check 3: Member insurance coverage?

Result 1.1: Member covered.

Action 1.1: DHPO returns a confirmation message to GDRFA.

Result 1.2: Member not covered.

Action 1.2: DHPO returns an error report to GDRFA.

Cycle 2 – Data Flow

The below diagram shows the data flow between the GDRFA and the DHPO as per the cycle and business

process mentioned above.

Figure 5 - Member insurance validation data flow diagram

Page 11: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

10 | P a g e

Web Service Documentation

ValidateMemberUID

Web service method: ValidateMemberUID

Description: Web service method used by the Payer to check the member’s UID number against the GDRFA database through the DHPO using a combination of fields to ensure accuracy. The web service will also be used to fetch the member’s UID in case it is not available with the payer using the same set of fields. ValidateMemberUID method will only validate member’s details for member’s with a Dubai visa; no need to validate if visa is from any other Emirate.

Signature: ValidateMemberUIDResponse ValidateMemberUID ( string payerLogin,

string payerPwd, int gender, string dateOfBirth, string nationality, string passportNumber, int visaSource )

Input element Description

payerLogin Payer user login name to connect to the DHPO

payerPwd Payer user password to connect to the DHPO

gender Member’s gender (1= male, 0 = female, 9 = unknown)

dateOfBirth Birth Date of the member Possible values: DD/MM/YYYY

nationality Member’s nationality code as per the list published on the eClaimLink (GDRFA Nationalities)

passportNumber Member’s passport number of the passport that has the UAE visa.

visaSource Source of the member’s visa (1 = Dubai, 2 = Other).

Output element Description

UID Unified Identity Number issued at the time of entry by the Ministry of Interior (MOI).

errorMessage

Output parameter that contains the transaction status: Error: error message if something goes wrong; web service can also send warnings using this parameter; the parameter may be null or empty string if the web service returns zero, otherwise the error message is expected Successful: empty

Return value: The web service may return values described in the section Web Services Returned Values.

Page 12: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

11 | P a g e

Upload MemberRegister

Web service method: UploadMemberRegister

Description: Web service method used by the Payer to upload the member details through a MemberRegister file to the DHPO.

Signature: UploadMemberRegistrationResponse UploadMemberRegister ( string Login,

string Pwd, byte[] fileContent

)

Input element Description

payerLogin Payer user login name to connect to the DHPO

facilityPwd Payer user password to connect to the DHPO

fileContent Content of the file to be uploaded. Field restrictions:

1 record per file.

Output object: output response will be an object containing the below elements

Element Description

Result Result of the transaction; successful or failed.

FileID Original file name; this file name will be used later to show users the available files for download

ErrorMessage

Output parameter that contains the transaction status: Error: error message if something goes wrong; web service can also send warnings using this parameter; the parameter may be null or empty string if the web service returns zero, otherwise the error message is expected Successful: empty

ErrorReport Output parameter that contains byte array with the content of error report eventually generated by DHPO validation during file upload; the parameter may be null

Return value: The web service may return values described in the section Web Services Returned Values.

Below is a list of the fields utilized during the upload of the Member Register file to the DHPO, by the

payers.

No. Element Description Mandatory

1 Header Header element of the MemberRegister transaction Yes

1.1 SenderID ID of the facility sending the MemberRegister Yes

1.2 ReceiverID ID of the facility receiving the MemberRegister Yes

Page 13: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

12 | P a g e

1.3 TransactionDate Date of the transaction Possible values: DD/MM/YYYY

Yes

1.4 RecordCount Number of members within the MemberRegister request Yes

1.5 DispositionFlag To indicate the file type (TEST or PRODUCTION) Yes

2 Person Person element of the MemberRegister transaction Yes

2.1 FirstName Member’s first name as spelled in the passport Yes

2.2 SecondName Member’s second name as spelled in the passport No

2.3 FamilyName Member’s family/last/surname name as spelled in the passport

Yes

2.4 ContactNumber Member’s primary mobile contact number No

2.5 dateOfBirth Member’s date of birth (DD/MM/YYYY) - for those official documents that are missing the values please fill in the following format: - Contains Year only: 01-01-yyyy

Yes

2.6 Gender Member’s gender (1 = male, 0 = female, 9 = unknown) Yes

2.7 Nationality Member’s nationality code as per the list published on the eClaimLink (GDRFA Nationalities)

Yes

2.8 PassportNumber Member’s passport number of the passport that has the UAE visa, or if not available, the National ID (for example GCC Nationals)

Yes

2.9 MaritalStatus Member’s current marital status (1 = unmarried, 2 = married)

Yes

2.10 Email Member’s personal email address No

2.11 Emirate The Emirate from which the member's visa/residency is issued from. (4=Dubai, 2=Abu Dhabi, 6=Ajman, 9=Fujairah, 7=Ras Al Khaimah, 1=Sharjah, 5=Umm Al Quwain, 10=UAE national, 11=Dubai national, 12=GCC national, 13=Diplomat)

Yes

2.12 ResidentialLocation Member’s actual place of residence. Use the corresponding 3-digit location code from the predefined DSC locations list published on eClaimLink DHD.

Yes

2.13 WorkLocation Member’s actual place of work. Use the corresponding 3-digit location code from the predefined DSC locations list published on eClaimLink DHD.

Yes

2.14 Salary Member’s salary bracket. (1 = less than 4000 AED/month, 2 = between 4001 AED and 12000 AED/month, 3 = more than 12000 AED/month, 4 = no salary; will be used for dependents or children that do not acquire a salary)

Yes

2.15 Commission Member’s salary is commission based? (1 = yes, 2 = no) Yes

2.16 EmiratesIDNumber Member’s unique emirates ID number, when not available use: - 000-0000-0000000-0 for National without card - 111-1111-1111111-1 for Expatriate resident without a card - 333-3333-3333333-3 for NewBorn without a card

Yes

Page 14: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

13 | P a g e

2.17 UIDNumber Member’s UID number as issued by the MOI. When not available (only for non-Dubai residency/visa holders), copy the member’s passport number from the “PassportNumber” field.

Yes

3 Member Member element of the MemberRegister transaction Yes

3.1 ID The patient's insurance member number, if the patient is claiming insurance. Otherwise, this field should be left empty.

Yes

3.2 Relation Member’s relation (Principal, spouse, child, parent or other) Yes

3.3 RelationTo The information about the MemberID of the principal member of the family. Member ID should be used if reported member is the principal beneficiary.

Yes

4 Contract Contract element of the MemberRegister transaction Yes

4.1 PayerID The member’s insurance DHA payer ID. Yes

4.2 ProductOrigin Product origin (2 = Abu Dhabi, 4 =Dubai) Yes

4.3 ProductCode ID of the insurance product as in the payer’s literature Yes

4.4 ProductID ID granted by the eClaimLink to the registered product yes

4.5 PolicyID ID of the insurance policy as registered in the payer’s system Yes

4.6 TopUpPolicy Any policy which provides benefits over and above the benefits provided under the main Dubai compliant policy. (1 = Top-Up Policy, 2 = Main Policy)

No

4.7 EnrollmentDate The day (at 00.00 hours local time), month and year (dd/mm/yyyy) from which the Policy became effective for the Insured Member.

Yes

4.8 DeletionDate The Expiry Date of the policy unless the member has been removed prior to the expiry of the policy, in which case, enter the day at 00:00hrs local time, month and year (dd/mm/yyyy) on which the insured member's coverage ceases as the result of his/her deletion at the request of the PolicyHolder.

Yes

4.9 GrossPremium The amount in AED of the annualized premium payable for this insured member.

Yes

4.10 ActualPremium The amount in AED of the premium payable for this insured member if charged on a pro-rata basis related to period of coverage. If not charged on a pro-rata basis, then enter same figure as for GrossPremium.

Yes

5 Establishment Establishment element of the MemberRegister transaction Yes

5.1 EntityType This is the type of the sponsoring entity. 1 = Resident 2 = Citizen (i.e. UAE locals, GCC locals) 3 = Establishment 4 = Property Owner

Yes

5.2 EntityID Official ID of the sponsoring entity Yes

5.3 ContactNumber The primary contact number of the policy holder Yes

Page 15: elaimLink – GDRFA Integration Register Document - Phase 2 (GDRFA Validation).pdf · with the Unified Identity Number utilized at the GDRFA and United Arab Emirates Ministry of Interior

14 | P a g e

5.4 Email The email address of the policy holder Yes

Web Services Returned Values

All DHPO MemberRegister services share the return value, so that client application can implement one handler to process the result of web service execution and share it with all web service calls. The supported returned values are shown below:

Element Description

UploadMemberRegister

0 Success: Transaction uploaded successfully

-1 Login failed

-2 Transaction validation failed with errors

-4 Unexpected error occurred

ValidateMemberUID

1 Match

-1 Login Failed + Error Message: Wrong user credentials and/or wrong parameters data type.

-2 Mismatch + Error Message: Member details does not match the record or visa is expired.

-3 Visa source type 2, no need to validate. You can proceed by uploading the member’s record.

-4 Unexpected error occurred

Member Register Integration Web Services (WSDL)

GDRFA – eClaimLink integration web services link

https://mr.eclaimlink.ae/MemberRegistration.svc?wsdl

Testing web service link:

http://qa.dimensions-healthcare.net/MemberRegistration/MemberRegistration.svc?wsdl

Each payer can utilize their own credentials for testing runs.