TRANXACT.AI Help

EHR · Laboratory

Laboratory Quality Control

Control runs. Beyond two standard deviations warns; beyond three fails and results are held.

Type REST7 operationsBase path /api/ehr/lab-qcPublished as /api/v1/lab-qc

Download specification (OpenAPI 3.1) Screen: Laboratory Quality Control

Overview

PackageEHR
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold EHR › Laboratory Quality Control on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableehr.lab_qc_runs · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ehr/lab-qcList laboratory quality control

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "lab_test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "run_at": "2026-10-30T09:00:00Z",
      "instrument": "text",
      "control_level": "text",
      "expected_value": "1250.00",
      "expected_sd": "1250.00",
      "measured_value": "1250.00",
      "z_score": "1250.00",
      "result": "text",
      "performed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "corrective_action": "text",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "xf_text_1": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ehr/lab-qc?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/lab-qc/{id}Read one lab qc

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lab_test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_at": "2026-10-30T09:00:00Z",
  "instrument": "text",
  "control_level": "text",
  "expected_value": "1250.00",
  "expected_sd": "1250.00",
  "measured_value": "1250.00",
  "z_score": "1250.00",
  "result": "text",
  "performed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "corrective_action": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/ehr/lab-qc/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/lab-qcCreate a lab qc

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
lab_test_iduuidYesLab test id
instrumenttextNoInstrument
control_leveltextNoControl level
expected_valuenumericNoExpected value
expected_sdnumericNoExpected sd
measured_valuenumericYesMeasured value
performed_byuuidNoPerformed by
corrective_actiontextNoCorrective action

Sample body

{
  "lab_test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "measured_value": "1250.00",
  "instrument": "text",
  "control_level": "text",
  "expected_value": "1250.00",
  "expected_sd": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lab_test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_at": "2026-10-30T09:00:00Z",
  "instrument": "text",
  "control_level": "text",
  "expected_value": "1250.00",
  "expected_sd": "1250.00",
  "measured_value": "1250.00",
  "z_score": "1250.00",
  "result": "text",
  "performed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "corrective_action": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/lab-qc" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lab_test_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","measured_value":"1250.00","instrument":"text","control_level":"text","expected_value":"1250.00","expected_sd":"1250.00"}'
PUT/api/ehr/lab-qc/{id}Change a lab qc

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
lab_test_iduuidYesLab test id
instrumenttextNoInstrument
control_leveltextNoControl level
expected_valuenumericNoExpected value
expected_sdnumericNoExpected sd
measured_valuenumericYesMeasured value
performed_byuuidNoPerformed by
corrective_actiontextNoCorrective action

Sample body

{
  "lab_test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "measured_value": "1250.00"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lab_test_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_at": "2026-10-30T09:00:00Z",
  "instrument": "text",
  "control_level": "text",
  "expected_value": "1250.00",
  "expected_sd": "1250.00",
  "measured_value": "1250.00",
  "z_score": "1250.00",
  "result": "text",
  "performed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "corrective_action": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ehr/lab-qc/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lab_test_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","measured_value":"1250.00"}'
DELETE/api/ehr/lab-qc/{id}Delete a lab qc

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/ehr/lab-qc/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/lab-qc/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/lab-qc/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/ehr/lab-qc/recordRecord

Request body

The keys this action reads (* = required; "one of" lists the only values):

labTestId*, instrument, controlLevel, expectedValue, expectedSd, measuredValue, performedBy

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/lab-qc/record" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"labTestId":"value","instrument":"value","controlLevel":"value","expectedValue":"value","expectedSd":"value","measuredValue":"value"}'

Data model

Every field of a lab qc, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
lab_test_iduuidread, writeLab test id
run_attimestamp with time zoneread onlyRun at
instrumenttextread, writeInstrument
control_leveltextread, writeControl level
expected_valuenumericread, writeExpected value
expected_sdnumericread, writeExpected sd
measured_valuenumericread, writeMeasured value
z_scorenumericread onlyZ score
resulttextread onlyResult
performed_byuuidread, writePerformed by
corrective_actiontextread, writeCorrective action
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold EHR › Laboratory Quality Control for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.