Lab & clinical

Lab results, clinical notes, imaging, procedures, encounters, and other clinical observations. Submit these via POST /v1/logs/batch or the Python SDK; see How logs work for submission fields and the difference between lifecycle-tracked and point-in-time log types.

Lab results

Type: lab_results · Source: Python SDK / REST, Integration · Extensible Reserved for laboratory test results (blood, urine, etc.): results from a lab with test identity (loinc_code or test_name) and value (value_numeric/value_string + unit); single result, panel, or batch. Payload

panel_loinc_code

string | null

LOINC code for the panel (e.g. CBC, CMP). Enables grouping of individual results.

panel_name

string | null

Human-readable panel name (e.g. ‘Complete Blood Count’).

collection_datetime

string

ISO 8601 UTC datetime when the specimen was collected.

ordered_by_npi

string | null

NPI of the ordering provider.

performing_lab

object | null

Show fields

name

string

Name of the laboratory that performed the tests.

clia_number

string

CLIA certificate number of the performing lab.

results

object[]

required

Show fields

loinc_code

string

Preferred. test_name and specimen_type resolved server-side when provided.. Example: 4548-4, 718-7, 2160-0

test_name

string

Required when loinc_code is absent.

specimen_type

string

E.g. blood, urine, serum. Provide for best-effort LOINC mapping when loinc_code is absent.

test_category

string

Broad category for grouping when LOINC is absent.. One of: hematology, metabolic, lipid, oncology_marker, cardiac, diabetes, renal, hepatic, other

value_numeric

number

Quantitative result.

value_string

string

Non-quantitative result (e.g. positive, negative, trace). Use when result is not numeric.

unit

string

Always required. Use the actual unit reported by the lab (UCUM recommended but not enforced).

abnormal_flag

string

H = high, L = low, N = normal, HH = critical high, LL = critical low.. One of: H, L, N, HH, LL

reference_range_low

number

Lab-specific reference range. Omit entirely if not known — do not send 0 or null as placeholder.

reference_range_high

number

Lab-specific reference range. Omit entirely if not known — do not send 0 or null as placeholder.

result_status

string

Finality of the result.. One of: final, preliminary, corrected

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.LAB_RESULTS,
    patient_id="your-patient-id",
    payload={
        "results": [...]
    },
)

Related types: Use vitals_measurement for vital signs, weight_measurement, spo2_reading or cgm_reading for device weight/SpO2/CGM, clinical_measurement for non-lab clinical measurements e.g. ejection fraction, procedure_result for pathology/procedure result narrative.

Vitals measurement

Type: vitals_measurement · Source: Python SDK / REST, App SDK (coming soon), Integration · Extensible Reserved for vital signs (BP, heart rate, SpO2, weight, temperature, respiratory rate) from any source: structured vitals from manual entry, EHR flowsheet, or connected device when not using device-specific events. Payload

measurements

object

required

Show fields

systolic_bp_mmhg

number | null

Systolic blood pressure in mmHg.

diastolic_bp_mmhg

number | null

Diastolic blood pressure in mmHg.

heart_rate_bpm

number | null

Beats per minute.

spo2_percent

number | null

Oxygen saturation percentage (0–100).. Minimum: 0. Maximum: 100

weight_kg

number | null

Kilograms.

temperature_celsius

number | null

Degrees Celsius.

respiratory_rate_bpm

number | null

Breaths per minute.

context

object

required

Show fields

position

string | null

Patient posture during measurement.. One of: sitting, standing, supine

fasting

boolean | null

Whether the patient was fasting at the time of measurement.

source

string | object

required

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

collection_datetime

string | null

required

ISO 8601 UTC datetime of measurement.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.VITALS_MEASUREMENT,
    patient_id="your-patient-id",
    payload={
        "measurements": {...},
        "context": {...},
        "source": "...",
        "collection_datetime": "..."
    },
)

Related types: Use lab_results for lab test results, clinical_measurement for non-vital clinical measurements like ejection fraction. Not intended for device-only weight/SpO2 if using weight_measurement or spo2_reading. vital_type inferred from populated fields.

Clinical note

Type: clinical_note · Source: Python SDK / REST, Integration · Extensible Reserved for provider-authored clinical notes with structured sections: progress notes, H&P, discharge summary, etc., with required sections[] (section_label, content); source (manual_entry, ehr_integration, hie_integration). Payload

note_type

string

required

Category of clinical note.. One of: progress_note, history_and_physical, social_history, family_history, medical_history, surgical_history, psychosocial_history, financial_history, discharge_summary, consultation_note, other

loinc_code

string

Recommended LOINC codes: 11506-3 (Progress note), 34117-2 (H&P), 11488-4 (Consultation note), 18842-5 (Discharge summary).

authored_by

object

Show fields

name

string

Author’s full name.

npi

string

Author’s National Provider Identifier.

role

string

Author’s clinical role.

authored_date

string

ISO 8601 date the note was authored.

encounter_id

string

Links this note to a care_encounter event.

source

string | object

required

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

sections

object[]

required

Show fields

section_label

string

required

CCDA-style section label (e.g. Chief Complaint, Assessment and Plan, Medications).

content

string

required

Full text content of this section.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.CLINICAL_NOTE,
    patient_id="your-patient-id",
    payload={
        "note_type": "progress_note",
        "source": "...",
        "sections": [...]
    },
)

Related types: Use conversation for patient-AI or patient-clinician conversation transcripts, unstructured_report for unstructured document blob. loinc_code optional for document type.

Clinical finding

Type: clinical_finding · Source: Python SDK / REST, Integration · Extensible Reserved for discrete clinical findings or observations from exam or assessment: findings[] with description (e.g. hepatomegaly, rash); body_site, severity, negation, recorded_at optional. Payload

findings

object[]

required

Show fields

description

string

required

Plain-language description of the finding (e.g. hepatomegaly, bilateral pitting oedema, macular rash).

body_site

string

Anatomic location of the finding (e.g. right upper quadrant, lower extremities).

severity

string

Severity descriptor (e.g. mild, moderate, severe).

negation

boolean

True when the finding is explicitly absent (e.g. no hepatomegaly). False or omit when the finding is present.

recorded_at

string

ISO 8601 UTC datetime when the finding was documented.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.CLINICAL_FINDING,
    patient_id="your-patient-id",
    payload={
        "findings": [...]
    },
)

Related types: Use clinical_measurement or lab_results for numeric measurements, imaging_result for imaging impressions, procedure_result for procedure outcomes.

Procedure result

Type: procedure_result · Source: Python SDK / REST, Integration · Extensible Reserved for pathology or procedure result narrative: results[] with result_type (pathology/procedure), test_name, value_string/value_numeric, specimen_site, performed_at; collection_datetime optional. Payload

results

object[]

required

Show fields

result_type

string

required

pathology = tissue/biopsy/histological result; procedure = interventional or diagnostic procedure outcome.. One of: pathology, procedure

loinc_code

string

LOINC code for the procedure if available.

test_name

string

required

Name of the procedure or test (e.g. colonoscopy, core needle biopsy, bronchoscopy).

value_string

string

Narrative or categorical result value.

value_numeric

number

Numeric result value when applicable.

unit

string

Unit for value_numeric when applicable.

specimen_site

string

Anatomic site of the specimen (e.g. liver, colon, left breast).

procedure_code

string

CPT or similar procedure code.

status

string

Result status (e.g. final, preliminary).

performed_at

string

ISO 8601 UTC datetime when the procedure was performed.

collection_datetime

string

ISO 8601 UTC datetime when the specimen was collected.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.PROCEDURE_RESULT,
    patient_id="your-patient-id",
    payload={
        "results": [...]
    },
)

Related types: Use lab_results for routine lab test results, imaging_result for imaging, genomic_variant for genomic variants.

Genomic variant

Type: genomic_variant · Source: Python SDK / REST, Integration · Extensible Reserved for genomic or molecular variants: variants[] with gene, variant_designation, variant_type, classification, actionability, reported_at. Payload

variants

object[]

required

Show fields

gene

string

required

Gene symbol (e.g. BRCA1, EGFR, KRAS, TP53, ALK).

variant_designation

string

Specific variant notation (e.g. p.Gly12Val, exon 19 deletion, G12C, c.1799T>A).

variant_type

string

Type of variant.. Example: missense, deletion, insertion

classification

string

Clinical significance classification.. Example: pathogenic, likely_pathogenic, VUS

actionability

string

Clinical actionability note (e.g. FDA-approved therapy available, clinical trial eligible).

reported_at

string

ISO 8601 UTC datetime when the variant was reported.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.GENOMIC_VARIANT,
    patient_id="your-patient-id",
    payload={
        "variants": [...]
    },
)

Related types: Use lab_results for other lab results, procedure_result for procedure or pathology. Not intended for condition/diagnosis (condition_updated).

Imaging result

Type: imaging_result · Source: Python SDK / REST, Integration · Extensible Reserved for imaging study findings: findings[] with modality (CT, MRI, PET, etc.), body_region, impression, finding_description, performed_at; study_date optional. Payload

findings

object[]

required

Show fields

modality

string

required

Imaging modality.. Example: CT, MRI, PET

body_region

string

Anatomic region imaged (e.g. chest, abdomen and pelvis, brain, left breast).

impression

string

Overall radiologist or cardiologist impression or conclusion.

finding_description

string

Detailed description of individual imaging findings.

performed_at

string

ISO 8601 UTC datetime when the imaging study was performed.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

study_date

string

ISO 8601 UTC date of the imaging study.

source

string | object

Who asserted this fact. Legacy string or structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.IMAGING_RESULT,
    patient_id="your-patient-id",
    payload={
        "findings": [...]
    },
)

Related types: Use clinical_finding for clinical findings from physical exam, procedure_result for procedure/pathology, lab_results for lab results.

Clinical measurement

Type: clinical_measurement · Source: Python SDK / REST, Integration · Extensible Reserved for non-lab clinical measurements from physical exam, imaging, or procedure: ejection fraction, tumour diameter, ECOG, BMI from visit, QTc, and similar exam/imaging/procedure-derived values. Payload

measurements

object[]

required

Show fields

measurement_type

string

required

Type of measurement.. Example: ejection_fraction, tumor_diameter, bmi

value_numeric

number

Numeric measurement value.

value_string

string

Descriptive value when not numeric (e.g. normal, mildly reduced).

unit

string

Measurement unit (e.g. %, mm, ms, kg/m2).

code_system

string

Coding system for the code field (e.g. LOINC, SNOMED).

code

string

Code for the measurement type in the specified code_system.

body_site

string

Anatomic site of measurement if applicable.

measured_at

string

ISO 8601 UTC datetime when the measurement was taken.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.CLINICAL_MEASUREMENT,
    patient_id="your-patient-id",
    payload={
        "measurements": [...]
    },
)

Not intended for lab test results (CBC, Hgb, Hct, Plt, glucose, BUN, creatinine, etc.); use lab_results for those.

Treatment response assessment

Type: treatment_response_assessment · Source: Python SDK / REST, Integration · Extensible Reserved for treatment response or disease response assessment: assessments[] with response_category (e.g. CR, PR, SD, PD), treatment_description, assessment_method, reference_date. Payload

assessments

object[]

required

Show fields

treatment_description

string

Description of the treatment being assessed (e.g. carboplatin + paclitaxel, pembrolizumab).

response_category

string

required

RECIST or clinical response category.. Example: CR, PR, SD

assessment_method

string

Assessment criteria used.. Example: RECIST 1.1, PERCIST, iRECIST

reference_date

string

ISO 8601 UTC date of the assessment.

recorded_at

string

ISO 8601 UTC datetime when the assessment was recorded.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Legacy string or structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.TREATMENT_RESPONSE_ASSESSMENT,
    patient_id="your-patient-id",
    payload={
        "assessments": [...]
    },
)

Related types: Use treatment_phase for treatment phase transition, imaging_result or procedure_result for imaging or procedure result. Not intended for condition/diagnosis (condition_updated).

Clinical plan item

Type: clinical_plan_item · Source: Python SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for discrete future plan items — things to remember that are coming up: orders, referrals, follow-up appointments, scheduled procedures (e.g. ‘colonoscopy 2026-03-01’, ‘referral to cardiology’). Payload

items

object[]

required

Show fields

action_type

string

required

Type of plan action.. Example: referral, order, follow_up

description

string

Description of the specific plan item (e.g. colonoscopy 2026-03-01, referral to cardiology for evaluation).

target_date

string

Expected date for the action (ISO 8601 date or datetime string).

status

string

Current status of the plan item. Use: active (pending/scheduled/upcoming), resolved (completed/done), inactive (on hold), entered_in_error (cancelled).. Example: active, resolved, inactive

recorded_at

string

ISO 8601 UTC datetime when this plan item was documented.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Legacy string or structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.CLINICAL_PLAN_ITEM,
    patient_id="your-patient-id",
    payload={
        "items": [...]
    },
)

Not intended for standing medication instructions or ongoing regimens (e.g. ‘continue letrozole as prescribed’); use medication_list_update or medication_adherence for medications. Do not use for general care instructions that are not discrete future actions.

Care encounter

Type: care_encounter · Source: Python SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for care encounters or visits: encounters[] with encounter_type, facility, department, start_date, end_date, primary_reason, recorded_at. Payload

encounters

object[]

required

Show fields

encounter_type

string

required

Type of care encounter.. Example: outpatient, inpatient, ED

facility

string

Name of the facility or institution where the encounter occurred.

department

string

Clinical department (e.g. oncology, cardiology, emergency).

start_date

string

ISO 8601 UTC datetime of encounter start.

end_date

string

ISO 8601 UTC datetime of encounter end.

primary_reason

string

Chief complaint or primary reason for the encounter.

outcome

string

Encounter outcome/disposition.

extensions

object

Open key/value bag for non-canonical encounter fields (lossy fields land here).

recorded_at

string

ISO 8601 UTC datetime when this encounter was recorded.

source

string | object

Who asserted this fact. Legacy string or structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.CARE_ENCOUNTER,
    patient_id="your-patient-id",
    payload={
        "encounters": [...]
    },
)

Related types: Use care_team for care team members, clinical_plan_item for future plan items or referrals, emergency_contact for emergency contact.

Unstructured report

Type: unstructured_report · Source: Python SDK / REST, Integration Reserved for unstructured document payloads to be processed by extraction: document_type + text (or content) for OCR/PDF/EHR export; document_type selects extraction config. Payload

document_type

string

required

Selects the extraction pipeline configuration to apply to the document.. One of: clinical_note, radiology_imaging, operative_procedure, cardiology_diagnostic, pathology_report, lab_report, genomic_report, discharge_summary, patient_intake, external_records_package

text

string

required

Raw document content as plain text. Use this or content, not both.

content

string

Alternative to text for raw body.

source

string | object

Who asserted this fact. Legacy string or structured Source object.

recorded_at

string

ISO 8601 UTC datetime when the document was received.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.UNSTRUCTURED_REPORT,
    patient_id="your-patient-id",
    payload={
        "document_type": "clinical_note",
        "text": "..."
    },
)

Related types: Use clinical_note for structured clinical notes with sections, conversation for conversation transcript. Use when the source is a raw document blob, not already-structured event data.

Procedure

Type: procedure · Source: Python SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for recording procedures the patient has undergone (surgical, interventional, diagnostic): procedures[] with procedure_name, cpt_code, snomed_code, performed_date, body_site, status, outcome, performing_provider. Payload

procedures

object[]

required

Show fields

procedure_name

string

required

Human-readable procedure name (e.g. lumpectomy, port-a-cath placement, colonoscopy).

cpt_code

string

CPT billing code (e.g. 19301).

snomed_code

string

SNOMED CT concept code.

performed_date

string

ISO 8601 UTC datetime the procedure was performed.

body_site

string

Anatomical location (e.g. left breast, colon).

status

string

Procedure status.. One of: completed, not_done, in_progress

outcome

string

Procedure outcome summary.

performing_provider

string

Provider or surgeon who performed the procedure.

notes

string

Additional clinical notes.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

action

string

Incremental action for this entry. Defaults to add; ‘remove’ deletes the matching entry.. One of: add, update, remove

entry_key

string

Optional explicit upsert/dedup identity for this entry; resolved server-side when omitted.

source

string | object

Who asserted this fact. Legacy string or structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.PROCEDURE,
    patient_id="your-patient-id",
    payload={
        "procedures": [...]
    },
)

Related types: Use procedure_result for procedure/pathology results or lab values, clinical_plan_item for scheduled future procedures, imaging_result for imaging study results. Maps to FHIR Procedure resource.

Care goal

Type: care_goal · Source: Python SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for structured care goals (clinical targets, behavioral targets, patient preferences): goals[] with goal_description, goal_type, target_value, target_date, current_status, achievement_status, priority, category, notes. Distinct from clinical_plan_item (discrete future actions) — care goals are standing measurable targets or aspirational outcomes. Maps to FHIR Goal resource. Payload

goals

object[]

required

Show fields

goal_description

string

required

Human-readable description of the goal (e.g. ‘Maintain HbA1c below 7%’, ‘Walk 7000 steps daily’).

goal_type

string

Category of goal.. One of: clinical_target, behavioral_target, patient_preference

target_value

string

Specific measurable target (e.g. ‘HbA1c < 7%’, ‘7000 steps/day’).

target_date

string

ISO 8601 UTC target achievement date.

current_status

string

Current status of the goal.. One of: active, completed, cancelled, on_hold

achievement_status

string

How much progress has been made toward the goal.. One of: in_progress, achieved, not_achieved, no_progress

priority

string

Goal priority.. One of: high, medium, low

Care action

Type: care_action · Source: Python SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for logging an alert or task surfaced for the care team: item_type (alert|task); title; description; summary; severity; status (active|inactive|resolved); entry_key as the upsert/dedup identity; resolved_by; linked_conversation_id / linked_encounter_id; source as a free-string generation source distilled into the entry’s sources. Payload

item_type

string

required

Discriminates an alert from a task.. One of: alert, task

title

string

required

Short headline for the alert/task.

description

string

Longer detail.

summary

string

One-line synthesized summary.

severity

string

e.g. low, medium, high, critical.

status

string

Lifecycle status (ClinicalStatus); defaults to active on log.. One of: active, inactive, resolved, remission, entered_in_error

entry_key

string

Upsert/dedup identity; defaults to title when omitted.

resolved_by

string

Who/what resolved the item.

linked_conversation_id

string

Originating/related conversation id.

linked_encounter_id

string

Originating/related encounter id.

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object with type, asserter, reference_id, source_system.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.CARE_ACTION,
    patient_id="your-patient-id",
    payload={
        "item_type": "alert",
        "title": "..."
    },
)

Related types: Use condition for clinical conditions, symptom_report for symptoms.

​Lab results

​Vitals measurement

​Clinical note

​Clinical finding

​Procedure result

​Genomic variant

​Imaging result

​Clinical measurement

​Treatment response assessment

​Clinical plan item

​Care encounter

​Unstructured report

​Procedure

​Care goal

​Care action

Lab results

Vitals measurement

Clinical note

Clinical finding

Procedure result

Genomic variant

Imaging result

Clinical measurement

Treatment response assessment

Clinical plan item

Care encounter

Unstructured report

Procedure

Care goal

Care action