Partially Update Lab Order - Elation Help Center

PATCH

api

2.0

lab_orders

{id}

Partially Update Lab Order

curl --request PATCH \
  --url https://sandbox.elationemr.com/api/2.0/lab_orders/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "answers": [
    {
      "question": 123,
      "test": 123,
      "value": "<string>"
    }
  ],
  "ccs": [
    123
  ],
  "chart_date": "2023-11-07T05:31:56Z",
  "confidential": false,
  "content": {
    "collection_datetime": "2023-11-07T05:31:56Z",
    "icd10_codes": [
      {
        "code": "<string>",
        "description": "<string>"
      }
    ],
    "patient_instructions": "<string>",
    "standing_order_end_date": "2023-12-25",
    "standing_order_frequency": "<string>",
    "test_center_notes": "<string>",
    "tests": [
      {
        "icd10_codes": [
          {
            "code": "<string>",
            "description": "<string>"
          }
        ],
        "name": "<string>",
        "code": "<string>",
        "compendium": 123,
        "cpts": [
          "<string>"
        ],
        "lab_vendor": 123,
        "practice_created": 123,
        "procedure_class": "<string>",
        "questions": [
          {
            "question": {
              "choices": [
                {
                  "code": "<string>",
                  "value": "<string>"
                }
              ],
              "code": "<string>",
              "value": "<string>",
              "example_format": "<string>",
              "max_length": 32767,
              "secondary_code": "<string>"
            },
            "sequence": 32767,
            "required": true
          }
        ],
        "synonyms": [
          "<string>"
        ]
      }
    ]
  },
  "document_date": "2023-11-07T05:31:56Z",
  "facility": {
    "active": true,
    "lab_facility": "<string>",
    "practice": 123,
    "practice_facility": "<string>",
    "vendor": {
      "display_name": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "compendium": 123,
    "description": "<string>",
    "lab_connection": 123,
    "practice_secondary_id": "<string>",
    "user_facing": true
  },
  "follow_up_method": "<string>",
  "ordering_physician": 123,
  "patient": 123,
  "practice": 123,
  "printable_view": "<string>",
  "requisition": 123,
  "resolution": {
    "note": "<string>",
    "resolving_document": 123
  },
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "site": {
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "fax": "<string>",
    "phone": "<string>",
    "practice_created": 123,
    "state": "<string>",
    "suite": "<string>",
    "vendor": {},
    "zip": "<string>"
  },
  "special_insurance": {
    "code": "<string>",
    "name": "<string>"
  },
  "specimens": [
    {
      "body_site": {
        "code": "<string>",
        "text": "<string>"
      },
      "container_id": "<string>",
      "modifiers": [
        {
          "modifier": {
            "code": "<string>",
            "text": "<string>"
          },
          "sequence": 32767,
          "specimen": 123
        }
      ],
      "test": 123,
      "description": "<string>"
    }
  ],
  "submissions": [
    {
      "time_submitted": "2023-11-07T05:31:56Z",
      "state": "<string>",
      "state_metadata": "<string>",
      "time_acknowledged": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    123
  ],
  "test_date": "2023-12-25",
  "vendor": 123
}
'

{
  "document_date": "2023-11-07T05:31:56Z",
  "ordering_physician": 123,
  "patient": 123,
  "practice": 123,
  "answers": [
    {
      "question": 123,
      "created_date": "2023-11-07T05:31:56Z",
      "deleted_date": "2023-11-07T05:31:56Z",
      "id": 123,
      "test": 123,
      "value": "<string>"
    }
  ],
  "ccs": [
    123
  ],
  "chart_date": "2023-11-07T05:31:56Z",
  "confidential": false,
  "content": {
    "collection_datetime": "2023-11-07T05:31:56Z",
    "icd10_codes": [
      {
        "code": "<string>",
        "description": "<string>"
      }
    ],
    "id": 123,
    "patient_instructions": "<string>",
    "standing_order_end_date": "2023-12-25",
    "standing_order_frequency": "<string>",
    "test_center_notes": "<string>",
    "tests": [
      {
        "icd10_codes": [
          {
            "code": "<string>",
            "description": "<string>"
          }
        ],
        "name": "<string>",
        "code": "<string>",
        "compendium": 123,
        "cpts": [
          "<string>"
        ],
        "created_date": "2023-11-07T05:31:56Z",
        "deleted_date": "2023-11-07T05:31:56Z",
        "id": 123,
        "lab_vendor": 123,
        "practice_created": 123,
        "procedure_class": "<string>",
        "questions": [
          {
            "question": {
              "choices": [
                {
                  "code": "<string>",
                  "value": "<string>",
                  "created_date": "2023-11-07T05:31:56Z",
                  "deleted_date": "2023-11-07T05:31:56Z",
                  "id": 123
                }
              ],
              "code": "<string>",
              "value": "<string>",
              "created_date": "2023-11-07T05:31:56Z",
              "deleted_date": "2023-11-07T05:31:56Z",
              "example_format": "<string>",
              "id": 123,
              "max_length": 32767,
              "secondary_code": "<string>"
            },
            "sequence": 32767,
            "required": true,
            "test": 123
          }
        ],
        "synonyms": [
          "<string>"
        ]
      }
    ]
  },
  "created_date": "2023-11-07T05:31:56Z",
  "deleted_date": "2023-11-07T05:31:56Z",
  "facility": {
    "active": true,
    "lab_facility": "<string>",
    "practice": 123,
    "practice_facility": "<string>",
    "vendor": {
      "display_name": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "bidi_connection": {
      "alias": "<string>",
      "enabled": true,
      "id": 123,
      "priority": 32767,
      "protocol": "<string>"
    },
    "compendium": 123,
    "created_date": "2023-11-07T05:31:56Z",
    "deleted_date": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": 123,
    "lab_connection": 123,
    "practice_secondary_id": "<string>",
    "user_facing": true
  },
  "follow_up_method": "<string>",
  "id": 123,
  "printable_view": "<string>",
  "requisition": 123,
  "resolution": {
    "created_date": "2023-11-07T05:31:56Z",
    "deleted_date": "2023-11-07T05:31:56Z",
    "document": 123,
    "id": 123,
    "note": "<string>",
    "resolving_document": 123
  },
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "site": {
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "created_date": "2023-11-07T05:31:56Z",
    "deleted_date": "2023-11-07T05:31:56Z",
    "fax": "<string>",
    "id": 123,
    "phone": "<string>",
    "practice_created": 123,
    "state": "<string>",
    "suite": "<string>",
    "vendor": {
      "display_name": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "zip": "<string>"
  },
  "special_insurance": {
    "code": "<string>",
    "name": "<string>"
  },
  "specimens": [
    {
      "body_site": {
        "code": "<string>",
        "text": "<string>",
        "deleted_date": "2023-11-07T05:31:56Z"
      },
      "container_id": "<string>",
      "modifiers": [
        {
          "modifier": {
            "code": "<string>",
            "text": "<string>",
            "deleted_date": "2023-11-07T05:31:56Z"
          },
          "sequence": 32767,
          "specimen": 123,
          "deleted_date": "2023-11-07T05:31:56Z"
        }
      ],
      "test": 123,
      "description": "<string>",
      "id": 123,
      "lab_order": 123
    }
  ],
  "submissions": [
    {
      "time_submitted": "2023-11-07T05:31:56Z",
      "id": 123,
      "lab_order": 123,
      "state": "<string>",
      "state_metadata": "<string>",
      "time_acknowledged": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    123
  ],
  "test_date": "2023-12-25",
  "vendor": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

integer<int64>

required

Body

application/json

answers

object[] | null

List of the answers provided for the Ask on Entry (AOE) questions if required by any lab order tests.

Show child attributes

bill_type

enum<string> | null

Who is financially responsible for the order.

thirdparty - Third Party (e.g. Insurance)
patient - Patient
client - Client
workerscomp - Worker's Comp
specialbilling - Special Billing

Available options:

thirdparty,

patient,

client,

workerscomp,

specialbilling

ccs

(integer<int64> | null)[]

List of physician ids who should be cc'd on any reports.

chart_date

string<date-time>

Date at which this order was first seen in the patient's chart.

confidential

boolean

default:false

Whether the provider has marked the order as confidential. Should not be shared with a patient.

content

object

Represents the content of the lab order report.

Show child attributes

document_date

string<date-time>

Time at which this order was created in whichever system created it. Could be historical or same as the create_date.

facility

object | null

An identifier that represents the facility placing the order. Usually assigned by the lab vendor.

Show child attributes

follow_up_method

string | null

Freetext field communicating how the patient should receive their results.

ordering_physician

integer<int64>

The id of the physician who created the order.

patient

integer<int64>

The id of the patient.

practice

integer<int64>

The id of the practice.

printable_view

string<uri>

requisition

integer

The requisition id of the order. Can be different from the order id if and when the order was created outside of Elation.

resolution

object | null

The current state of the order's resolution.

Show child attributes

signed_by

integer<int64> | null

The id of the physician who signed off on the order.

signed_date

string<date-time> | null

The time when the order was signed.

site

object | null

The location where the patient will have the lab performed. Sites are specific to their lab vendor.

Show child attributes

special_insurance

object | null

Used primarily to support specific electronic lab order integrations.

Show child attributes

specimens

object[] | null

Record of any specimens collected when creating the order.

Show child attributes

submissions

object[] | null

Record of the attempts to submit.

Show child attributes

Response

200 - application/json

document_date

string<date-time>

required

Time at which this order was created in whichever system created it. Could be historical or same as the create_date.

ordering_physician

integer<int64>

required

The id of the physician who created the order.

patient

integer<int64>

required

The id of the patient.

practice

integer<int64>

required

The id of the practice.

answers

object[] | null

List of the answers provided for the Ask on Entry (AOE) questions if required by any lab order tests.

Show child attributes

bill_type

enum<string> | null

Who is financially responsible for the order.

thirdparty - Third Party (e.g. Insurance)
patient - Patient
client - Client
workerscomp - Worker's Comp
specialbilling - Special Billing

Available options:

thirdparty,

patient,

client,

workerscomp,

specialbilling

ccs

(integer<int64> | null)[]

List of physician ids who should be cc'd on any reports.

chart_date

string<date-time>

Date at which this order was first seen in the patient's chart.

confidential

boolean

default:false

Whether the provider has marked the order as confidential. Should not be shared with a patient.

content

object

Represents the content of the lab order report.

Show child attributes

created_date

string<date-time> | null

read-only

Time at which elation created this order. Can be different from chart_date when the order was imported into a chart from a different source and document_date when documenting an order that happened at some other time.

deleted_date

string<date-time> | null

read-only

facility

object | null

An identifier that represents the facility placing the order. Usually assigned by the lab vendor.

Show child attributes

follow_up_method

string | null

Freetext field communicating how the patient should receive their results.

integer

read-only

printable_view

string<uri>

requisition

integer

The requisition id of the order. Can be different from the order id if and when the order was created outside of Elation.

resolution

object | null

The current state of the order's resolution.

Show child attributes

signed_by

integer<int64> | null

The id of the physician who signed off on the order.

signed_date

string<date-time> | null

The time when the order was signed.

site

object | null

The location where the patient will have the lab performed. Sites are specific to their lab vendor.

Show child attributes

special_insurance

object | null

Used primarily to support specific electronic lab order integrations.

Show child attributes

specimens

object[] | null

Record of any specimens collected when creating the order.

Show child attributes

submissions

object[] | null

Record of the attempts to submit.

Show child attributes

tags

(integer<int64> | null)[]

Any tags associated with the lab order.

test_date

string<date> | null

The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.

vendor

integer<int64> | null

Retrieve the Printable Lab Order ViewProviders are able to print a view of the lab order including the data provided behind this endpoint. Each lab order response includes a link to obtain this view; a PDF file. When you GET the link you'll receive a response with application/pdf and the bytes of the PDF.

⌘I

Partially Update Lab Order

curl --request PATCH \
  --url https://sandbox.elationemr.com/api/2.0/lab_orders/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "answers": [
    {
      "question": 123,
      "test": 123,
      "value": "<string>"
    }
  ],
  "ccs": [
    123
  ],
  "chart_date": "2023-11-07T05:31:56Z",
  "confidential": false,
  "content": {
    "collection_datetime": "2023-11-07T05:31:56Z",
    "icd10_codes": [
      {
        "code": "<string>",
        "description": "<string>"
      }
    ],
    "patient_instructions": "<string>",
    "standing_order_end_date": "2023-12-25",
    "standing_order_frequency": "<string>",
    "test_center_notes": "<string>",
    "tests": [
      {
        "icd10_codes": [
          {
            "code": "<string>",
            "description": "<string>"
          }
        ],
        "name": "<string>",
        "code": "<string>",
        "compendium": 123,
        "cpts": [
          "<string>"
        ],
        "lab_vendor": 123,
        "practice_created": 123,
        "procedure_class": "<string>",
        "questions": [
          {
            "question": {
              "choices": [
                {
                  "code": "<string>",
                  "value": "<string>"
                }
              ],
              "code": "<string>",
              "value": "<string>",
              "example_format": "<string>",
              "max_length": 32767,
              "secondary_code": "<string>"
            },
            "sequence": 32767,
            "required": true
          }
        ],
        "synonyms": [
          "<string>"
        ]
      }
    ]
  },
  "document_date": "2023-11-07T05:31:56Z",
  "facility": {
    "active": true,
    "lab_facility": "<string>",
    "practice": 123,
    "practice_facility": "<string>",
    "vendor": {
      "display_name": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "compendium": 123,
    "description": "<string>",
    "lab_connection": 123,
    "practice_secondary_id": "<string>",
    "user_facing": true
  },
  "follow_up_method": "<string>",
  "ordering_physician": 123,
  "patient": 123,
  "practice": 123,
  "printable_view": "<string>",
  "requisition": 123,
  "resolution": {
    "note": "<string>",
    "resolving_document": 123
  },
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "site": {
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "fax": "<string>",
    "phone": "<string>",
    "practice_created": 123,
    "state": "<string>",
    "suite": "<string>",
    "vendor": {},
    "zip": "<string>"
  },
  "special_insurance": {
    "code": "<string>",
    "name": "<string>"
  },
  "specimens": [
    {
      "body_site": {
        "code": "<string>",
        "text": "<string>"
      },
      "container_id": "<string>",
      "modifiers": [
        {
          "modifier": {
            "code": "<string>",
            "text": "<string>"
          },
          "sequence": 32767,
          "specimen": 123
        }
      ],
      "test": 123,
      "description": "<string>"
    }
  ],
  "submissions": [
    {
      "time_submitted": "2023-11-07T05:31:56Z",
      "state": "<string>",
      "state_metadata": "<string>",
      "time_acknowledged": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    123
  ],
  "test_date": "2023-12-25",
  "vendor": 123
}
'

{
  "document_date": "2023-11-07T05:31:56Z",
  "ordering_physician": 123,
  "patient": 123,
  "practice": 123,
  "answers": [
    {
      "question": 123,
      "created_date": "2023-11-07T05:31:56Z",
      "deleted_date": "2023-11-07T05:31:56Z",
      "id": 123,
      "test": 123,
      "value": "<string>"
    }
  ],
  "ccs": [
    123
  ],
  "chart_date": "2023-11-07T05:31:56Z",
  "confidential": false,
  "content": {
    "collection_datetime": "2023-11-07T05:31:56Z",
    "icd10_codes": [
      {
        "code": "<string>",
        "description": "<string>"
      }
    ],
    "id": 123,
    "patient_instructions": "<string>",
    "standing_order_end_date": "2023-12-25",
    "standing_order_frequency": "<string>",
    "test_center_notes": "<string>",
    "tests": [
      {
        "icd10_codes": [
          {
            "code": "<string>",
            "description": "<string>"
          }
        ],
        "name": "<string>",
        "code": "<string>",
        "compendium": 123,
        "cpts": [
          "<string>"
        ],
        "created_date": "2023-11-07T05:31:56Z",
        "deleted_date": "2023-11-07T05:31:56Z",
        "id": 123,
        "lab_vendor": 123,
        "practice_created": 123,
        "procedure_class": "<string>",
        "questions": [
          {
            "question": {
              "choices": [
                {
                  "code": "<string>",
                  "value": "<string>",
                  "created_date": "2023-11-07T05:31:56Z",
                  "deleted_date": "2023-11-07T05:31:56Z",
                  "id": 123
                }
              ],
              "code": "<string>",
              "value": "<string>",
              "created_date": "2023-11-07T05:31:56Z",
              "deleted_date": "2023-11-07T05:31:56Z",
              "example_format": "<string>",
              "id": 123,
              "max_length": 32767,
              "secondary_code": "<string>"
            },
            "sequence": 32767,
            "required": true,
            "test": 123
          }
        ],
        "synonyms": [
          "<string>"
        ]
      }
    ]
  },
  "created_date": "2023-11-07T05:31:56Z",
  "deleted_date": "2023-11-07T05:31:56Z",
  "facility": {
    "active": true,
    "lab_facility": "<string>",
    "practice": 123,
    "practice_facility": "<string>",
    "vendor": {
      "display_name": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "bidi_connection": {
      "alias": "<string>",
      "enabled": true,
      "id": 123,
      "priority": 32767,
      "protocol": "<string>"
    },
    "compendium": 123,
    "created_date": "2023-11-07T05:31:56Z",
    "deleted_date": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": 123,
    "lab_connection": 123,
    "practice_secondary_id": "<string>",
    "user_facing": true
  },
  "follow_up_method": "<string>",
  "id": 123,
  "printable_view": "<string>",
  "requisition": 123,
  "resolution": {
    "created_date": "2023-11-07T05:31:56Z",
    "deleted_date": "2023-11-07T05:31:56Z",
    "document": 123,
    "id": 123,
    "note": "<string>",
    "resolving_document": 123
  },
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "site": {
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "created_date": "2023-11-07T05:31:56Z",
    "deleted_date": "2023-11-07T05:31:56Z",
    "fax": "<string>",
    "id": 123,
    "phone": "<string>",
    "practice_created": 123,
    "state": "<string>",
    "suite": "<string>",
    "vendor": {
      "display_name": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "zip": "<string>"
  },
  "special_insurance": {
    "code": "<string>",
    "name": "<string>"
  },
  "specimens": [
    {
      "body_site": {
        "code": "<string>",
        "text": "<string>",
        "deleted_date": "2023-11-07T05:31:56Z"
      },
      "container_id": "<string>",
      "modifiers": [
        {
          "modifier": {
            "code": "<string>",
            "text": "<string>",
            "deleted_date": "2023-11-07T05:31:56Z"
          },
          "sequence": 32767,
          "specimen": 123,
          "deleted_date": "2023-11-07T05:31:56Z"
        }
      ],
      "test": 123,
      "description": "<string>",
      "id": 123,
      "lab_order": 123
    }
  ],
  "submissions": [
    {
      "time_submitted": "2023-11-07T05:31:56Z",
      "id": 123,
      "lab_order": 123,
      "state": "<string>",
      "state_metadata": "<string>",
      "time_acknowledged": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    123
  ],
  "test_date": "2023-12-25",
  "vendor": 123
}