Lab & clinical

Lab results, clinical notes, imaging, procedures, encounters, and other clinical observations. Submit these via POST /v1/logs/batch or the 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: 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

string | null

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

string | null

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

string

ISO 8601 UTC datetime when the specimen was collected.

string | null

NPI of the ordering provider.

object | null

Show fields

string

Name of the laboratory that performed the tests.

string

CLIA certificate number of the performing lab.

object[]

required

Show fields

string

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

string

Required when loinc_code is absent.

string

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

string

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

number

Quantitative result.

string

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

string

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

string

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

number

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

number

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

string

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

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).

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "lab_results",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object

required

Show fields

number | null

Systolic blood pressure in mmHg.

number | null

Diastolic blood pressure in mmHg.

number | null

Beats per minute.

number | null

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

number | null

Kilograms.

number | null

Degrees Celsius.

number | null

Breaths per minute.

object

required

Show fields

string | null

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

boolean | null

Whether the patient was fasting at the time of measurement.

string | object

required

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

string | null

required

ISO 8601 UTC datetime of measurement.

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": "..."
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "vitals_measurement",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

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

string

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

object

Show fields

string

Author’s full name.

string

Author’s National Provider Identifier.

string

Author’s clinical role.

string

ISO 8601 date the note was authored.

string

Links this note to a care_encounter event.

string | object

required

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

object[]

required

Show fields

string

required

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

string

required

Full text content of this section.

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "clinical_note",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

required

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

string

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

string

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

boolean

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

string

ISO 8601 UTC datetime when the finding was documented.

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).

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "clinical_finding",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

required

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

string

LOINC code for the procedure if available.

string

required

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

string

Narrative or categorical result value.

number

Numeric result value when applicable.

string

Unit for value_numeric when applicable.

string

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

string

CPT or similar procedure code.

string

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

string

ISO 8601 UTC datetime when the procedure was performed.

string

ISO 8601 UTC datetime when the specimen was collected.

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).

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "procedure_result",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: SDK / REST, Integration · Extensible Reserved for genomic or molecular variants: variants[] with gene, variant_designation, variant_type, classification, actionability, reported_at. Payload

object[]

required

Show fields

string

required

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

string

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

string

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

string

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

string

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

string

ISO 8601 UTC datetime when the variant was reported.

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).

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "genomic_variant",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

required

Imaging modality.. Example: CT, MRI, PET

string

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

string

Overall radiologist or cardiologist impression or conclusion.

string

Detailed description of individual imaging findings.

string

ISO 8601 UTC datetime when the imaging study was performed.

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).

string

ISO 8601 UTC date of the imaging study.

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "imaging_result",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

required

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

number

Numeric measurement value.

string

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

string

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

string

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

string

Code for the measurement type in the specified code_system.

string

Anatomic site of measurement if applicable.

string

ISO 8601 UTC datetime when the measurement was taken.

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).

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "clinical_measurement",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

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

string

required

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

string

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

string

ISO 8601 UTC date of the assessment.

string

ISO 8601 UTC datetime when the assessment was recorded.

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).

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "treatment_response_assessment",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

required

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

string

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

string

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

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

string

ISO 8601 UTC datetime when this plan item was documented.

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).

string

ISO 8601 UTC datetime when the plan item was opened or initiated.

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "clinical_plan_item",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

required

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

string

Name of the facility or institution where the encounter occurred.

string

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

string

ISO 8601 UTC datetime of encounter start.

string

ISO 8601 UTC datetime of encounter end.

string

Chief complaint or primary reason for the encounter.

string

Encounter outcome/disposition.

object

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

string

ISO 8601 UTC datetime when this encounter was recorded.

string

Lifecycle status of the encounter. RC VCC interactions are logged only after completion, so mapped ingest events use resolved.. Example: active, resolved, inactive

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "care_encounter",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

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

string

required

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

string

Alternative to text for raw body.

string | object

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

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": "..."
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "unstructured_report",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

required

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

string

CPT billing code (e.g. 19301).

string

SNOMED CT concept code.

string

ISO 8601 UTC datetime the procedure was performed.

string

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

string

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

string

Procedure outcome summary.

string

Provider or surgeon who performed the procedure.

string

Additional clinical notes.

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).

string

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

string

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

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": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "procedure",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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: 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

object[]

required

Show fields

string

required

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

string

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

string

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

string

ISO 8601 UTC target achievement date.

string

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

string

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

string

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

string

Domain category (e.g. dietary, physical-activity, lab-value, symptom-management).

string

Additional clinical notes.

string

ISO 8601 UTC datetime when the goal was recorded.

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).

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_GOAL,
    patient_id="your-patient-id",
    payload={
        "goals": [...]
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "care_goal",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {
        "goals": [...]
    }
    }
  ]
}

Care action

Type: care_action · Source: 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

string

required

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

string

required

Short headline for the alert/task.

string

Longer detail.

string

One-line synthesized summary.

string

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

string

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

string

Upsert/dedup identity; defaults to title when omitted.

string

Who/what resolved the item.

string

Originating/related conversation id.

string

Originating/related encounter id.

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.

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": "..."
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "care_action",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "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