Create Claim Draft

Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.

Platform GUID of the participant.

Plan GUID identifying the benefits offering.

The service start date for the claim.

The service end date for the claim. Defaults to service start date if not provided.

The expense category (e.g. Medical, Dental, Vision).

The expense type within the category (e.g. Prescription).

Optional description of the service.

Name of the service recipient (participant or dependent name).

Name of the provider (e.g. CVS Pharmacy).

Provider NPI or reference number.

The total amount being claimed.

Mileage reimbursement amount in dollars.

Number of miles travelled for the service.

Mileage rate per mile used for reimbursement calculation.

Whether a receipt is required for this claim.

Optional comments from the participant.

Whether this claim is a duplicate of an existing claim.

Whether this claim needs manual review.

Whether this claim has been split into multiple claims.

Optional document image ID linked to this claim.

Whether the received date was explicitly specified by the caller.

Whether this is a recurring claim request.

The date the claim was received. Defaults to today if not specified.

Eligible expense ID for the selected expense type. Must be valid for the specified plan.

Amount denied by an administrator.

Total expense amount for this claim.

Recipients for this expense (participant, dependents, or external recipients).

Gets or sets the provisional order number associated with the worksheet.

Gets or sets the stable system GUID for this worksheet (ClaimWorksheetExternal_guid). Pass this value as the {worksheet_id} route parameter when calling PUT /v1/claims/worksheets/{worksheet_id} or POST /v1/claims/{worksheet_id}/file-claim.

Gets or sets the status of the worksheet.

Gets or sets the creation date and time of the worksheet.

Gets or sets the date and time until which the worksheet is valid.

Gets or sets the list of submissions within the worksheet.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.