Auto-book completed

{
  "event_name": "referral.auto_book_completed",
  "occurred_at": "2023-11-07T05:31:56Z",
  "auto_book_request": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "radius": 125,
    "address": "<string>",
    "error": "<string>",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "referral": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "1234567890",
    "status": "pending",
    "payment_type": "lien",
    "incident_state": "GA",
    "visits": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "modality": "MRI",
        "procedures": [
          {
            "body_part": "Brain",
            "procedure": "MRI Brain w/o contrast",
            "contrast": "without_contrast",
            "laterality": "not_present",
            "cpt_code": "70551",
            "cpt_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "cpt_system": "http://www.ama-assn.org/go/cpt",
            "accession_id": "<string>",
            "study_uid": "<string>",
            "series_uid": "<string>",
            "image_link": "<string>",
            "report_link": "<string>"
          }
        ],
        "status": "booked",
        "start_time": "2023-11-07T05:31:56Z",
        "radiologist_group_name": "<string>",
        "location": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip_code": "<string>",
          "name": "<string>",
          "npi": "<string>"
        }
      }
    ],
    "referring_provider": "<string>",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "npi": "<string>"
    },
    "law_firm": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "practice": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "payor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "insurance_number": "<string>",
    "wc_number": "<string>",
    "icd10_codes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "code": "M54.5",
        "system": "http://hl7.org/fhir/sid/icd-10-cm",
        "short_description": "Low back pain"
      }
    ],
    "patient": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": {
        "system": "https://scan.com/fhir/sid/patient-id",
        "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "John Doe",
      "first_name": "<string>",
      "last_name": "<string>",
      "middle_initial": "<string>",
      "date_of_birth": "05/21/1988",
      "date_of_birth_iso": "1988-05-21",
      "email": "[email protected]",
      "phone_number": "<string>",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    },
    "call_notes": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "notes": "<string>"
      }
    ],
    "documents": [
      {}
    ],
    "answered_medical_questionnaire": true,
    "preferred_location": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "auto_book_request": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "radius": 125,
      "address": "<string>",
      "error": "<string>",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  }
}

WEBHOOK

autoBookCompleted

{
  "event_name": "referral.auto_book_completed",
  "occurred_at": "2023-11-07T05:31:56Z",
  "auto_book_request": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "radius": 125,
    "address": "<string>",
    "error": "<string>",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "referral": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "1234567890",
    "status": "pending",
    "payment_type": "lien",
    "incident_state": "GA",
    "visits": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "modality": "MRI",
        "procedures": [
          {
            "body_part": "Brain",
            "procedure": "MRI Brain w/o contrast",
            "contrast": "without_contrast",
            "laterality": "not_present",
            "cpt_code": "70551",
            "cpt_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "cpt_system": "http://www.ama-assn.org/go/cpt",
            "accession_id": "<string>",
            "study_uid": "<string>",
            "series_uid": "<string>",
            "image_link": "<string>",
            "report_link": "<string>"
          }
        ],
        "status": "booked",
        "start_time": "2023-11-07T05:31:56Z",
        "radiologist_group_name": "<string>",
        "location": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip_code": "<string>",
          "name": "<string>",
          "npi": "<string>"
        }
      }
    ],
    "referring_provider": "<string>",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "npi": "<string>"
    },
    "law_firm": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "practice": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "payor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "insurance_number": "<string>",
    "wc_number": "<string>",
    "icd10_codes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "code": "M54.5",
        "system": "http://hl7.org/fhir/sid/icd-10-cm",
        "short_description": "Low back pain"
      }
    ],
    "patient": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": {
        "system": "https://scan.com/fhir/sid/patient-id",
        "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "John Doe",
      "first_name": "<string>",
      "last_name": "<string>",
      "middle_initial": "<string>",
      "date_of_birth": "05/21/1988",
      "date_of_birth_iso": "1988-05-21",
      "email": "[email protected]",
      "phone_number": "<string>",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    },
    "call_notes": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "notes": "<string>"
      }
    ],
    "documents": [
      {}
    ],
    "answered_medical_questionnaire": true,
    "preferred_location": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "auto_book_request": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "radius": 125,
      "address": "<string>",
      "error": "<string>",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  }
}

Fired when an asynchronous Partner API auto-book request reaches a terminal result. Submit a booking describes the request that starts the attempt.

Delivery

Scan sends the event to the first available destination:

The webhook_url supplied on the booking request.
The account webhook configured on the API access tab.
No webhook when neither exists; poll the referral instead.

Account webhooks are signed as described in Webhooks. A request-specific webhook is not signed with the account credential.

Header	Value
`Content-Type`	`application/json`
`User-Agent`	`Scan.com-Webhook/1.0`
`X-Scan-Event`	`referral.auto_book_completed`
`X-Scan-Timestamp`	Unix timestamp; configured account webhooks only
`X-Scan-Signature`	HMAC-SHA256 signature; configured account webhooks only

Payload

The body contains occurred_at, the terminal auto_book_request, and the current referral snapshot. Outcomes include booked, contacted_for_booking, no_availability, and booking_failed. This event does not currently include event_id. Make processing idempotent using auto_book_request.id and its terminal status.

Response

Return any HTTP 2xx response after storing the event. For account webhooks, the retry policy is documented in Webhooks. If delivery is unavailable, poll GET /api/v2/referrals/{referral_id} and inspect auto_book_request.status and auto_book_request.outcome.

Body

application/json

event_name

enum<string>

required

Available options:

referral.auto_book_completed

occurred_at

string<date-time>

required

auto_book_request

object

required

Show child attributes

referral

object

required

Referral snapshot (same shape as GET /api/v2/referrals/{id})

Show child attributes

Response

200

Return any 2xx response to acknowledge the event

Get started

Launch

Patient journey

Referral status

Lines of business

Delivery

Payload

Response

Body

Response

​Delivery

​Payload

​Response

Body

Response

Delivery

Payload

Response