Create a referral

post https://{defaultHost}/api/v1/referrals

    A referral can only be accessed by the user who created it.
    Use this endpoint to create a referral linked to the access_token's user.
    Required fields to create a referral:
      - patient's first_name, last_name, email, phone, date_of_birth_iso, gender,
        address_line_1, and address_postcode
    More information must be entered before submitting or confirming a referral.
    See the "Submit a referral" and "Confirm a referral" for more information.

Body Params

patient_id

string

This field is optional and can be used to group referals per patients. Any string is accepted.

modality

string

Type of scan. MRI, Ultrasound, CT, Pregnancy, X-Ray, Full Body MRI, Mammogram, or Guided Injection.

referral_information

string

What is the reason for the scan? Any details you can share will help our clinicians understand the symptoms and scanning needs.

internal_reference

string

Use this attribute to add your own internal reference code to this referral (Optional).

body_part_ids

array of integers

IDs of body parts to scan. These IDs can be obtained with the "List body parts" endpoint. Use the "List modalities V2" to know how many body parts can be selected

body_part_ids

imaging_provider_id

integer

ID of the imaging provider where the scan will be performed. Can be obtained via the "List imaging providers" endpoint

patient_information

object

Information about the patient.

safety_question_list

object

Responses

Response body

object

success

boolean

validation_errors

array of objects

validation_errors

object

attribute

string

message

string

full_message

string

object

string

created_at

string

The autogenerated date and time when the referral was created.

updated_at

string

The date and time when the referral was last modified.

patient_id

string | null

This field is optional and can be used to group referals per patients.

modality

string | null

MRI, Ultrasound, CT, Pregnancy, X-Ray, Full Body MRI, Mammogram, or Guided Injection

referral_information

string | null

Reason for the scan.

reference

string

Referral Reference. This is set by Scan.com when the referral is created.

submitted_at

string | null

The date and time when the referral was submitted.

patient_email_sent_at

string | null

The date and time when the patient clicked the link to confirm the referral.

cancelled_at

string | null

The date and time when the referral was cancelled.

paid_at

string | null

The date and time when the referral was paid by the patient.

received_at

string | null

The date and time when the referral was received by the imaging provider.

completed_at

string | null

The date and time when the referral was completed.

on_hold_at

string | null

The date and time when the referral was put on hold.

patient_report_added_at

string | null

The date and time when the patient scan report was added to received by Scan.com.

patient_confirmed_at

string | null

The date and time when the referral was confirmed.

cancellation_reason

string | null

The reason why the referral was cancelled

booking_time

string | null

The date and time when the scan is taking place.

confirmed_booking_time

string | null

The confirmed date and time when the scan is taking place.

scan_booked_at

string | null

The date and time when the scan time was booked.

confirmation_by_user

boolean

If true, the referral confirmation needs to be done via the API. If false, the referral confirmation will be done by the patient.

scan_images_requested_at

string | null

The date and time when the scan images were requested.

approved_scan_images_count

integer

Number of available scan images.

available_scan_reports_count

integer

Number of available scan reports.

internal_reference

string | null

Use this attribute to add your own internal reference code to this referral (Optional)

status

string

Created, Submitted, Confirmed, Received, Scan Booked, On hold, Cancelled, or Completed

report_status

string | null

null, Pending, or Ready

body_parts

array of objects

body_parts

object

integer

name

string

referral_form_filename

string | null

Name of the Referral form file

scan_report_filename

string | null

Name of the scan report file. This attribute is deprecated. Please use the /api/v1/referrals/{referral_id}/scan_reports endpoint instead.

referral_form_url

string | null

URL of the Referral form file. Expires after 5 minutes

scan_report_url

string | null

URL of the scan report file. Expires after 5 minutes. This attribute is deprecated. Please use the /api/v1/referrals/{referral_id}/scan_reports endpoint instead.

patient_information

object

safety_question_list

object

imaging_provider

object | null

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.uk.scan.com/api/v1/referrals \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201When the referral has been created successfully

422When there are some validation errors