إنتقل إلى المحتوى الرئيسي

Price List

Manage price lists and price items for medical providers. Price lists define the agreed-upon pricing for medical services and are referenced during Prior Authorization processing for price validation and adjudication.

Base URL:

https://api.{client_namespace}.najeeb.ai/v4.0/health/price-list
Authentication

All endpoints require HTTPS and must include a valid access-key header. See Authentication for details.

Create Price List​

POST /create

Create a new price list for a medical provider. A price list defines the effective date range and can optionally include an initial set of price items. The provider is identified by their CCHI ID or ERP code.

Request Body​

FieldTypeRequiredConstraintsDescription
start_date *stringYesISO 8601 DateTimeStart date of the price list (e.g., 2026-01-01T00:00:00.000Z)
end_date *stringYesISO 8601 DateTimeEnd date of the price list (e.g., 2026-12-31T23:59:59.000Z)
provider_cchi_id *stringYes-Medical provider CCHI ID or ERP code
price_list_erp_id *stringYes-Unique ERP ID for the price list
price_items *object[]YesArray of price itemsList of price items to include (see Price Item fields below)

Price Item Fields​

FieldTypeRequiredConstraintsDescription
department *stringYesMax 100 charsDepartment name
provider_service_Code *stringYesMax 50 charsProvider service code
provider_service_description *stringYesMax 255 charsService description
provider_service_type *stringYesMax 50 charsService type
nphies_code *stringYesMax 50 charsNPHIES code
nphies_type *stringYesMax 50 charsNPHIES type
price *numberYes>= 0, 2 decimalsStandard price
price_item_erp_id *stringYesMax 255 charsUnique ERP ID for the price item
date_start *stringYesISO 8601 DateTimeItem effective start date
date_end *stringYesISO 8601 DateTimeItem effective end date
grossnumberNo>= 0, 2 decimalsGross amount
discountnumberNo>= 0, 2 decimalsDiscount amount
nphies_idstringNoMax 255 charsNPHIES ID
length_of_staystringNoMax 20 charsLength of stay
categorystringNoMax 20 charsCategory code

Request Example​

curl -X POST \
  "https://api.{client_namespace}.najeeb.ai/v4.0/health/price-list/create" \
  -H "access-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "start_date": "2026-01-01T00:00:00.000Z",
    "end_date": "2026-12-31T23:59:59.000Z",
    "provider_cchi_id": "1234567890",
    "price_list_erp_id": "PL-2026-001",
    "price_items": [
      {
        "department": "Cardiology",
        "provider_service_Code": "SRV-001",
        "provider_service_description": "Cardiac Consultation",
        "provider_service_type": "Consultation",
        "nphies_code": "NPH-001",
        "nphies_type": "Medical",
        "price": 350.00,
        "gross": 400.00,
        "discount": 50.00,
        "price_item_erp_id": "PI-001",
        "date_start": "2026-01-01T00:00:00.000Z",
        "date_end": "2026-12-31T23:59:59.000Z"
      }
    ]
  }'

Response​

201 Created​

Returns the created price list with its items.

{
  "id": 1,
  "start_date": "2026-01-01T00:00:00.000Z",
  "end_date": "2026-12-31T23:59:59.000Z",
  "price_list_erp_id": "PL-2026-001",
  "price_items": [
    {
      "id": 1,
      "department": "Cardiology",
      "provider_service_Code": "SRV-001",
      "provider_service_description": "Cardiac Consultation",
      "provider_service_type": "Consultation",
      "nphies_code": "NPH-001",
      "nphies_type": "Medical",
      "price": 350.00,
      "gross": 400.00,
      "discount": 50.00,
      "price_item_erp_id": "PI-001",
      "date_start": "2026-01-01T00:00:00.000Z",
      "date_end": "2026-12-31T23:59:59.000Z"
    }
  ]
}

Error Responses​

StatusDescription
400Bad Request - Invalid or missing fields in the request body
404Not Found - Medical provider with given CCHI ID not found

Create Price Items (Bulk)​

POST /items/create

Create price items in bulk for an existing price list. Use this endpoint to add new items to a price list that was previously created without items, or to append additional items.

Request Body​

FieldTypeRequiredConstraintsDescription
price_list_erp_id *stringYes-ERP ID of the target price list
price_items *object[]YesNon-empty arrayArray of price items to create

Each object in price_items uses the same fields as the Price Item Fields table above.

Request Example​

curl -X POST \
  "https://api.{client_namespace}.najeeb.ai/v4.0/health/price-list/items/create" \
  -H "access-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "price_list_erp_id": "PL-2026-001",
    "price_items": [
      {
        "department": "Radiology",
        "provider_service_Code": "SRV-100",
        "provider_service_description": "Chest X-Ray",
        "provider_service_type": "Diagnostic",
        "nphies_code": "NPH-100",
        "nphies_type": "Medical",
        "price": 150.00,
        "gross": 180.00,
        "discount": 30.00,
        "price_item_erp_id": "PI-100",
        "date_start": "2026-01-01T00:00:00.000Z",
        "date_end": "2026-12-31T23:59:59.000Z"
      },
      {
        "department": "Laboratory",
        "provider_service_Code": "SRV-200",
        "provider_service_description": "Complete Blood Count",
        "provider_service_type": "Lab Test",
        "nphies_code": "NPH-200",
        "nphies_type": "Medical",
        "price": 75.00,
        "price_item_erp_id": "PI-200",
        "date_start": "2026-01-01T00:00:00.000Z",
        "date_end": "2026-06-30T23:59:59.000Z"
      }
    ]
  }'

Response​

201 Created​

Returns the created price items.

{
  "price_list_erp_id": "PL-2026-001",
  "created_items": [
    {
      "id": 2,
      "department": "Radiology",
      "provider_service_Code": "SRV-100",
      "provider_service_description": "Chest X-Ray",
      "provider_service_type": "Diagnostic",
      "nphies_code": "NPH-100",
      "nphies_type": "Medical",
      "price": 150.00,
      "gross": 180.00,
      "discount": 30.00,
      "price_item_erp_id": "PI-100",
      "date_start": "2026-01-01T00:00:00.000Z",
      "date_end": "2026-12-31T23:59:59.000Z"
    },
    {
      "id": 3,
      "department": "Laboratory",
      "provider_service_Code": "SRV-200",
      "provider_service_description": "Complete Blood Count",
      "provider_service_type": "Lab Test",
      "nphies_code": "NPH-200",
      "nphies_type": "Medical",
      "price": 75.00,
      "price_item_erp_id": "PI-200",
      "date_start": "2026-01-01T00:00:00.000Z",
      "date_end": "2026-06-30T23:59:59.000Z"
    }
  ]
}

Error Responses​

StatusDescription
400Bad Request - Invalid or missing fields in the request body
404Not Found - Price list with given ERP ID not found

Update Price Item​

PATCH /item/update/:price_item_erp_id

Update an existing price item. Only the fields included in the request body will be updated. Use this to adjust pricing, gross amounts, discounts, or extend the end date of a price item.

Path Parameters​

ParameterTypeRequiredDescription
price_item_erp_id *stringYesERP ID of the price item to update

Request Body​

All fields are optional. Only include the fields you want to update.

FieldTypeRequiredConstraintsDescription
pricenumberNo>= 0, 2 decimalsUpdated standard price
grossnumberNo>= 0, 2 decimalsUpdated gross amount
discountnumberNo>= 0, 2 decimalsUpdated discount amount
end_datestringNoISO 8601 DateTimeUpdated end date (e.g., 2026-12-31T23:59:59.000Z)

Request Example​

curl -X PATCH \
  "https://api.{client_namespace}.najeeb.ai/v4.0/health/price-list/item/update/PI-001" \
  -H "access-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "price": 375.00,
    "gross": 425.00,
    "discount": 50.00,
    "end_date": "2027-06-30T23:59:59.000Z"
  }'

Response​

200 OK​

{
  "message": "Price item updated successfully"
}

Error Responses​

StatusDescription
400Bad Request - Invalid fields in the request body
404Not Found - Price item with given ERP ID not found