Preview Claim Bundle
curl --request POST \
--url https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"admission_date": "2023-11-07T05:31:56Z",
"auth_type": "<string>",
"care_team_members": [
{
"name": "<string>",
"hpr_id": "<string>",
"mobile": "<string>",
"qualification_code": "<string>",
"qualification_display": "<string>",
"registration_id": "<string>"
}
],
"consent": {
"answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"questionnaire_url": "<string>"
},
"diagnosis": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"discharge_date": "2023-11-07T05:31:56Z",
"discharge_stage": "<string>",
"discharge_type": "<string>",
"itemized_billing": [
{
"service_code": "<string>",
"care_team_sequence": [
123
],
"category": {
"coding": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"text": "<string>"
},
"cycle_dates": [
"<string>"
],
"description": "<string>",
"diagnosis_pointer": [
123
],
"information_sequence": [
123
],
"procedure_code": "<string>",
"procedure_sequence": [
123
],
"quantity": 123,
"service_date": "2023-11-07T05:31:56Z",
"serviced_period_end": "<string>",
"serviced_period_start": "<string>",
"total_amount": 123,
"unit_price": 123
}
],
"remarks": "<string>",
"request_type": "<string>",
"supporting_docs": [
{
"category": "<string>",
"code": "<string>",
"content_type": "<string>",
"title": "<string>",
"category_display": "<string>",
"code_display": "<string>",
"content": "<string>",
"creation": "<string>",
"doc_id": "<string>"
}
],
"user_token": "<string>"
}
'import requests
url = "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview"
payload = {
"admission_date": "2023-11-07T05:31:56Z",
"auth_type": "<string>",
"care_team_members": [
{
"name": "<string>",
"hpr_id": "<string>",
"mobile": "<string>",
"qualification_code": "<string>",
"qualification_display": "<string>",
"registration_id": "<string>"
}
],
"consent": {
"answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"questionnaire_url": "<string>"
},
"diagnosis": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"discharge_date": "2023-11-07T05:31:56Z",
"discharge_stage": "<string>",
"discharge_type": "<string>",
"itemized_billing": [
{
"service_code": "<string>",
"care_team_sequence": [123],
"category": {
"coding": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"text": "<string>"
},
"cycle_dates": ["<string>"],
"description": "<string>",
"diagnosis_pointer": [123],
"information_sequence": [123],
"procedure_code": "<string>",
"procedure_sequence": [123],
"quantity": 123,
"service_date": "2023-11-07T05:31:56Z",
"serviced_period_end": "<string>",
"serviced_period_start": "<string>",
"total_amount": 123,
"unit_price": 123
}
],
"remarks": "<string>",
"request_type": "<string>",
"supporting_docs": [
{
"category": "<string>",
"code": "<string>",
"content_type": "<string>",
"title": "<string>",
"category_display": "<string>",
"code_display": "<string>",
"content": "<string>",
"creation": "<string>",
"doc_id": "<string>"
}
],
"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({
admission_date: '2023-11-07T05:31:56Z',
auth_type: '<string>',
care_team_members: [
{
name: '<string>',
hpr_id: '<string>',
mobile: '<string>',
qualification_code: '<string>',
qualification_display: '<string>',
registration_id: '<string>'
}
],
consent: {
answers: [
{
answer: '<unknown>',
link_id: '<string>',
question: '<string>',
questionnaire_url: '<string>'
}
],
questionnaire_url: '<string>'
},
diagnosis: [{code: '<string>', display: '<string>', system: '<string>'}],
discharge_date: '2023-11-07T05:31:56Z',
discharge_stage: '<string>',
discharge_type: '<string>',
itemized_billing: [
{
service_code: '<string>',
care_team_sequence: [123],
category: {
coding: [{code: '<string>', display: '<string>', system: '<string>'}],
text: '<string>'
},
cycle_dates: ['<string>'],
description: '<string>',
diagnosis_pointer: [123],
information_sequence: [123],
procedure_code: '<string>',
procedure_sequence: [123],
quantity: 123,
service_date: '2023-11-07T05:31:56Z',
serviced_period_end: '<string>',
serviced_period_start: '<string>',
total_amount: 123,
unit_price: 123
}
],
remarks: '<string>',
request_type: '<string>',
supporting_docs: [
{
category: '<string>',
code: '<string>',
content_type: '<string>',
title: '<string>',
category_display: '<string>',
code_display: '<string>',
content: '<string>',
creation: '<string>',
doc_id: '<string>'
}
],
user_token: '<string>'
})
};
fetch('https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'admission_date' => '2023-11-07T05:31:56Z',
'auth_type' => '<string>',
'care_team_members' => [
[
'name' => '<string>',
'hpr_id' => '<string>',
'mobile' => '<string>',
'qualification_code' => '<string>',
'qualification_display' => '<string>',
'registration_id' => '<string>'
]
],
'consent' => [
'answers' => [
[
'answer' => '<unknown>',
'link_id' => '<string>',
'question' => '<string>',
'questionnaire_url' => '<string>'
]
],
'questionnaire_url' => '<string>'
],
'diagnosis' => [
[
'code' => '<string>',
'display' => '<string>',
'system' => '<string>'
]
],
'discharge_date' => '2023-11-07T05:31:56Z',
'discharge_stage' => '<string>',
'discharge_type' => '<string>',
'itemized_billing' => [
[
'service_code' => '<string>',
'care_team_sequence' => [
123
],
'category' => [
'coding' => [
[
'code' => '<string>',
'display' => '<string>',
'system' => '<string>'
]
],
'text' => '<string>'
],
'cycle_dates' => [
'<string>'
],
'description' => '<string>',
'diagnosis_pointer' => [
123
],
'information_sequence' => [
123
],
'procedure_code' => '<string>',
'procedure_sequence' => [
123
],
'quantity' => 123,
'service_date' => '2023-11-07T05:31:56Z',
'serviced_period_end' => '<string>',
'serviced_period_start' => '<string>',
'total_amount' => 123,
'unit_price' => 123
]
],
'remarks' => '<string>',
'request_type' => '<string>',
'supporting_docs' => [
[
'category' => '<string>',
'code' => '<string>',
'content_type' => '<string>',
'title' => '<string>',
'category_display' => '<string>',
'code_display' => '<string>',
'content' => '<string>',
'creation' => '<string>',
'doc_id' => '<string>'
]
],
'user_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview"
payload := strings.NewReader("{\n \"admission_date\": \"2023-11-07T05:31:56Z\",\n \"auth_type\": \"<string>\",\n \"care_team_members\": [\n {\n \"name\": \"<string>\",\n \"hpr_id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"qualification_code\": \"<string>\",\n \"qualification_display\": \"<string>\",\n \"registration_id\": \"<string>\"\n }\n ],\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 \"discharge_date\": \"2023-11-07T05:31:56Z\",\n \"discharge_stage\": \"<string>\",\n \"discharge_type\": \"<string>\",\n \"itemized_billing\": [\n {\n \"service_code\": \"<string>\",\n \"care_team_sequence\": [\n 123\n ],\n \"category\": {\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"text\": \"<string>\"\n },\n \"cycle_dates\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"diagnosis_pointer\": [\n 123\n ],\n \"information_sequence\": [\n 123\n ],\n \"procedure_code\": \"<string>\",\n \"procedure_sequence\": [\n 123\n ],\n \"quantity\": 123,\n \"service_date\": \"2023-11-07T05:31:56Z\",\n \"serviced_period_end\": \"<string>\",\n \"serviced_period_start\": \"<string>\",\n \"total_amount\": 123,\n \"unit_price\": 123\n }\n ],\n \"remarks\": \"<string>\",\n \"request_type\": \"<string>\",\n \"supporting_docs\": [\n {\n \"category\": \"<string>\",\n \"code\": \"<string>\",\n \"content_type\": \"<string>\",\n \"title\": \"<string>\",\n \"category_display\": \"<string>\",\n \"code_display\": \"<string>\",\n \"content\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\"\n }\n ],\n \"user_token\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"admission_date\": \"2023-11-07T05:31:56Z\",\n \"auth_type\": \"<string>\",\n \"care_team_members\": [\n {\n \"name\": \"<string>\",\n \"hpr_id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"qualification_code\": \"<string>\",\n \"qualification_display\": \"<string>\",\n \"registration_id\": \"<string>\"\n }\n ],\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 \"discharge_date\": \"2023-11-07T05:31:56Z\",\n \"discharge_stage\": \"<string>\",\n \"discharge_type\": \"<string>\",\n \"itemized_billing\": [\n {\n \"service_code\": \"<string>\",\n \"care_team_sequence\": [\n 123\n ],\n \"category\": {\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"text\": \"<string>\"\n },\n \"cycle_dates\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"diagnosis_pointer\": [\n 123\n ],\n \"information_sequence\": [\n 123\n ],\n \"procedure_code\": \"<string>\",\n \"procedure_sequence\": [\n 123\n ],\n \"quantity\": 123,\n \"service_date\": \"2023-11-07T05:31:56Z\",\n \"serviced_period_end\": \"<string>\",\n \"serviced_period_start\": \"<string>\",\n \"total_amount\": 123,\n \"unit_price\": 123\n }\n ],\n \"remarks\": \"<string>\",\n \"request_type\": \"<string>\",\n \"supporting_docs\": [\n {\n \"category\": \"<string>\",\n \"code\": \"<string>\",\n \"content_type\": \"<string>\",\n \"title\": \"<string>\",\n \"category_display\": \"<string>\",\n \"code_display\": \"<string>\",\n \"content\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\"\n }\n ],\n \"user_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview")
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 \"admission_date\": \"2023-11-07T05:31:56Z\",\n \"auth_type\": \"<string>\",\n \"care_team_members\": [\n {\n \"name\": \"<string>\",\n \"hpr_id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"qualification_code\": \"<string>\",\n \"qualification_display\": \"<string>\",\n \"registration_id\": \"<string>\"\n }\n ],\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 \"discharge_date\": \"2023-11-07T05:31:56Z\",\n \"discharge_stage\": \"<string>\",\n \"discharge_type\": \"<string>\",\n \"itemized_billing\": [\n {\n \"service_code\": \"<string>\",\n \"care_team_sequence\": [\n 123\n ],\n \"category\": {\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"text\": \"<string>\"\n },\n \"cycle_dates\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"diagnosis_pointer\": [\n 123\n ],\n \"information_sequence\": [\n 123\n ],\n \"procedure_code\": \"<string>\",\n \"procedure_sequence\": [\n 123\n ],\n \"quantity\": 123,\n \"service_date\": \"2023-11-07T05:31:56Z\",\n \"serviced_period_end\": \"<string>\",\n \"serviced_period_start\": \"<string>\",\n \"total_amount\": 123,\n \"unit_price\": 123\n }\n ],\n \"remarks\": \"<string>\",\n \"request_type\": \"<string>\",\n \"supporting_docs\": [\n {\n \"category\": \"<string>\",\n \"code\": \"<string>\",\n \"content_type\": \"<string>\",\n \"title\": \"<string>\",\n \"category_display\": \"<string>\",\n \"code_display\": \"<string>\",\n \"content\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\"\n }\n ],\n \"user_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}Claim Submission
Preview Claim Bundle
Takes the same body as Submit Claim and returns the exact FHIR bundle it would send. Nothing is sent or stored.
POST
/
abdm
/
nhcx
/
v1
/
claims
/
{claimId}
/
claim
/
preview
Preview Claim Bundle
curl --request POST \
--url https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"admission_date": "2023-11-07T05:31:56Z",
"auth_type": "<string>",
"care_team_members": [
{
"name": "<string>",
"hpr_id": "<string>",
"mobile": "<string>",
"qualification_code": "<string>",
"qualification_display": "<string>",
"registration_id": "<string>"
}
],
"consent": {
"answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"questionnaire_url": "<string>"
},
"diagnosis": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"discharge_date": "2023-11-07T05:31:56Z",
"discharge_stage": "<string>",
"discharge_type": "<string>",
"itemized_billing": [
{
"service_code": "<string>",
"care_team_sequence": [
123
],
"category": {
"coding": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"text": "<string>"
},
"cycle_dates": [
"<string>"
],
"description": "<string>",
"diagnosis_pointer": [
123
],
"information_sequence": [
123
],
"procedure_code": "<string>",
"procedure_sequence": [
123
],
"quantity": 123,
"service_date": "2023-11-07T05:31:56Z",
"serviced_period_end": "<string>",
"serviced_period_start": "<string>",
"total_amount": 123,
"unit_price": 123
}
],
"remarks": "<string>",
"request_type": "<string>",
"supporting_docs": [
{
"category": "<string>",
"code": "<string>",
"content_type": "<string>",
"title": "<string>",
"category_display": "<string>",
"code_display": "<string>",
"content": "<string>",
"creation": "<string>",
"doc_id": "<string>"
}
],
"user_token": "<string>"
}
'import requests
url = "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview"
payload = {
"admission_date": "2023-11-07T05:31:56Z",
"auth_type": "<string>",
"care_team_members": [
{
"name": "<string>",
"hpr_id": "<string>",
"mobile": "<string>",
"qualification_code": "<string>",
"qualification_display": "<string>",
"registration_id": "<string>"
}
],
"consent": {
"answers": [
{
"answer": "<unknown>",
"link_id": "<string>",
"question": "<string>",
"questionnaire_url": "<string>"
}
],
"questionnaire_url": "<string>"
},
"diagnosis": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"discharge_date": "2023-11-07T05:31:56Z",
"discharge_stage": "<string>",
"discharge_type": "<string>",
"itemized_billing": [
{
"service_code": "<string>",
"care_team_sequence": [123],
"category": {
"coding": [
{
"code": "<string>",
"display": "<string>",
"system": "<string>"
}
],
"text": "<string>"
},
"cycle_dates": ["<string>"],
"description": "<string>",
"diagnosis_pointer": [123],
"information_sequence": [123],
"procedure_code": "<string>",
"procedure_sequence": [123],
"quantity": 123,
"service_date": "2023-11-07T05:31:56Z",
"serviced_period_end": "<string>",
"serviced_period_start": "<string>",
"total_amount": 123,
"unit_price": 123
}
],
"remarks": "<string>",
"request_type": "<string>",
"supporting_docs": [
{
"category": "<string>",
"code": "<string>",
"content_type": "<string>",
"title": "<string>",
"category_display": "<string>",
"code_display": "<string>",
"content": "<string>",
"creation": "<string>",
"doc_id": "<string>"
}
],
"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({
admission_date: '2023-11-07T05:31:56Z',
auth_type: '<string>',
care_team_members: [
{
name: '<string>',
hpr_id: '<string>',
mobile: '<string>',
qualification_code: '<string>',
qualification_display: '<string>',
registration_id: '<string>'
}
],
consent: {
answers: [
{
answer: '<unknown>',
link_id: '<string>',
question: '<string>',
questionnaire_url: '<string>'
}
],
questionnaire_url: '<string>'
},
diagnosis: [{code: '<string>', display: '<string>', system: '<string>'}],
discharge_date: '2023-11-07T05:31:56Z',
discharge_stage: '<string>',
discharge_type: '<string>',
itemized_billing: [
{
service_code: '<string>',
care_team_sequence: [123],
category: {
coding: [{code: '<string>', display: '<string>', system: '<string>'}],
text: '<string>'
},
cycle_dates: ['<string>'],
description: '<string>',
diagnosis_pointer: [123],
information_sequence: [123],
procedure_code: '<string>',
procedure_sequence: [123],
quantity: 123,
service_date: '2023-11-07T05:31:56Z',
serviced_period_end: '<string>',
serviced_period_start: '<string>',
total_amount: 123,
unit_price: 123
}
],
remarks: '<string>',
request_type: '<string>',
supporting_docs: [
{
category: '<string>',
code: '<string>',
content_type: '<string>',
title: '<string>',
category_display: '<string>',
code_display: '<string>',
content: '<string>',
creation: '<string>',
doc_id: '<string>'
}
],
user_token: '<string>'
})
};
fetch('https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'admission_date' => '2023-11-07T05:31:56Z',
'auth_type' => '<string>',
'care_team_members' => [
[
'name' => '<string>',
'hpr_id' => '<string>',
'mobile' => '<string>',
'qualification_code' => '<string>',
'qualification_display' => '<string>',
'registration_id' => '<string>'
]
],
'consent' => [
'answers' => [
[
'answer' => '<unknown>',
'link_id' => '<string>',
'question' => '<string>',
'questionnaire_url' => '<string>'
]
],
'questionnaire_url' => '<string>'
],
'diagnosis' => [
[
'code' => '<string>',
'display' => '<string>',
'system' => '<string>'
]
],
'discharge_date' => '2023-11-07T05:31:56Z',
'discharge_stage' => '<string>',
'discharge_type' => '<string>',
'itemized_billing' => [
[
'service_code' => '<string>',
'care_team_sequence' => [
123
],
'category' => [
'coding' => [
[
'code' => '<string>',
'display' => '<string>',
'system' => '<string>'
]
],
'text' => '<string>'
],
'cycle_dates' => [
'<string>'
],
'description' => '<string>',
'diagnosis_pointer' => [
123
],
'information_sequence' => [
123
],
'procedure_code' => '<string>',
'procedure_sequence' => [
123
],
'quantity' => 123,
'service_date' => '2023-11-07T05:31:56Z',
'serviced_period_end' => '<string>',
'serviced_period_start' => '<string>',
'total_amount' => 123,
'unit_price' => 123
]
],
'remarks' => '<string>',
'request_type' => '<string>',
'supporting_docs' => [
[
'category' => '<string>',
'code' => '<string>',
'content_type' => '<string>',
'title' => '<string>',
'category_display' => '<string>',
'code_display' => '<string>',
'content' => '<string>',
'creation' => '<string>',
'doc_id' => '<string>'
]
],
'user_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview"
payload := strings.NewReader("{\n \"admission_date\": \"2023-11-07T05:31:56Z\",\n \"auth_type\": \"<string>\",\n \"care_team_members\": [\n {\n \"name\": \"<string>\",\n \"hpr_id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"qualification_code\": \"<string>\",\n \"qualification_display\": \"<string>\",\n \"registration_id\": \"<string>\"\n }\n ],\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 \"discharge_date\": \"2023-11-07T05:31:56Z\",\n \"discharge_stage\": \"<string>\",\n \"discharge_type\": \"<string>\",\n \"itemized_billing\": [\n {\n \"service_code\": \"<string>\",\n \"care_team_sequence\": [\n 123\n ],\n \"category\": {\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"text\": \"<string>\"\n },\n \"cycle_dates\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"diagnosis_pointer\": [\n 123\n ],\n \"information_sequence\": [\n 123\n ],\n \"procedure_code\": \"<string>\",\n \"procedure_sequence\": [\n 123\n ],\n \"quantity\": 123,\n \"service_date\": \"2023-11-07T05:31:56Z\",\n \"serviced_period_end\": \"<string>\",\n \"serviced_period_start\": \"<string>\",\n \"total_amount\": 123,\n \"unit_price\": 123\n }\n ],\n \"remarks\": \"<string>\",\n \"request_type\": \"<string>\",\n \"supporting_docs\": [\n {\n \"category\": \"<string>\",\n \"code\": \"<string>\",\n \"content_type\": \"<string>\",\n \"title\": \"<string>\",\n \"category_display\": \"<string>\",\n \"code_display\": \"<string>\",\n \"content\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\"\n }\n ],\n \"user_token\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"admission_date\": \"2023-11-07T05:31:56Z\",\n \"auth_type\": \"<string>\",\n \"care_team_members\": [\n {\n \"name\": \"<string>\",\n \"hpr_id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"qualification_code\": \"<string>\",\n \"qualification_display\": \"<string>\",\n \"registration_id\": \"<string>\"\n }\n ],\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 \"discharge_date\": \"2023-11-07T05:31:56Z\",\n \"discharge_stage\": \"<string>\",\n \"discharge_type\": \"<string>\",\n \"itemized_billing\": [\n {\n \"service_code\": \"<string>\",\n \"care_team_sequence\": [\n 123\n ],\n \"category\": {\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"text\": \"<string>\"\n },\n \"cycle_dates\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"diagnosis_pointer\": [\n 123\n ],\n \"information_sequence\": [\n 123\n ],\n \"procedure_code\": \"<string>\",\n \"procedure_sequence\": [\n 123\n ],\n \"quantity\": 123,\n \"service_date\": \"2023-11-07T05:31:56Z\",\n \"serviced_period_end\": \"<string>\",\n \"serviced_period_start\": \"<string>\",\n \"total_amount\": 123,\n \"unit_price\": 123\n }\n ],\n \"remarks\": \"<string>\",\n \"request_type\": \"<string>\",\n \"supporting_docs\": [\n {\n \"category\": \"<string>\",\n \"code\": \"<string>\",\n \"content_type\": \"<string>\",\n \"title\": \"<string>\",\n \"category_display\": \"<string>\",\n \"code_display\": \"<string>\",\n \"content\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\"\n }\n ],\n \"user_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eka.care/abdm/nhcx/v1/claims/{claimId}/claim/preview")
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 \"admission_date\": \"2023-11-07T05:31:56Z\",\n \"auth_type\": \"<string>\",\n \"care_team_members\": [\n {\n \"name\": \"<string>\",\n \"hpr_id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"qualification_code\": \"<string>\",\n \"qualification_display\": \"<string>\",\n \"registration_id\": \"<string>\"\n }\n ],\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 \"discharge_date\": \"2023-11-07T05:31:56Z\",\n \"discharge_stage\": \"<string>\",\n \"discharge_type\": \"<string>\",\n \"itemized_billing\": [\n {\n \"service_code\": \"<string>\",\n \"care_team_sequence\": [\n 123\n ],\n \"category\": {\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\"\n }\n ],\n \"text\": \"<string>\"\n },\n \"cycle_dates\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"diagnosis_pointer\": [\n 123\n ],\n \"information_sequence\": [\n 123\n ],\n \"procedure_code\": \"<string>\",\n \"procedure_sequence\": [\n 123\n ],\n \"quantity\": 123,\n \"service_date\": \"2023-11-07T05:31:56Z\",\n \"serviced_period_end\": \"<string>\",\n \"serviced_period_start\": \"<string>\",\n \"total_amount\": 123,\n \"unit_price\": 123\n }\n ],\n \"remarks\": \"<string>\",\n \"request_type\": \"<string>\",\n \"supporting_docs\": [\n {\n \"category\": \"<string>\",\n \"code\": \"<string>\",\n \"content_type\": \"<string>\",\n \"title\": \"<string>\",\n \"category_display\": \"<string>\",\n \"code_display\": \"<string>\",\n \"content\": \"<string>\",\n \"creation\": \"<string>\",\n \"doc_id\": \"<string>\"\n }\n ],\n \"user_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}{
"error": "<string>",
"issues": [
"<string>"
],
"updated_at": "<string>"
}Authorizations
The API requires a Bearer token (JWT) for authentication.
Headers
Eka User ID (OID)
Partner User ID
Partner HIP ID
Path Parameters
claim_id returned by Create Claim
Required range:
x >= 0Body
application/json
Optional: when supplied, each claim item's servicedPeriod spans admission..discharge (the full IPD stay). The case does not currently capture an admission date, so without this the item falls back to the discharge date alone as its serviced date.
NOT case-derivable — supplied by the caller (HMIS) per submission.
Show child attributes
Show child attributes
Beneficiary authentication. AuthType "consent" (default) sends the Authentication Consent Questionnaire response (Consent) and OMITS the biometric X-Token; "biometric" sends UserToken as the X-Token.
Show child attributes
Show child attributes
The discharge diagnosis — NOT case-derivable (may differ from the pre-auth diagnosis), supplied by the caller.
Show child attributes
Show child attributes
DIS valueString: "After surgery"(default) | ...
"home"(default) | "mortuary" | "lama" | "dama"
Carries the client-supplied deltas per line item: service_code, quantity, unit_price. Category/display are optionally enriched server-side from the case's catalog (catalog_md5); TotalAmount and the overall ClaimedAmount are always server-computed.
Show child attributes
Show child attributes
Free text; mandatory once the claim is submitted >15 days post-discharge. See validateClaimRequest's TAT-band check.
Selects the NHCX workflow for this claim submission, mirroring preauth: "" / "InitialRequest" → first/final claim submit (workflow 15) "QueryResponse" → answer a payer query on this claim (workflow 151) "Resubmission"/"FollowUp" → resubmit a rejected claim (workflow 16) A QueryResponse/Resubmission reuses the SAME Claim.identifier (the payer's CLN, stored on the claim as claim_ref) so the payer links it to the queried/rejected claim — the correlation id is fresh per exchange, linkage is CLN + workflow id (NHCX bundle-anatomy). Empty = initial.
Show child attributes
Show child attributes
Response
OK
Was this page helpful?