Create encounter pre-service run

Beta

POST

/api/pre-service/v1/runs/encounter

POST

/api/pre-service/v1/runs/encounter

curl -X POST https://api.joincandidhealth.com/api/pre-service/v1/runs/encounter \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "entity": {
    "external_id": "external_id",
    "patient_authorized_release": true,
    "benefits_assigned_to_provider": true,
    "provider_accepts_assignment": true,
    "patient": {
      "address": {
        "address1": "address1",
        "city": "city",
        "state": "AA",
        "zip_code": "zip_code"
      },
      "date_of_birth": "2023-01-15",
      "external_id": "external_id",
      "first_name": "first_name",
      "gender": "male",
      "last_name": "last_name"
    },
    "responsible_party": "INSURANCE_PAY",
    "billing_provider": {
      "address": {
        "address1": "address1",
        "city": "city",
        "state": "AA",
        "zip_code": "zip_code",
        "zip_plus_four_code": "zip_plus_four_code"
      },
      "npi": "npi",
      "tax_id": "tax_id"
    },
    "submission_expectation": "TARGET_PROFESSIONAL"
  },
  "pipeline_id": "pipeline_id",
  "enabled_rule_ids": [
    "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
  ],
  "disabled_rule_ids": [
    "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
  ],
  "idempotency_key": "idempotency_key"
}'

{
  "run_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}

Submit a representation of an encounter to the Candid rules engine. Note that this encounter will not be created in Candid. Returns a run_id that can be polled via GET /runs/{run_id} to retrieve the results once complete.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

entityobjectRequired

The encounter to evaluate against the rules engine.

pipeline_idstringRequired

Identifies the set of rules to run against the encounter.

enabled_rule_idslist of UUIDsRequired

IDs of disabled rules to force-enable for this run (e.g. for testing new rules).

disabled_rule_idslist of UUIDsRequired

IDs of enabled rules to force-disable for this run (e.g., to “override” or skip certain rules).

idempotency_keystringRequired

Prevents multiple rule runs from being dispatched in response to duplicate requests.

Response

This endpoint returns an object.

run_idUUID

Errors

403

Unauthorized Error

422

Unprocessable Entity Error