Submit Pre-auth
curl --request POST \
--url https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_type": "<string>",
"auth_type": "<string>",
"clinical_notes": "<string>",
"consent": {
"answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"questionnaire_url": "<string>"
},
"diagnosis": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"items": [
{
"claim_amount": 123,
"procedure_code": "<string>",
"procedure_name": "<string>",
"quantity": 123,
"questionnaire_answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"speciality_code": "<string>",
"speciality_name": "<string>",
"strat_code": "<string>",
"strat_display": "<string>",
"supporting_docs": [
{
"content": "<string>",
"content_type": "<string>",
"creation": "<string>",
"doc_id": "<string>",
"mand_code": "<string>",
"title": "<string>",
"url": "<string>"
}
]
}
],
"planned_end_date": "2023-11-07T05:31:56Z",
"planned_start_date": "2023-11-07T05:31:56Z",
"user_token": "<string>"
}
'import requests
url = "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth"
payload = {
"request_type": "<string>",
"auth_type": "<string>",
"clinical_notes": "<string>",
"consent": {
"answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"questionnaire_url": "<string>"
},
"diagnosis": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"items": [
{
"claim_amount": 123,
"procedure_code": "<string>",
"procedure_name": "<string>",
"quantity": 123,
"questionnaire_answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"speciality_code": "<string>",
"speciality_name": "<string>",
"strat_code": "<string>",
"strat_display": "<string>",
"supporting_docs": [
{
"content": "<string>",
"content_type": "<string>",
"creation": "<string>",
"doc_id": "<string>",
"mand_code": "<string>",
"title": "<string>",
"url": "<string>"
}
]
}
],
"planned_end_date": "2023-11-07T05:31:56Z",
"planned_start_date": "2023-11-07T05:31:56Z",
"user_token": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
request_type: '<string>',
auth_type: '<string>',
clinical_notes: '<string>',
consent: {
answers: [
{
answer: '<unknown>',
link_id: '<string>',
question: '<string>',
questionnaire_url: '<string>'
}
],
questionnaire_url: '<string>'
},
diagnosis: [{code: '<string>', display: '<string>', system: '<string>'}],
items: [
{
claim_amount: 123,
procedure_code: '<string>',
procedure_name: '<string>',
quantity: 123,
questionnaire_answers: [
{
answer: '<unknown>',
link_id: '<string>',
question: '<string>',
questionnaire_url: '<string>'
}
],
speciality_code: '<string>',
speciality_name: '<string>',
strat_code: '<string>',
strat_display: '<string>',
supporting_docs: [
{
content: '<string>',
content_type: '<string>',
creation: '<string>',
doc_id: '<string>',
mand_code: '<string>',
title: '<string>',
url: '<string>'
}
]
}
],
planned_end_date: '2023-11-07T05:31:56Z',
planned_start_date: '2023-11-07T05:31:56Z',
user_token: '<string>'
})
};
fetch('https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"request_type\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"clinical_notes\": \"<string>\",\n \"consent\": {\n \"answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"questionnaire_url\": \"<string>\"\n },\n \"diagnosis\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"claim_amount\": 123,\n \"procedure_code\": \"<string>\",\n \"procedure_name\": \"<string>\",\n \"quantity\": 123,\n \"questionnaire_answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"speciality_code\": \"<string>\",\n \"speciality_name\": \"<string>\",\n \"strat_code\": \"<string>\",\n \"strat_display\": \"<string>\",\n \"supporting_docs\": [\n {\n \"content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\",\n \"mand_code\": \"<string>\",\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"planned_end_date\": \"2023-11-07T05:31:56Z\",\n \"planned_start_date\": \"2023-11-07T05:31:56Z\",\n \"user_token\": \"<string>\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"request_type\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"clinical_notes\": \"<string>\",\n \"consent\": {\n \"answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"questionnaire_url\": \"<string>\"\n },\n \"diagnosis\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"claim_amount\": 123,\n \"procedure_code\": \"<string>\",\n \"procedure_name\": \"<string>\",\n \"quantity\": 123,\n \"questionnaire_answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"speciality_code\": \"<string>\",\n \"speciality_name\": \"<string>\",\n \"strat_code\": \"<string>\",\n \"strat_display\": \"<string>\",\n \"supporting_docs\": [\n {\n \"content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\",\n \"mand_code\": \"<string>\",\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"planned_end_date\": \"2023-11-07T05:31:56Z\",\n \"planned_start_date\": \"2023-11-07T05:31:56Z\",\n \"user_token\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request_type\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"clinical_notes\": \"<string>\",\n \"consent\": {\n \"answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"questionnaire_url\": \"<string>\"\n },\n \"diagnosis\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"claim_amount\": 123,\n \"procedure_code\": \"<string>\",\n \"procedure_name\": \"<string>\",\n \"quantity\": 123,\n \"questionnaire_answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"speciality_code\": \"<string>\",\n \"speciality_name\": \"<string>\",\n \"strat_code\": \"<string>\",\n \"strat_display\": \"<string>\",\n \"supporting_docs\": [\n {\n \"content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\",\n \"mand_code\": \"<string>\",\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"planned_end_date\": \"2023-11-07T05:31:56Z\",\n \"planned_start_date\": \"2023-11-07T05:31:56Z\",\n \"user_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"estimated_response_time": "<string>",
"message": "<string>",
"request_id": "<string>",
"status": "<string>",
"workflow_id": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}Pre-auth
Submit Pre-auth
Submits a pre-auth for the claim. request_type picks the workflow: InitialRequest, QueryResponse to answer a payer query, FollowUp to resubmit a rejected pre-auth, Enhancement to raise the approved scope. Everything the claim already knows (payer, policy, facility, patient) is filled in for you. The payer answers asynchronously: a 2xx means the request was sent, not approved. Track it with the returned request_id on Get Claim Request.
POST
/
abdm
/
nhcx
/
v1
/
claims
/
{claimId}
/
preauth
Submit Pre-auth
curl --request POST \
--url https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_type": "<string>",
"auth_type": "<string>",
"clinical_notes": "<string>",
"consent": {
"answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"questionnaire_url": "<string>"
},
"diagnosis": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"items": [
{
"claim_amount": 123,
"procedure_code": "<string>",
"procedure_name": "<string>",
"quantity": 123,
"questionnaire_answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"speciality_code": "<string>",
"speciality_name": "<string>",
"strat_code": "<string>",
"strat_display": "<string>",
"supporting_docs": [
{
"content": "<string>",
"content_type": "<string>",
"creation": "<string>",
"doc_id": "<string>",
"mand_code": "<string>",
"title": "<string>",
"url": "<string>"
}
]
}
],
"planned_end_date": "2023-11-07T05:31:56Z",
"planned_start_date": "2023-11-07T05:31:56Z",
"user_token": "<string>"
}
'import requests
url = "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth"
payload = {
"request_type": "<string>",
"auth_type": "<string>",
"clinical_notes": "<string>",
"consent": {
"answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"questionnaire_url": "<string>"
},
"diagnosis": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"items": [
{
"claim_amount": 123,
"procedure_code": "<string>",
"procedure_name": "<string>",
"quantity": 123,
"questionnaire_answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"speciality_code": "<string>",
"speciality_name": "<string>",
"strat_code": "<string>",
"strat_display": "<string>",
"supporting_docs": [
{
"content": "<string>",
"content_type": "<string>",
"creation": "<string>",
"doc_id": "<string>",
"mand_code": "<string>",
"title": "<string>",
"url": "<string>"
}
]
}
],
"planned_end_date": "2023-11-07T05:31:56Z",
"planned_start_date": "2023-11-07T05:31:56Z",
"user_token": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
request_type: '<string>',
auth_type: '<string>',
clinical_notes: '<string>',
consent: {
answers: [
{
answer: '<unknown>',
link_id: '<string>',
question: '<string>',
questionnaire_url: '<string>'
}
],
questionnaire_url: '<string>'
},
diagnosis: [{code: '<string>', display: '<string>', system: '<string>'}],
items: [
{
claim_amount: 123,
procedure_code: '<string>',
procedure_name: '<string>',
quantity: 123,
questionnaire_answers: [
{
answer: '<unknown>',
link_id: '<string>',
question: '<string>',
questionnaire_url: '<string>'
}
],
speciality_code: '<string>',
speciality_name: '<string>',
strat_code: '<string>',
strat_display: '<string>',
supporting_docs: [
{
content: '<string>',
content_type: '<string>',
creation: '<string>',
doc_id: '<string>',
mand_code: '<string>',
title: '<string>',
url: '<string>'
}
]
}
],
planned_end_date: '2023-11-07T05:31:56Z',
planned_start_date: '2023-11-07T05:31:56Z',
user_token: '<string>'
})
};
fetch('https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"request_type\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"clinical_notes\": \"<string>\",\n \"consent\": {\n \"answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"questionnaire_url\": \"<string>\"\n },\n \"diagnosis\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"claim_amount\": 123,\n \"procedure_code\": \"<string>\",\n \"procedure_name\": \"<string>\",\n \"quantity\": 123,\n \"questionnaire_answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"speciality_code\": \"<string>\",\n \"speciality_name\": \"<string>\",\n \"strat_code\": \"<string>\",\n \"strat_display\": \"<string>\",\n \"supporting_docs\": [\n {\n \"content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\",\n \"mand_code\": \"<string>\",\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"planned_end_date\": \"2023-11-07T05:31:56Z\",\n \"planned_start_date\": \"2023-11-07T05:31:56Z\",\n \"user_token\": \"<string>\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"request_type\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"clinical_notes\": \"<string>\",\n \"consent\": {\n \"answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"questionnaire_url\": \"<string>\"\n },\n \"diagnosis\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"claim_amount\": 123,\n \"procedure_code\": \"<string>\",\n \"procedure_name\": \"<string>\",\n \"quantity\": 123,\n \"questionnaire_answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"speciality_code\": \"<string>\",\n \"speciality_name\": \"<string>\",\n \"strat_code\": \"<string>\",\n \"strat_display\": \"<string>\",\n \"supporting_docs\": [\n {\n \"content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\",\n \"mand_code\": \"<string>\",\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"planned_end_date\": \"2023-11-07T05:31:56Z\",\n \"planned_start_date\": \"2023-11-07T05:31:56Z\",\n \"user_token\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/preauth")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request_type\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"clinical_notes\": \"<string>\",\n \"consent\": {\n \"answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"questionnaire_url\": \"<string>\"\n },\n \"diagnosis\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"items\": [\n {\n \"claim_amount\": 123,\n \"procedure_code\": \"<string>\",\n \"procedure_name\": \"<string>\",\n \"quantity\": 123,\n \"questionnaire_answers\": [\n {\n \"answer\": \"<unknown>\",\n \"link_id\": \"<string>\",\n \"question\": \"<string>\",\n \"questionnaire_url\": \"<string>\"\n }\n ],\n \"speciality_code\": \"<string>\",\n \"speciality_name\": \"<string>\",\n \"strat_code\": \"<string>\",\n \"strat_display\": \"<string>\",\n \"supporting_docs\": [\n {\n \"content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\",\n \"mand_code\": \"<string>\",\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"planned_end_date\": \"2023-11-07T05:31:56Z\",\n \"planned_start_date\": \"2023-11-07T05:31:56Z\",\n \"user_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"estimated_response_time": "<string>",
"message": "<string>",
"request_id": "<string>",
"status": "<string>",
"workflow_id": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}Authorizations
Headers
Body
application/json
Carries the client-supplied deltas per procedure line: speciality code, procedure code, claim amount, optional stratification code, supporting docs, and questionnaire answers. Names/costs/mandatory-docs are enriched server-side from the case's catalog (catalog_md5).
Show child attributes
Show child attributes
Was this page helpful?

