Note these are reserved APIs for use by Healthcode internal products only. These APIs must not be consumed by external integrators.
List Insurers
The List Insurers API enables to retrieve the insurers applicable for membership enquiry.
Request
curl --request GET
--url 'https://policies.api.dev.healthcode.co.uk/insurers?
page=1&
count=2
--header 'Content-Type: application/fhir+json'
--header 'Authorization: Bearer abCdE12...89mNopq0r' Response
The API returns a list of Organization resources in FHIR JSON format.
{
"resourceType": "Bundle",
"id": "insurer",
"meta": {
"tag": [
{
"code": "page",
"display": "1"
},
{
"code": "count",
"display": "2"
},
{
"code": "maxCount",
"display": "6"
}
]
},
"type": "collection",
"total": 2,
"entry": [
{
"resource": {
"resourceType": "Organization",
"id": "PR00007D",
"contained": [
{
"resourceType": "Parameters",
"id": "Insurer find member parameters",
"parameter": [
{
"name": "Last Name",
"valueBoolean": true
},
{
"name": "First Initial",
"valueBoolean": true
},
{
"name": "Date of Birth",
"valueBoolean": true
},
{
"name": "Sex",
"valueBoolean": false
},
{
"name": "Postcode",
"valueBoolean": true
},
{
"name": "Membership Number",
"valueBoolean": false
},
{
"name": "Group Id",
"valueBoolean": false
},
{
"name": "Policy Active On",
"valueBoolean": false
}
]
}
],
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/logoLink",
"valueString": "assets/insurer-logos/aviva.svg"
}
],
"active": true,
"name": "Aviva",
"telecom": [
{
"system": "email",
"value": "hcmohe@aviva.co.uk"
},
{
"system": "phone",
"value": "0808 101 4010"
}
]
}
},
{
"resource": {
"resourceType": "Organization",
"id": "PR00004D",
"contained": [
{
"resourceType": "Parameters",
"id": "Insurer find member parameters",
"parameter": [
{
"name": "Last Name",
"valueBoolean": true
},
{
"name": "First Initial",
"valueBoolean": true
},
{
"name": "Date of Birth",
"valueBoolean": true
},
{
"name": "Sex",
"valueBoolean": false
},
{
"name": "Postcode",
"valueBoolean": true
},
{
"name": "Membership Number",
"valueBoolean": false
},
{
"name": "Group Id",
"valueBoolean": false
},
{
"name": "Policy Active On",
"valueBoolean": false
}
]
}
],
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/logoLink",
"valueString": "assets/insurer-logos/AXA_Health.png"
}
],
"active": true,
"name": "AXA Health"
}
}
]
}Error handling
| HTTP Code | Error Code | Description |
|---|---|---|
| 400 | MSG_PARAM_EMPTY | Parameter is null/empty |
| 422 | MSG_PARAM_INVALID | Parameter content is invalid |
Get Member History Record
The Get Member History API enables to retrieve the membership details of already searched members.
Request
curl --request GET
--url 'https://policies.api.dev.healthcode.co.uk/member-search-history/2023110713202937219LO1631
--header 'SU-SiteId: HC12393'
--header 'Content-Type: application/fhir+json'
--header 'Authorization: Bearer abCdE12...89mNopq0r' Where,
| Field | Type | Description |
|---|---|---|
| requestId | String | Request ID of member history record. This needs to be retrieved using Search Member History API |
Response
The API returns a Coverage resource if the status is single match found. In case of no match or multiple matches the API will return OperationOutcome resource.
{
"resourceType": "Coverage",
"contained": [
{
"resourceType": "Patient",
"id": "1",
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/otherInitials",
"valueString": "P"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/genderIdentity",
"valueString": "male"
}
],
"name": [
{
"family": "Gray",
"given": [
"Stuart"
]
}
],
"gender": "male",
"birthDate": "1998-08-08",
"address": [
{
"line": [
"Flat 1 Lazenbys Restaurant"
],
"city": "Sandy Way",
"district": "CAMBRIDGE",
"state": "Greater Manchester",
"postalCode": "BT43 7BU",
"country": "GB"
}
]
},
{
"resourceType": "Organization",
"id": "2",
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/logoLink",
"valueString": "assets/insurer-logos/bupa.svg"
}
],
"name": "Bupa",
"telecom": [
{
"system": "email",
"value": "bupa@support.com"
},
{
"system": "phone",
"value": "447488803755"
}
]
}
],
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/doNotReject",
"valueString": "No"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/currency",
"valueString": "GBP"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/memberCoPayment",
"valueMoney": {
"value": 50
}
},
{
"url": "https://ref.api.healthcode.co.uk/insuranceSchemePlan",
"valueString": "Key"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/policyExpired",
"valueString": "Yes"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/expiryDate",
"valueDate": "2022-01-01"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/groupId",
"valueString": "015T6W"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/benefitLimit",
"valueMoney": {
"value": 1000
}
},
{
"url": "https://ref.api.healthcode.co.uk/extension/benefitUsed",
"valueMoney": {
"value": 250
}
},
{
"url": "https://ref.api.healthcode.co.uk/extension/benefitUsedAsOf",
"valueDateTime": "2023-08-03T00:00:00+00:00"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/memberExcess",
"valueMoney": {
"value": 100
}
},
{
"url": "https://ref.api.healthcode.co.uk/extension/excessUsed",
"valueMoney": {
"value": 50
}
},
{
"url": "https://ref.api.healthcode.co.uk/extension/excessUsedAsOf",
"valueDateTime": "2023-08-03T00:00:00+00:00"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/memberExcessType",
"valueString": "Each Claim/Episode"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/memberCoPaymentType",
"valueString": "Monetary Value"
}
],
"identifier": [
{
"id": "membershipNumber",
"value": "002WMQ"
}
],
"beneficiary": {
"reference": "#1"
},
"period": {
"start": "2023-08-01T00:00:00+00:00",
"end": "2024-12-03T00:00:00+00:00"
},
"payor": [
{
"reference": "#2"
}
]
}Error handling
| HTTP Code | Error Code | Description |
|---|---|---|
| 422 | NO_MATCH_FOUND | No match found for search parameter |
| 422 | MULTIPLE_MATCH_FOUND | Multiple match found for search parameters |
| 400 | MSG_PARAM_EMPTY | Parameter is null/empty |
| 400 | INVALID_RESOURCE | Unprocessable Entity |