Skip to main content
PATCH
Mark Phlebotomy Order Completed

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

order_id
string
required

Body

application/json

Request body for PATCH /phlebotomy-orders/{id}/completed. completed toggles the tick — True stamps completed_date/completed_by_provider_id against the calling provider, False clears both (an accidental-tick undo).

completed
boolean
required

Response

Successful Response

id
string
required
patientId
string
required
orderingProviderId
string
required
recipientFaxContactId
string | null
required
diagnosisHh
boolean
required
diagnosisTt
boolean
required
otherDiagnoses
string | null
required
frequency
enum<string> | null
required

Draw frequency on the OneBlood Form-96 phlebotomy order.

Rendered as checkboxes on the form but functionally exclusive — a single selection, not independent booleans. OTHER carries free text in PatientPhlebotomyOrder.other_frequency.

Available options:
ONE_TIME,
WEEKLY,
EVERY_2_WEEKS,
EVERY_4_WEEKS,
EVERY_8_WEEKS,
OTHER
otherFrequency
string | null
required
hemoglobinThreshold
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
amount
enum<string> | null
required

Draw amount on the OneBlood Form-96 phlebotomy order.

Rendered as checkboxes on the form but functionally exclusive — a single selection, not independent booleans. OTHER carries a free-text mL amount in PatientPhlebotomyOrder.other_amount_ml.

Available options:
ONE_UNIT,
OTHER
otherAmountMl
integer | null
required
comments
string | null
required
signatureUrl
string | null
required
formVersion
string
required
sentAt
string<date-time> | null
required
sentChannels
enum<string>[]
required

A channel a phlebotomy order's document went out on.

Derived, never stamped — each member corresponds to a link that already exists once the document leaves the building:

  • FAX: a fax_attachment row references the document
  • EMAIL: an email_attachment row references the document
  • PORTAL: document.shared_with_patient is set (a portal share, or the SMS that texts the patient a portal link)

An order can therefore be on several channels at once, which is why the response carries a list rather than one "how was it sent" value.

Available options:
EMAIL,
FAX,
PORTAL
completedDate
string<date-time> | null
required
completedByProviderId
string | null
required
documentId
string
required
documentFilePath
string
required
documentTitle
string
required
createdDate
string<date-time>
required