Submit a batch of coded cases for DRG classification

curl --request POST \
  --url https://api.v2.healthproximate.com/api/v1/drg/batch/ \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "cases": [
    {
      "case_ref": "<string>",
      "dx_codes": [
        "<string>"
      ],
      "pr_codes": [],
      "gender": "F",
      "is_alive": true
    }
  ],
  "source_dialect": "icd10cm",
  "version": "v40"
}
'

import requests

url = "https://api.v2.healthproximate.com/api/v1/drg/batch/"

payload = {
    "cases": [
        {
            "case_ref": "<string>",
            "dx_codes": ["<string>"],
            "pr_codes": [],
            "gender": "F",
            "is_alive": True
        }
    ],
    "source_dialect": "icd10cm",
    "version": "v40"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cases: [
      {
        case_ref: '<string>',
        dx_codes: ['<string>'],
        pr_codes: [],
        gender: 'F',
        is_alive: true
      }
    ],
    source_dialect: 'icd10cm',
    version: 'v40'
  })
};

fetch('https://api.v2.healthproximate.com/api/v1/drg/batch/', 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.v2.healthproximate.com/api/v1/drg/batch/",
  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([
    'cases' => [
        [
                'case_ref' => '<string>',
                'dx_codes' => [
                                '<string>'
                ],
                'pr_codes' => [
                                
                ],
                'gender' => 'F',
                'is_alive' => true
        ]
    ],
    'source_dialect' => 'icd10cm',
    'version' => 'v40'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-API-Key: <api-key>"
  ],
]);

$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.v2.healthproximate.com/api/v1/drg/batch/"

	payload := strings.NewReader("{\n  \"cases\": [\n    {\n      \"case_ref\": \"<string>\",\n      \"dx_codes\": [\n        \"<string>\"\n      ],\n      \"pr_codes\": [],\n      \"gender\": \"F\",\n      \"is_alive\": true\n    }\n  ],\n  \"source_dialect\": \"icd10cm\",\n  \"version\": \"v40\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	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.v2.healthproximate.com/api/v1/drg/batch/")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cases\": [\n    {\n      \"case_ref\": \"<string>\",\n      \"dx_codes\": [\n        \"<string>\"\n      ],\n      \"pr_codes\": [],\n      \"gender\": \"F\",\n      \"is_alive\": true\n    }\n  ],\n  \"source_dialect\": \"icd10cm\",\n  \"version\": \"v40\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.v2.healthproximate.com/api/v1/drg/batch/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cases\": [\n    {\n      \"case_ref\": \"<string>\",\n      \"dx_codes\": [\n        \"<string>\"\n      ],\n      \"pr_codes\": [],\n      \"gender\": \"F\",\n      \"is_alive\": true\n    }\n  ],\n  \"source_dialect\": \"icd10cm\",\n  \"version\": \"v40\"\n}"

response = http.request(request)
puts response.read_body

DRG

Submit a batch of coded cases for DRG classification

Submit up to 1000 cases in one call; classification runs asynchronously. Returns a job id immediately — poll GET /api/v1/drg/batch/{job_id}/ for status and progressive per-case results.

Idempotency-Key header is required. Retrying a submission with the same key returns the same job (HTTP 200 instead of 201) and never re-processes or re-bills — safe to retry on any network failure.

Each case: case_ref (your identifier, unique within the batch), dx_codes (ICD-10-CM, primary first), optional pr_codes (ICD-10-PCS), gender, is_alive. source_dialect currently accepts icd10cm only — WHO ICD-10 / ICD-11 batches are refused up front rather than mis-grouped.

Billing: one ledger row per case (service_type="drg_batch"), written exactly once even across worker retries. A spend-capped organization’s submission is refused at enqueue with a 429 and costs nothing.

POST

api

drg

batch

Submit a batch of coded cases for DRG classification

curl --request POST \
  --url https://api.v2.healthproximate.com/api/v1/drg/batch/ \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "cases": [
    {
      "case_ref": "<string>",
      "dx_codes": [
        "<string>"
      ],
      "pr_codes": [],
      "gender": "F",
      "is_alive": true
    }
  ],
  "source_dialect": "icd10cm",
  "version": "v40"
}
'

import requests

url = "https://api.v2.healthproximate.com/api/v1/drg/batch/"

payload = {
    "cases": [
        {
            "case_ref": "<string>",
            "dx_codes": ["<string>"],
            "pr_codes": [],
            "gender": "F",
            "is_alive": True
        }
    ],
    "source_dialect": "icd10cm",
    "version": "v40"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cases: [
      {
        case_ref: '<string>',
        dx_codes: ['<string>'],
        pr_codes: [],
        gender: 'F',
        is_alive: true
      }
    ],
    source_dialect: 'icd10cm',
    version: 'v40'
  })
};

fetch('https://api.v2.healthproximate.com/api/v1/drg/batch/', 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.v2.healthproximate.com/api/v1/drg/batch/",
  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([
    'cases' => [
        [
                'case_ref' => '<string>',
                'dx_codes' => [
                                '<string>'
                ],
                'pr_codes' => [
                                
                ],
                'gender' => 'F',
                'is_alive' => true
        ]
    ],
    'source_dialect' => 'icd10cm',
    'version' => 'v40'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-API-Key: <api-key>"
  ],
]);

$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.v2.healthproximate.com/api/v1/drg/batch/"

	payload := strings.NewReader("{\n  \"cases\": [\n    {\n      \"case_ref\": \"<string>\",\n      \"dx_codes\": [\n        \"<string>\"\n      ],\n      \"pr_codes\": [],\n      \"gender\": \"F\",\n      \"is_alive\": true\n    }\n  ],\n  \"source_dialect\": \"icd10cm\",\n  \"version\": \"v40\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	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.v2.healthproximate.com/api/v1/drg/batch/")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cases\": [\n    {\n      \"case_ref\": \"<string>\",\n      \"dx_codes\": [\n        \"<string>\"\n      ],\n      \"pr_codes\": [],\n      \"gender\": \"F\",\n      \"is_alive\": true\n    }\n  ],\n  \"source_dialect\": \"icd10cm\",\n  \"version\": \"v40\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.v2.healthproximate.com/api/v1/drg/batch/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cases\": [\n    {\n      \"case_ref\": \"<string>\",\n      \"dx_codes\": [\n        \"<string>\"\n      ],\n      \"pr_codes\": [],\n      \"gender\": \"F\",\n      \"is_alive\": true\n    }\n  ],\n  \"source_dialect\": \"icd10cm\",\n  \"version\": \"v40\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

X-API-Key

string

header

required

API key for organization authentication. Obtain from the organization settings or API key management endpoint.

Headers

Idempotency-Key

string

required

Caller-chosen key (8-128 chars) making the submission retry-safe.

Body

Request serializer for the async batch classification endpoint.

cases

object[]

required

Up to 1000 cases per submission.

Required array length: 1 - 1000 elements

Show child attributes

source_dialect

enum<string>

default:icd10cm

Code dialect of the submitted cases. Only icd10cm is accepted today; WHO ICD-10 / ICD-11 batches are refused up front rather than mis-grouped.

icd10cm - icd10cm

Available options:

icd10cm

version

enum<string>

default:v40

MS-DRG version (default: v40, FY 2023)

v36 - v36
v37 - v37
v38 - v38
v39 - v39
v40 - v40
v43 - v43

Available options:

v36,

v37,

v38,

v39,

v40,

v43

Response

Idempotent replay — existing job returned

Get started

Gateway

Clinical coding

DRG

Submit a batch of coded cases for DRG classification

Authorizations

Headers

Body

Response