Batch match dimension points to rates

POST

/api/fee-schedules/v3/batch-match

POST

/api/fee-schedules/v3/batch-match

curl -X POST https://api.joincandidhealth.com/api/fee-schedules/v3/batch-match \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "organization_billing_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "cpt_code": "cpt_code",
    "date_of_service": "2023-01-15"
  },
  {
    "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "organization_billing_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "cpt_code": "cpt_code",
    "date_of_service": "2023-01-15"
  }
]'

200Successful

[
  {
    "point": {
      "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "organization_billing_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "cpt_code": "cpt_code",
      "date_of_service": "2023-01-15",
      "modifiers": [
        "AV",
        "AV"
      ],
      "facility_type_code": "01",
      "state": "AA",
      "zip_code": "zip_code",
      "license_type": "MD",
      "network_types": [
        "12",
        "12"
      ],
      "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "quantity": "quantity"
    },
    "match": {
      "dimensions": {
        "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "organization_billing_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "states": [
          "AA"
        ],
        "zip_codes": [
          "zip_codes"
        ],
        "license_types": [
          "MD"
        ],
        "facility_type_codes": [
          "01"
        ],
        "network_types": [
          "12"
        ],
        "payer_plan_group_ids": [
          "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
        ],
        "cpt_code": "cpt_code",
        "modifiers": [
          "AV"
        ]
      },
      "entries": [
        {
          "start_date": "2023-01-15",
          "rate_cents": 1,
          "is_deactivated": true,
          "end_date": "2023-01-15"
        },
        {
          "start_date": "2023-01-15",
          "rate_cents": 1,
          "is_deactivated": true,
          "end_date": "2023-01-15"
        }
      ],
      "matched_entry": {
        "start_date": "2023-01-15",
        "rate_cents": 1,
        "is_deactivated": true,
        "end_date": "2023-01-15"
      },
      "rate_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "total_cents": 1,
      "updated_at": "2023-01-15",
      "updated_by": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "version": 1
    }
  },
  {
    "point": {
      "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "organization_billing_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "cpt_code": "cpt_code",
      "date_of_service": "2023-01-15",
      "modifiers": [
        "AV",
        "AV"
      ],
      "facility_type_code": "01",
      "state": "AA",
      "zip_code": "zip_code",
      "license_type": "MD",
      "network_types": [
        "12",
        "12"
      ],
      "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "quantity": "quantity"
    },
    "match": {
      "dimensions": {
        "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "organization_billing_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "states": [
          "AA"
        ],
        "zip_codes": [
          "zip_codes"
        ],
        "license_types": [
          "MD"
        ],
        "facility_type_codes": [
          "01"
        ],
        "network_types": [
          "12"
        ],
        "payer_plan_group_ids": [
          "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
        ],
        "cpt_code": "cpt_code",
        "modifiers": [
          "AV"
        ]
      },
      "entries": [
        {
          "start_date": "2023-01-15",
          "rate_cents": 1,
          "is_deactivated": true,
          "end_date": "2023-01-15"
        },
        {
          "start_date": "2023-01-15",
          "rate_cents": 1,
          "is_deactivated": true,
          "end_date": "2023-01-15"
        }
      ],
      "matched_entry": {
        "start_date": "2023-01-15",
        "rate_cents": 1,
        "is_deactivated": true,
        "end_date": "2023-01-15"
      },
      "rate_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "total_cents": 1,
      "updated_at": "2023-01-15",
      "updated_by": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "version": 1
    }
  }
]

Gets the rate that matches each of a list of dimension points, using the same matching as the service line match endpoint. Useful for showing rates before a service line exists in Candid.

Results are returned in request order, one per point. A point with no matching rate has a null match.

An omitted optional dimension only matches rates that have no restriction on that dimension. CPT codes are matched case-insensitively, and ZIP codes are matched on their first 5 digits.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects a list of objects.

payer_uuidUUIDRequired

organization_billing_provider_idUUIDRequired

cpt_codestringRequired

Matched case-insensitively.

date_of_servicedateRequired

The rate entry in effect on this date is used.

modifierslist of enumsOptional

Defaults to no modifiers.

facility_type_codeenumOptional

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set

stateenumOptional

zip_codestringOptional

Only the first 5 digits are used, so ZIP+4 values are accepted.

license_typeenumOptional

The rendering provider's license type.

network_typeslist of enumsOptional

payer_plan_group_idUUIDOptional

quantitystringOptional

The number of units. Defaults to 1.

Response

This endpoint returns a list of objects.

pointobject

The point from the request.

matchobjectOptional

The matched rate. Null means no rate matches the point.