Skip to main content
POST
/
v1
/
au
/
medicare
/
claims
Create a Medicare claim
curl --request POST \
  --url https://api.halth.com/v1/au/medicare/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "locationId": "prlo_39SaCy77MShwXBMzwFVSMHOtXdq",
  "type": "patient",
  "paymentStatus": "full_paid",
  "submit": true,
  "serviceProvider": {
    "providerNumber": "2447391F"
  },
  "patient": {
    "medicareCardId": "mccd_39SaCy77MShwXBMzwFVSMHOtXdq"
  },
  "items": [
    {
      "itemCode": "903",
      "chargeAmount": 25000,
      "serviceDate": "2026-01-01",
      "quantity": 1,
      "serviceTime": "10:00:00.0+10:00",
      "duration": 30,
      "notes": "<string>",
      "patientCount": 1,
      "overrides": {
        "overrideMultipleProcedureRule": true,
        "overrideDuplicateServiceRule": true,
        "overrideAftercareRule": true,
        "overrideRestrictionCode": "SP",
        "referralSelfDeemedCode": "SD"
      },
      "site": {
        "locationSpecificPracticeNumber": "12345",
        "isHospital": true,
        "facilityId": "731247FT",
        "specimenCollectionPointId": "1234"
      }
    }
  ],
  "reference": "INV000001",
  "paymentAmount": 25000,
  "transactionId": "btrn_39Q57MwxjLyx7PBXZObTpY4JQr6",
  "overrides": {
    "referralOverrideCode": "E"
  },
  "metadata": {}
}
'
{
  "items": [
    {
      "id": "<string>",
      "status": "created",
      "locationId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "type": "patient",
      "totalChargeAmount": 123,
      "totalRebateAmount": 123,
      "totalGapAmount": 123,
      "itemsCount": 123,
      "mcolTransactionId": "<string>",
      "items": [
        {
          "id": "<string>",
          "itemCode": "<string>",
          "chargeAmount": 123,
          "rebateAmount": 123,
          "gapAmount": 123,
          "mcolAssessmentCode": "<string>",
          "mcolErrorCode": "<string>",
          "mcolErrorMessage": "<string>",
          "patientCount": 123,
          "quantity": 123
        }
      ],
      "paymentStatus": "full_paid",
      "reference": "<string>",
      "patientMedicareCardId": "<string>",
      "claimantMedicareCardId": "<string>",
      "mcolClaimId": "<string>",
      "mcolErrorCode": "<string>",
      "mcolErrorMessage": "<string>",
      "transactionId": "<string>",
      "referral": {
        "providerNumber": "<string>",
        "issuedAt": "<string>",
        "periodCode": "<string>",
        "typeCode": "<string>"
      },
      "referralOverrideCode": "E"
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Documentation Index

Fetch the complete documentation index at: https://docs.halth.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Provide your API key as a Bearer token

Body

application/json
​
locationId
string
required

Location ID

Example:

"prlo_39SaCy77MShwXBMzwFVSMHOtXdq"

​
type
enum<string>
required

Type of claim

Available options:
patient,
bulk_bill
Example:

"patient"

​
paymentStatus
enum<string>
required

Payment status

Available options:
full_paid,
part_paid,
not_paid
Example:

"full_paid"

​
submit
boolean
required

Whether to submit the claim to Medicare Online immediately or store for later submission

Example:

true

​
serviceProvider
object
required
​
patient
object
required
​
items
object[]
required
Required array length: 1 - 16 elements
​
claimant
object

Optional override for the claimant if different from the patient.

​
reference
string

Reference number to identify the claim in the system

Required string length: 1 - 9
Example:

"INV000001"

​
paymentAmount
number

Total amount that has already been paid

Required range: 50 <= x <= 9999999
Example:

25000

​
transactionId
string

Transaction ID

Maximum string length: 255
Example:

"btrn_39Q57MwxjLyx7PBXZObTpY4JQr6"

​
payeeProvider
object
​
referral
object
​
overrides
object
​
metadata
object

Response

​
items
object[]
​
page
number
Example:

1

​
limit
number
Example:

10

​
totalItems
number
Example:

100

​
totalPages
number
Example:

10