API Referenceeligibility

Subsidy and medical eligibility

Authentication

Authorizationstring

API key to authenticate for external integrations. Use the format: “ApiKey insert-token-here”

Query parameters

referrerIdstringRequired
ID of the referring individual.
referrerIdTypeenumRequired
Type of ID specified in referrerId.
Allowed values:
referrerInstitutionIdstringRequired
ID of the referring institution.
patientPostalCodestringOptional
Postal code of the patient
uinstringRequired

Patient’s unique identity number (NRIC or FIN)

offeringIdstringRequired
Referral destination to check eligibility for
referrerIdstringRequired
ID of the referring individual.
referrerIdTypeenumRequired
Type of ID specified in referrerId.
Allowed values:
referrerInstitutionIdstringRequired
ID of the referring institution.
patientPostalCodestringOptional
Postal code of the patient
uinstringRequired

Patient’s unique identity number (NRIC or FIN)

offeringIdstringRequired
Referral destination to check eligibility for

Response

referralobject
subsidyobject
Will be present if isAllowed for referral is true

Errors

401
Unauthorized Error