Fund Verification

Fund verification #

You can verify a patient’s membership details with their private health fund. A successful search will return the message “Patient is eligible to claim with Health Fund specified in the request.”

POST - Verify Fund details #

{{base_url}}/{{version}}/verify

Headers

HeaderValue
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer {{oauth_token}}

Body

{
    "type": "Verify:Fund",
    "patient": {
        "dateOfBirth": "1963-12-14",
        "gender": "M", 
        "name": {
            "family": "BAILEY", 
            "first": "FRANK"
        },
        "fund": {
            "eclipseId": "TST", 
            "number": "12345678A"
        }
    }
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/verify' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "type": "Verify:Fund",
    "patient": {
        "dateOfBirth": "1963-12-14",
        "gender": "M", 
        "name": {
            "family": "BAILEY", 
            "first": "FRANK"
        },
        "alias": {
            "family": "BAYLEY", 
            "first": "FRANCIS"
        },
        "fund": {
            "eclipseId": "STS", 
            "number": "12345678A",
            "ref": "01"
        }
    },
    "provider": {
        "servicing": "2418291F"
    }
}'

Example Response:

Body:

{
    "provider": {
        "servicing": "2418291F"
    },
    "patient": {
        "fund": {
            "number": "12345678A"
            "eclipseId": "TST"
        },
        "dateOfBirth": "1963-12-14",
        "name": {
            "family": "BAILEY",
            "first": "FRANK"
        },
        "gender": "M"
    },
    "status": {
        "fund": {
            "message": "Patient is eligible to claim with Health Fund specified in the request.",
            "code": 0
        }
    }
}

Headers:

HeaderValue
Servernginx/1.19.3
DateTue, 08 Jun 2021 04:49:28 GMT
Content-Typeapplication/json
Content-Length380
Connectionkeep-alive
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsGET, POST, OPTIONS

POST - Verify Fund details - known to Fund with different name #

If the patient is known to the health fund under a different name than the name they have given you, it is possible to submit their name as an alias along with the name which Medicare knows them as.

Some funds also require a reference (family member number on the card eg ‘2’).

{{base_url}}/{{version}}/verify

Headers

HeaderValue
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer {{oauth_token}}

Body

{
    "type": "Verify:Fund",
    "patient": {
        "dateOfBirth": "1963-12-14",
        "gender": "M", 
        "name": {
            "family": "BAILEY", 
            "first": "FRANK"
        },
        "alias": {
            "family": "BAYLEY", 
            "first": "FRANCIS"
        },
        "fund": {
            "eclipseId": "STS", 
            "number": "12345678A",
            "ref": "01"
        }
    }
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/verify' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "type": "Verify:Fund",
    "patient": {
        "dateOfBirth": "1963-12-14",
        "gender": "M", 
        "name": {
            "family": "BAILEY", 
            "first": "FRANK"
        },
        "alias": {
            "family": "BAYLEY", 
            "first": "FRANCIS"
        },
        "fund": {
            "eclipseId": "STS", 
            "number": "12345678A",
            "ref": "01"
        }
    }
}'

Example Response:

Body:

{
  "patient": {
    "alias": {
      "family": "BAYLEY",
      "first": "FRANCIS"
    },
    "fund": {
      "number": "12345678A",
      "ref": "1",
      "eclipseId": "STS"
    },
    "dateOfBirth": "1963-12-14",
    "name": {
      "family": "BAILEY",
      "first": "FRANK"
    },
    "gender": "M"
  },
  "status": {
    "fund": {
      "message": "Patient is eligible to claim with Health Fund specified in the request.",
      "code": 0
    }
  }
}

Headers:

HeaderValue
Servernginx/1.19.3
DateTue, 08 Jun 2021 04:49:28 GMT
Content-Typeapplication/json
Content-Length341
Connectionkeep-alive
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsGET, POST, OPTIONS