The Authorisation APIs bundle exposes APIs to enable membership enquiry.
Getting started
General aspects of integrating with Healthcode APIs, like authentication and authorisation, naming conventions, data formatting assumptions, error handling requirements, etc. are documented here.
Pay special attention to the aspects of using discovery document, the need to specify site id within the request headers, and the need to specify exact API version.
Also, be certain you are connecting to the correct environment. If you are trying to integrate into our sandbox (UAT) environment, read instructions here first to understand the requirements.
Coverage
The Coverage resource is used to provide information about the membership details of a patient for a particular insurer. Following APIs enable operating against the resource.
Find Member
The Find Member API enables searching for membership details using different filter criteria.
Endpoint
Must be looked up from the discovery document using key find_member_endpoint.
Request
Please note, this API uses HTTP POST
method and accepts url-encoded key value pairs in request body. A sample POST
request for this API is provided below. The insurerIdentifier is a mandatory parameter and depending upon the insurer all other parameters can be mandatory or optional which is documented here.
curl --request POST
--url '{find_member_endpoint}'?
--header 'SU-SiteId: HC12393'
--header 'Content-Type: application/x-www-form-urlencoded'
--header 'Authorization: Bearer abCdE12...89mNopq0r'
--data-urlencode 'insurerIdentifier=bup'
--data-urlencode 'firstName=S'
--data-urlencode 'lastName=Gray'
--data-urlencode 'sex=Male'
--data-urlencode 'dateOfbirth=1998-08-08'
--data-urlencode 'postCode=BT43%207BU'
--data-urlencode 'membershipNumber=002WMQ'
--data-urlencode 'groupId=015T6W'
--data-urlencode 'policyActiveOn=2023-09-25'
Where,
Field | Type | Description |
---|---|---|
insurerIdentifier | String | Insurer’s identifier. Following are the supported insurers and its identifiers: Bupa = bup AXA Health = ppp Aviva = nuh Vitality Health = slh Cigna Healthcare = cig Trust in Health = tih |
firstInitial | String | Member’s first initial |
lastName | String | Member’s last name |
sex | String | Member’s gender |
dateOfBirth | String | Member’s date of birth |
postCode | String | Member’s postal code |
membershipNumber | String | Insurers unique identifier for the member |
groupId | String | Identifier for this member’s policy, where the member is part of a group policy |
policyActiveOn | String | Date to check if policy is active or not |
Response
The API returns a Coverage resource if a single match is found. In case of no match or multiple matches the API will return OperationOutcome resource.
{
"resourceType": "Coverage",
"id": "101",
"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",
"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",
"valueDateTime": "2022-01-01T00:00:00+05:30"
},
{
"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+05:30"
},
{
"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+05:30"
},
{
"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+05:30",
"end": "2023-12-03T00:00:00+05:30"
},
"payor": [
{
"reference": "#2"
}
]
}
Where,
Name | Type | Card. | Description | FHIR Field |
---|---|---|---|---|
Coverage ID | Id | 1-1 | Coverage ID | Coverage.id |
Given Name | String | 1-1 | Member’s given or first name | Coverage.contained.Patient.name.given |
Family Name | String | 1-1 | Member’s family or last name | Coverage.contained.Patient.name.family |
Gender | Code | 1-1 | Member’s sex at birth | Coverage.contained.Patient.gender |
Birth Date | Date | 1-1 | Member’s date of birth | Coverage.contained.Patient.birthDate |
Address | Address | 1-1 | Member’s address which contains line, city, district, state, postalCode and country fields | Coverage.contained.Patient.address |
Gender Identity | String | 0-1 | The gender by which the member prefers to be identified | Coverage.contained.Patient.extension.valueString – genderIdentity |
Other Initials | String | 0-1 | Member’s other initials | Coverage.contained.Patient.extension.valueString – otherInitials |
Insurer Name | String | 1-1 | Insurer’s name | Coverage.contained.Organization.name |
ContactPoint | 0-1 | Insurer’s email | Coverage.contained.Organization.telecom.email | |
Phone | ContactPoint | 0-1 | Insurer’s phone number | Coverage.contained.Organization.telecom.phone |
Insurer Identifier | Identifier | 1-1 | Insurer’s unique identifier for this member | Coverage.identifier |
Start | DateTime | 1-1 | The date on which the cover for this member starts | Coverage.period.start |
End | DateTime | 1-1 | The date on which the cover for this member ends | Coverage.period.end |
Group ID | String | 0-1 | Identifier for this member’s policy, where the member is part of a group policy | Coverage.extension.valueString – groupId |
Policy Expired | String | 1-1 | Indicates policy expiry status. Expected value is either ‘Yes’ or ‘No’ | Coverage.extension.valueString – policyExpired |
Expiry Date | Date | 0-1 | The date on which cover expired | Coverage.extension.valueDate – expiryDate |
Cover Type | String | 0-1 | Policy scheme to which group/member belongs | Coverage.extension.valueString – coverType |
Benefit Limit | Money | 0-1 | The maximum benefit available to the member on this policy | Coverage.extension.valueMoney – benefitLimit |
Benefit Used | Money | 0-1 | The amount of benefit already used by this member on this policy | Coverage.extension.valueMoney – benefitUsed |
Benefit Used As Of | DateTime | 0-1 | The date/time on which the consumed benefit amount was calculated | Coverage.extension.valueDateTime – benefitUsedAsOf |
Member Excess | Money | 0-1 | The excess amount to be paid by the member on this policy | Coverage.extension.valueMoney – memberExcess |
Member Excess Type | String | 0-1 | The period over which the excess amount is applicable. Expected value is either ‘Policy period’ or ‘Each Claim/Episode’ | Coverage.extension.valueString – memberExcessType |
Excess Used | Money | 0-1 | The excess amount already paid by the member on this policy | Coverage.extension.valueMoney – excessUsed |
Excess Used As Of | DateTime | 0-1 | The date/time on which the paid excess was calculated | Coverage.extension.valueDateTime – excessUsedAsOf |
Member CoPayment | Money or Decimal | 0-1 | The amount to be paid by the member under any policy co-payment arrangement. This will return valueMoney object if value is supplied as ‘Monetary value’ by insurer or it will return valueDecimal object if the value is supplied as ‘Percentage’ by insurer | Coverage.extension.valueMoney – memberCoPayment OR Coverage.extension.valueDecimal – memberCoPayment |
Member CoPayment Type | String | 0-1 | The type in which the copayment value is supplied by insurer. Expected value is either ‘Monetary value’ or ‘Percentage’ | Coverage.extension.valueString – memberCoPaymentType |
Currency | String | 0-1 | Currency code for the monetary values | Coverage.extension.valueString – currency |
Error handling
HTTP Code | Error Code | Description |
---|---|---|
400 | NO_MATCH_FOUND | No match found for search parameter |
400 | MULTIPLE_MATCH_FOUND | Multiple match found for search parameters |
400 | MSG_MISSING_MANDATORY_PARAM | Missing mandatory parameter |
422 | MSG_PARAM_INVALID | Parameter content is invalid |
400 | MSG_CANT_PARSE_CONTENT | Unprocessable Entity |
500 | MSG_DATABASE_ERROR | Failed processing entity in Database |
Please note that the HTTP Code 400 for NO_MATCH_FOUND and MULTIPLE_MATCH_FOUND is a deviation from the empty resultset as specified here within general-overview part of API Docs, but is intentional to keep the handling consistent between NO_MATCH_FOUND and MULTIPLE_MATCH_FOUND.
PreAuth
PreAuth is defined by a Claim FHIR resource that contains Pre-Authorisation details. ‘preauthorization‘ will be used within the Claim resource ‘use’ field to indicate it is a Pre-Authorisation resource. The following APIs enable operating against this resource.
Search Authorisation API
The Search Authorisation API enables the caller to retrieve a list of authorisations based on search criteria.
Endpoint
Must be looked up from the discovery document using key search_authorisation_endpoint.
Request
curl --request POST
--url '{search_authorisation_endpoint}'?
--header 'SU-SiteId: HC12393'
--header 'Content-Type: application/x-www-form-urlencoded'
--header 'Authorization: Bearer abCdE12...89mNopq0r'
--data-urlencode 'insurerIdentifier=tih'
--data-urlencode 'issueDate=2024-05-05&'
--data-urlencode 'caseId=NWPY1NYDGF8U8HVNQROFC6JAO'
--data-urlencode 'authCode=QEGGQE91C4'
--data-urlencode 'status=read'
--data-urlencode 'membershipNumber=002WMQ'
--data-urlencode '_sort=issueDate'
--data-urlencode '_since=2024-03-01T09:00:00'
--data-urlencode 'page=1'
--data-urlencode 'count=10'
Where,
Field | Type | Mandatory/ Optional | Description |
---|---|---|---|
insurerIdentifier | String | O | Insurer’s identifier. The following are supported insurers and identifiers: Aviva = nuh Vitality Health = slh Trust in Health = tih |
issueDate | String | O | Authorisation issue date |
caseId | String | O | Authorisation Case ID |
authCode | String | O | Authorisation code |
status | String | O | Read/Unread status for an authorisation record |
membershipNumber | String | O | Insurers unique identifier for the member |
_sort | String | O | Sort results by issue date. Use _sort=issueDate to sort results on issue date in ascending order, or _sort=-issueDate for descending order |
_since | String | O | Last updated date time of records |
page | String | O | Page index to be fetched {1,2,3..} |
count | String | O | Maximum records in a page |
Response
The API returns a Bundle of Claim resources based on the search filters.
{
"resourceType": "Bundle",
"meta": {
"tag": [
{
"code": "page",
"display": "1"
},
{
"code": "count",
"display": "10"
},
{
"code": "maxCount",
"display": "1"
}
]
},
"type": "collection",
"total": 1,
"entry": [
{
"resource": {
"resourceType": "Claim",
"id": "Q8I7UU181Z4PZCCIN80N538OR",
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/authCode",
"valueString": "QEGGQE91C4"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/lastUpdatedOn",
"valueDateTime": "2024-05-05T00:40:00+00:00"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/insurerIdentifier",
"valueString": "tih"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/isRead",
"valueBoolean": true
}
],
"identifier": [
{
"system": "https://ref.api.healthcode.co.uk/caseId",
"value": "NWPY1NYDGF8U8HVNQROFC6JAO"
},
{
"system": "https://ref.api.healthcode.co.uk/membershipNumber",
"value": "FG176A1"
}
],
"use": "preauthorization",
"diagnosis": [
{
"type": [
{
"coding": [
{
"system": "https://ref.api.healthcode.co.uk/diagnosis/ICD9",
"code": "03700",
"display": "TETANUS"
}
]
}
]
}
]
}
}
]
}
Where,
Name | Type | Card. | Description | FHIR Field |
---|---|---|---|---|
Id | Id | 1-1 | Authorisation ID | Claim.id |
Use | Code | 1-1 | Code to indicate an authorisation resource | Claim.use |
Case ID | String | 0-1 | Authorisation Case ID | Claim.identifier.value – caseId |
Membership Number | String | 1-1 | Insurer’s unique identifier for this member | Claim.identifier.value – membershipNumber |
Diagnosis | CodeableConcept | 1-1 | The condition for which the treatment(s) are being provided and response includes diagnosis scheme, code and name | Claim.diagnosis.type.coding |
Auth Code | String | 1-1 | Authorisation identifier allocated by the insurer | Claim.extension.valueString – authCode |
Insurer Identifier | String | 1-1 | Insurer identifier | Claim.extension.valueString – insurerIdentifier |
Is Read | Boolean | 0-1 | Read/Unread status for an authorisation record | Claim.extension.valueBoolean – isRead |
Last Updated On | DateTime | 0-1 | Authorisation last updated date time | Claim.extension.valueDateTime – lastUpdatedOn |
Error handling
HTTP Code | Error Code | Description |
---|---|---|
400 | MSG_PARAM_EMPTY | Parameter is null/empty |
422 | MSG_PARAM_INVALID | Parameter content is invalid |
422 | MSG_DATE_FORMAT | Invalid date format |
400 | MSG_CANT_PARSE_CONTENT | Unprocessable Entity |
500 | MSG_DATABASE_ERROR | Failed processing entity in Database |
Get Authorisation API
The Get Authorisation API enables the caller to retrieve authorisation details with a known authorisation ID.
Endpoint
Must be looked up from the discovery document using key get_authorisation_endpoint.
Request
curl --request POST
--url '{get_authorisation_endpoint}/{authorisationId}'?
--header 'SU-SiteId: HC12393'
--header 'Content-Type: application/fhir+json'
--header 'Authorization: Bearer abCdE12...89mNopq0r'
Where,
Field | Type | Mandatory/ Optional | Description |
---|---|---|---|
authorisationId | String | M | Authorisation’s ID. This can be retrieved from the Search Authorisation API |
Response
The API returns a Claim resource which contains the required authorisation details.
{
"resourceType": "Claim",
"id": "20220603abc00000000000001",
"contained": [
{
"resourceType": "Coverage",
"contained": [
{
"resourceType": "Organization",
"id": "PR00006D",
"identifier": [
{
"system": "https://ref.api.healthcode.co.uk/insurer-identifier",
"value": "slh"
}
],
"name": "Vitality Health",
"telecom": [
{
"system": "email",
"value": "helpline@vitality.co.uk"
},
{
"system": "phone",
"value": "0800 092 9400"
}
]
},
{
"resourceType": "Patient",
"name": [
{
"family": "Henry",
"given": [
"watson"
],
"prefix": [
"Mr"
]
}
],
"gender": "male",
"birthDate": "1988-08-08",
"address": [
{
"line": [
"4 THE VALE"
],
"city": "MYATTS FIELDS SOUTH",
"district": "GODALMING",
"state": "GODALMING",
"postalCode": "E1 2PW",
"country": "UK"
}
]
}
],
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/groupPolicyId",
"valueString": "1244942114"
}
],
"period": {
"start": "2024-01-01T00:00:00+00:00",
"end": "2025-01-01T00:00:00+00:00"
}
}
],
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/status",
"valueString": "ACTIVE"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/package",
"valueString": "Yes"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/claimNumber",
"valueString": "4354RE35VR"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/issueDate",
"valueDateTime": "2024-05-05T00:00:00+00:00"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/authCode",
"valueString": "THPAR3PNHC"
}
],
"identifier": [
{
"system": "https://ref.api.healthcode.co.uk/caseid",
"value": "0000050f5d144760a5072d3ac"
},
{
"system": "https://ref.api.healthcode.co.uk/membershipNumber",
"value": "30001192"
}
],
"use": "preauthorization",
"item": [
{
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/decision",
"valueString": "APPROVED"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/episodeSetting",
"valueString": "Inpatient"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/authorisedFrom",
"valueDateTime": "2024-05-05T00:00:00+00:00"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/authorisedTo",
"valueDateTime": "2024-05-06T00:00:00+00:00"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/firstDateOfService",
"valueDateTime": "2024-05-05T00:00:00+00:00"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/lastDateOfService",
"valueDateTime": "2024-05-06T00:00:00+00:00"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/inpatientNights",
"valueString": "1"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://ref.api.healthcode.co.uk/extension/industryStandardCode/ISC",
"code": "E0002960",
"display": "Physiotherapy, Knee Clinic"
}
]
}
},
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/decision",
"valueString": "APPROVED"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/insurerProviderCode",
"valueString": "10000756"
}
],
"system": "https://ref.api.healthcode.co.uk/Location",
"code": "HP000021",
"display": "Markers Lane"
}
]
}
},
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/decision",
"valueString": "APPROVED"
},
{
"url": "https://ref.api.healthcode.co.uk/extension/insurerProviderCode",
"valueString": "10000756"
}
],
"system": "https://ref.api.healthcode.co.uk/Practitioner",
"code": "SP003516",
"display": "Doctor Aeron G Davies"
}
]
}
}
]
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"url": "https://ref.api.healthcode.co.uk/extension/createdOn",
"valueDateTime": "2024-01-18T11:55:55+00:00"
}
],
"system": "https://ref.api.healthcode.co.uk/note",
"display": "Participation in sports and recreational activities are risk factors for knee injury."
}
]
}
}
]
}
]
}
Where,
Name | Type | Card. | Description | FHIR Field |
---|---|---|---|---|
Id | Id | 1-1 | Authorisation ID | Claim.id |
Use | Code | 1-1 | Code to indicate an authorisation resource | Claim.use |
Case ID | String | 0-1 | Authorisation Case ID | Claim.identifier.value – caseId |
Membership Number | String | 1-1 | Insurer’s unique identifier for this member | Claim.identifier.value – membershipNumber |
Diagnosis | CodeableConcept | 1-1 | The condition for which the treatment(s) are being provided and response includes diagnosis scheme, code and name | Claim.diagnosis.type.coding |
Auth Code | String | 1-1 | Authorisation identifier allocated by the insurer | Claim.extension.valueString – authCode |
Status | String | 1-1 | Indicates authorisation status | Claim.extension.valueString – status |
Package | String | 0-1 | Indicates weather authorisation includes a packaged treatment | Claim.extension.valueString – package |
Claim Number | String | 0-1 | Claim number | Claim.extension.valueString – claimNumber |
Issue Date | DateTime | 1-1 | The date on which the authorisation was issued | Claim.extension.valueString – issueDate |
Industry Standard Code | CodeableConcept | 1-1 | The actual service for which the authorisation belongs to and response includes industry standard scheme, code and name | Claim.item.extension.valueCodeableConcept.coding |
Episode Setting | String | 1-1 | The episode setting of a given service. Expected values are Inpatient, Outpatient, Daycase | Claim.item.extension.valueString – episodeSetting |
Decision | String | 1-1 | The decision for a given service. Expected values are Approved, Declined, Pending | Claim.item.extension.valueString – decision |
Authorised From | DateTime | 1-1 | The start date for which authorisation of the given service is valid | Claim.item.extension.valueDateTime – authorisedFrom |
Authorised To | DateTime | 1-1 | The end date for which authorisation of the given service is valid | Claim.item.extension.valueDateTime – authorisedTo |
First Date of Service | DateTime | 0-1 | The start date of actual treatment | Claim.item.extension.valueDateTime – firstDateOfService |
Last Date of Service | DateTime | 0-1 | The end date of actual treatment | Claim.item.extension.valueDateTime – lastDateOfService |
Inpatient Nights | Integer | 0-1 | Number of inpatient nights. This value will be available only if episode setting is set to inpatient | Claim.item.extension.valueInteger – inpatientNights |
Location | CodeableConcept | 1-* | The location or treatment site where the service may be provided and response includes HP number and name of the location | Claim.item.extension.valueCodeableconcept.coding |
Decision | String | 1-1 | The decision for a given location. Expected values are Approved, Declined, Pending | Claim.item.extension.valueCodeableconcept.coding.extension.valueString – decision |
Insurer Provider Code | String | 1-1 | The insurer provider code for the given location | Claim.item.extension.valueCodeableconcept.coding.extension.valueString – insurerProviderCode |
Practitioner | CodeableConcept | 1-* | The practitioner or specialist authorised to carry out the treatment and response includes SP number and name of the practitioner | Claim.item.extension.valueCodeableconcept.coding |
Decision | String | 1-1 | The decision for a given practitioner. Expected values are Approved, Declined, Pending | Claim.item.extension.valueCodeableconcept.coding.extension.valueString – decision |
Insurer Provider Code | String | 1-1 | The insurer provider code for the given practitioner | Claim.item.extension.valueCodeableconcept.coding.extension.valueString – insurerProviderCode |
Procedure | CodeableConcept | 0-* | The procedure code is expected to be carried out as part of the service and response includes procedure scheme, code and name | Claim.item.extension.valueCodeableconcept.coding |
Decision | String | 1-1 | The decision for a given procedure. Expected values are Approved, Declined, Pending | Claim.item.extension.valueCodeableconcept.coding.extension.valueString – decision |
Note | CodeableConcept | 0-* | The notes related to the authorisation | Claim.item.extension.valueCodeableconcept.coding |
Created On | DateTime | 1-1 | The date on which the note was added | Claim.item.extension.valueCodeableconcept.coding.extension.valueDateTime |
Insurer | Resource | 1-1 | This resource includes insurer’s id, identifier and name related to the given authorisation | Claim.contained.Coverage.contained.Organization |
Member | Resource | 1-1 | This resource includes member details like name, gender, data of birth and address | Claim.contained.Coverage.contained.Patient |
Error handling
HTTP Code | Error Code | Description |
---|---|---|
400 | MSG_PARAM_EMPTY | Parameter is null/empty |
422 | MSG_PARAM_INVALID | Parameter content is invalid |
400 | MSG_MISSING_MANDATORY_PARAM | Missing mandatory parameter |
400 | INVALID_RESOURCE | Unprocessable Entity |
500 | MSG_DATABASE_ERROR | Failed processing entity in Database |