---
title: "Partially Update Referral Order"
method: PATCH
path: "/api/2.0/referral_orders/{id}/"
tags: ["Referrals"]
---

# Partially Update Referral Order

`PATCH /api/2.0/referral_orders/{id}/`

## Path parameters

- `id` integer, required

## Request body

- PatchedReferralOrder
  - `auth_number` string, nullable
  - `authorization_for` union
    - 'Consult (One Visit Only)' | 'Procedure / Testing Only' | 'Referral For Treatment, includes Consult Visit'
    - unknown
  - `authorization_for_short` string, nullable
  - `consultant_name` string, nullable
  - `date_for_reEval` string, date, nullable
  - `icd10_codes` ICD10Code[]
    - `code` string, required
    - `description` string, nullable
  - `id` integer
  - `letter` integer — The letter associated with this referral order. Use referral_letter for the full nested letter object.
  - `patient` integer
  - `practice` integer
  - `referral_letter` ReferralLetter
    - `body` string — The body of the letter.
    - `delivery_date` string, date-time, nullable
    - `id` integer
    - `sign_date` string, date-time, nullable
  - `resolution` DocumentResolutionState
    - `created_date` string, date-time, nullable — The datetime when this resolution state was created.
    - `deleted_date` string, date-time, nullable — The datetime when this resolution was deleted. Should never be null because we're providing the most updated resolution.
    - `document` integer — Will be the same as the id of the lab order.
    - `id` integer — Internal id to represent the resolution state.
    - `note` string, nullable — Any note that was added to represent why an order was cancelled.
    - `resolving_document` integer, nullable — If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report. Must be an integer ID or null.
    - `state` 'outstanding' | 'fulfilled' | 'cancelled', required — * `outstanding` - Outstanding * `fulfilled` - Fulfilled * `cancelled` - Cancelled
  - `short_consultant_name` string, nullable
  - `sign_date` string, date-time, nullable — The datetime when this referral order was signed.
  - `signed_by` integer — The ID of the user who signed this referral order.
  - `specialty` MedicalSpecialty
    - `abbreviation` string, required
    - `category` MedicalSpecialtyCategory
      - `abbreviation` string, nullable
      - `created_date` string, date-time, nullable
      - `id` integer
      - `name` string, required
    - `created_date` string, date-time, nullable
    - `id` integer
    - `name` string, required
    - `practice_created` integer, nullable

## Response `200`

- ReferralOrder
  - `auth_number` string, nullable, required
  - `authorization_for` union
    - 'Consult (One Visit Only)' | 'Procedure / Testing Only' | 'Referral For Treatment, includes Consult Visit'
    - unknown
  - `authorization_for_short` string, nullable
  - `consultant_name` string, nullable, required
  - `date_for_reEval` string, date, nullable, required
  - `icd10_codes` ICD10Code[]
    - `code` string, required
    - `description` string, nullable
  - `id` integer
  - `letter` integer — The letter associated with this referral order. Use referral_letter for the full nested letter object.
  - `patient` integer, required
  - `practice` integer, required
  - `referral_letter` ReferralLetter
    - `body` string — The body of the letter.
    - `delivery_date` string, date-time, nullable
    - `id` integer
    - `sign_date` string, date-time, nullable
  - `resolution` DocumentResolutionState
    - `created_date` string, date-time, nullable — The datetime when this resolution state was created.
    - `deleted_date` string, date-time, nullable — The datetime when this resolution was deleted. Should never be null because we're providing the most updated resolution.
    - `document` integer — Will be the same as the id of the lab order.
    - `id` integer — Internal id to represent the resolution state.
    - `note` string, nullable — Any note that was added to represent why an order was cancelled.
    - `resolving_document` integer, nullable — If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report. Must be an integer ID or null.
    - `state` 'outstanding' | 'fulfilled' | 'cancelled', required — * `outstanding` - Outstanding * `fulfilled` - Fulfilled * `cancelled` - Cancelled
  - `short_consultant_name` string, nullable, required
  - `sign_date` string, date-time, nullable — The datetime when this referral order was signed.
  - `signed_by` integer — The ID of the user who signed this referral order.
  - `specialty` MedicalSpecialty, required
    - `abbreviation` string, required
    - `category` MedicalSpecialtyCategory
      - `abbreviation` string, nullable
      - `created_date` string, date-time, nullable
      - `id` integer
      - `name` string, required
    - `created_date` string, date-time, nullable
    - `id` integer
    - `name` string, required
    - `practice_created` integer, nullable

---

[API](https://skmtc.net/elationhealth/apis/api-authentication.md) · [All operations](https://skmtc.net/elationhealth/apis/api-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elationhealth/api-authentication/versions/c060f89d4de7/schema)
