Profile - Olira

Stable patient facts: demographics, conditions, care team, insurance, allergies, and related records. 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.

Demographics

Type: demographics · Source: SDK / REST, Integration · Extensible Reserved for patient identity and contact (stable profile): name, dob, sex, marital_status, address, phone, email, language, ethnicity; patch style. Payload

string

Full name of the patient.

string

Date of birth in ISO 8601 date format (YYYY-MM-DD).

string

Biological sex or sex assigned at birth.

string

Patient’s marital status (e.g. single, married, widowed).

object

Show fields

string

Street address.

string

City.

string

State or region.

string

Postal/ZIP code.

string

Country.

string

Contact phone number (legacy scalar; superseded by telecom). Still accepted via computed back-read.

string

Contact email address (legacy scalar; superseded by telecom). Still accepted via computed back-read.

object[]

ContactPoint list (phone/email/…); supersedes scalar phone/email.

Show fields

string

ContactPoint system (e.g. phone, email, fax, sms).

string

The contact value.

string

ContactPoint use (e.g. home, work, mobile).

integer

Preference order; 1 = most preferred.

object[]

Address list; supersedes scalar address.

Show fields

string

Street address.

string

City.

string

State or region.

string

Postal/ZIP code.

string

Country.

object[]

External identifiers (e.g. MRN).

Show fields

string

Identifier system (e.g. MRN, SSN, MBI).

string

required

The identifier value.

string

Identifier type label, e.g. ‘MRN’, ‘NPI’, ‘MBI’.

string

Preferred language as BCP 47 tag (e.g. en-US, es-MX).

string

Patient’s self-reported ethnicity.

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.DEMOGRAPHICS,
    patient_id="your-patient-id",
    payload={},
)

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

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

Related types: Use care_team for care team providers, emergency_contact for emergency contact. Not intended for clinical or event data.

Condition

Type: condition · Source: SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for documenting any condition in the patient’s medical history, covering both currently active and past/resolved conditions: disease_type = diagnosis or condition name (e.g. breast cancer, COPD, diabetes, UTI); stage = disease stage or grade; clinical_status = active|resolved|remission|inactive|entered_in_error; snomed_code for coded interoperability; icd10_codes[]; conditions[] for multi-condition payloads. Payload

string

Primary/legacy condition name (e.g. breast cancer, COPD, type 2 diabetes).

string

Disease stage or grade (e.g. Stage III, T2N1M0, Grade 2).

string

ISO 8601 datetime of diagnosis.

string[]

ICD-10-CM codes for the condition.

string

Current clinical status of the condition.. One of: active, resolved, remission, inactive, entered_in_error

string

SNOMED CT concept code for coded interoperability.

string

Date of symptom onset (may predate formal diagnosis).

string

Date the condition was recorded in the source system.

boolean

True when this is the patient’s primary/index condition.

object[]

Multi-condition payload; each entry maps to ConditionEntry.

Show fields

string

Condition name (mirrors top-level disease_type).

string

Disease stage or grade (e.g. Stage III, T2N1M0, Grade 2).

string

ISO 8601 datetime of diagnosis.

string[]

ICD-10-CM codes for this condition.

string

Current clinical status of this condition.. One of: active, resolved, remission, inactive, entered_in_error

string

SNOMED CT concept code for coded interoperability.

string

Date of symptom onset (may predate formal diagnosis).

string

Date this condition was recorded in the 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).

string | object

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

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.CONDITION,
    patient_id="your-patient-id",
    payload={},
)

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

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

Related types: Use treatment_phase for treatment phase transitions, procedure for procedure outcomes. Not intended for transient symptoms (symptom_reported). Supersedes condition_updated with expanded coverage of all clinical statuses.

Preferences

Type: preferences · Source: SDK / REST · Extensible Reserved for communication and lifestyle preferences (stable profile): reading_level, tone, dietary_preferences, comfort_with_technology, energy_level, symptoms_need_help_managing, things_to_track, notification_preferences; patch style. Payload

string

Patient’s preferred reading or health literacy level (e.g. basic, intermediate, advanced).

string

Preferred communication tone (e.g. formal, conversational, supportive).

string[]

Dietary restrictions or preferences (e.g. vegetarian, low-sodium, gluten-free).

string

Self-reported comfort with digital tools (e.g. low, moderate, high).

string

Self-reported typical energy level.

string[]

Symptoms the patient wants help tracking or managing.

string[]

Health metrics or topics the patient wants to monitor.

object

Show fields

boolean

Whether push notifications are enabled.

boolean

Whether email notifications are enabled.

boolean

Whether SMS notifications are enabled.

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.PREFERENCES,
    patient_id="your-patient-id",
    payload={},
)

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

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

Not intended for clinical data; care plan or medications.

Emergency contact

Type: emergency_contact · Source: SDK / REST · Extensible Reserved for healthcare proxy or emergency contact (stable profile): name, relationship, phone, email; patch style. Payload

string

Full name of the emergency contact or healthcare proxy.

string

Relationship to the patient (e.g. spouse, parent, sibling, friend).

string

Contact phone number.

string

Contact email address.

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 | object

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

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.EMERGENCY_CONTACT,
    patient_id="your-patient-id",
    payload={},
)

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

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

Related types: Use care_team for care team providers, demographics for demographics.

Care team

Type: care_team · Source: SDK / REST, Integration · Extensible Reserved for care team providers (stable profile): members[] with action (add/update/remove), role, name, npi, organization. Payload

object[]

required

Show fields

string

required

Whether this member is being added, updated, or removed from the care team.. One of: add, update, remove

string

required

Clinical role of the provider (e.g. oncologist, cardiologist, primary_care, nurse, pharmacist).

string

Provider’s full name.

string

Provider’s National Provider Identifier.

string

Healthcare organization or practice the provider is affiliated with.

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

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

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

Related types: Use care_encounter for care encounters or visits, emergency_contact for emergency contact, clinical_plan_item for plan items or referrals.

Insurance

Type: insurance · Source: SDK / REST · Extensible Reserved for payer and plan (stable profile): payer, plan_name, member_id, group_id; patch style. Payload

string

Name of the insurance company or payer.

string

Name of the insurance plan.

string

Patient’s member ID on the insurance plan.

string

Group number associated with the insurance plan.

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

Coverage rank; identity discriminator for the multi-entry insurance module. Omit for a single/primary plan.. One of: primary, secondary

string

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

string | object

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

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.INSURANCE,
    patient_id="your-patient-id",
    payload={},
)

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

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

Related types: Use pharmacy for pharmacy. Not intended for other profile or event data.

Type: social_determinants · Source: SDK / REST, Integration · Extensible Reserved for social determinants of health (stable profile): living_situation, support_system, transportation_access, employment_status, housing_stability; patch style. Payload

string

Patient’s living arrangement (e.g. lives alone, lives with family, assisted living).

string

Availability and nature of social support (e.g. strong family support, limited support network).

string

Access to transportation for healthcare and daily needs (e.g. has car, relies on public transport, no access).

string

Employment status (e.g. employed full-time, unemployed, retired, on disability).

string

Stability of housing situation (e.g. stable, at risk, unhoused).

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.SOCIAL_DETERMINANTS,
    patient_id="your-patient-id",
    payload={},
)

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

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

Related types: Use demographics for demographics, care_team for care team. Not intended for clinical findings or events.

Pharmacy

Type: pharmacy · Source: SDK / REST · Extensible Reserved for the patient’s pharmacy contact (stable profile): name, address, phone; patch style. Payload

string

Name of the patient’s preferred pharmacy.

object

Show fields

string

Street address.

string

City.

string

State or region.

string

Postal/ZIP code.

string

Country.

string

Pharmacy contact phone number.

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

Pharmacy type; identity discriminator for the multi-entry pharmacy module.. One of: retail, mail_order

string

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

string | object

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

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.PHARMACY,
    patient_id="your-patient-id",
    payload={},
)

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

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

Related types: Use medication_list_update for medications list, insurance for insurance.

Treatment phase

Type: treatment_phase · Source: SDK / REST, Integration · Lifecycle-tracked Reserved for treatment phase or care intent transition: new_phase (active_treatment, surveillance, palliative, remission), effective_date, changed_by; triggers downstream effects. Payload

string

Prior treatment phase for audit purposes. Omit if first phase transition.

string

required

active_treatment = receiving curative or life-prolonging treatment; surveillance = monitoring after treatment with no active disease; palliative = symptom management and comfort focus; remission = no detectable disease.. One of: active_treatment, surveillance, palliative, remission

string

required

ISO 8601 date when the new phase becomes effective.

string

required

clinician = explicit provider decision; system = triggered automatically by clinical logic.. One of: clinician, system

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_PHASE,
    patient_id="your-patient-id",
    payload={
        "new_phase": "active_treatment",
        "effective_date": "...",
        "changed_by": "clinician"
    },
)

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

{
  "logs": [
    {
      "log_type": "treatment_phase",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {
        "new_phase": "active_treatment",
        "effective_date": "...",
        "changed_by": "clinician"
    }
    }
  ]
}

Related types: Use treatment_response_assessment for response assessment like RECIST. Not intended for condition or diagnosis (condition_updated); medication or plan changes.

Allergy / intolerance

Type: allergy_intolerance · Source: SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for known allergies and intolerances (stable profile): allergies[] with allergen, category (food|medication|environment|biologic|other), criticality (high|low|unable_to_assess), clinical_status, reactions[], snomed_code, recorded_date. Use action=add|update|remove per entry for incremental updates. Payload

object[]

required

Show fields

string

required

Allergen substance or product name (e.g. penicillin, shellfish, peanuts, latex).

string

Category of the allergen.. One of: food, medication, environment, biologic, other

string

Potential severity of a future reaction.. One of: high, low, unable_to_assess

string

Current clinical status of the allergy.. One of: active, inactive, resolved

string[]

Observed or reported reactions (e.g. anaphylaxis, hives, rash).

string

SNOMED CT code for the allergen substance.

string

ISO 8601 datetime when this allergy was first recorded.

string

Incremental action for this entry. Defaults to add if omitted.. One of: add, update, remove

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

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

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

Related types: Use medication_list_update for medication interactions. Not intended for adverse drug reactions without allergy status; transient side effects (symptom_reported). Maps to FHIR AllergyIntolerance resource.

Immunization

Type: immunization · Source: SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for vaccination and immunization records (stable profile): immunizations[] with vaccine_name, cvx_code, administered_date, status, dose_number, series_name, administered_by. Payload

object[]

required

Show fields

string

required

Vaccine product name (e.g. Moderna COVID-19 mRNA, Fluzone High-Dose).

string

CDC CVX code (e.g. 208 for Moderna COVID-19).

string

Vaccine lot number.

string

ISO 8601 UTC datetime the vaccine was administered.

string

Whether the dose was administered.. One of: completed, not_done

integer

Dose sequence number in the series (1, 2, booster…).

string

Immunization series name (e.g. Primary, Booster).

string

Provider or facility that administered the vaccine.

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

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

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

Related types: Use medication_list_update for medication administration, allergy_intolerance for allergic reactions to vaccines, lab_results for lab serology results. Maps to FHIR Immunization resource.

Device

Type: device · Source: SDK / REST · Lifecycle-tracked · Extensible Reserved for implanted and medical devices (stable profile): devices[] with device_name, device_type (implanted|external|wearable), udi, manufacturer, implanted_date, removed_date, body_site, status. Use action=add|update|remove per entry for lifecycle management. Payload

object[]

required

Show fields

string

required

Device name or model (e.g. Medtronic MRI SureScan ICD, Dexcom G7).

string

Device category.. One of: implanted, external, wearable

string

Unique Device Identifier from the device label.

string

Device manufacturer.

string

ISO 8601 UTC datetime of implantation.

string

ISO 8601 UTC datetime of removal (if removed).

string

Anatomical location (e.g. left chest wall, abdomen).

string

Current device status.. One of: active, inactive, removed

string

Additional notes.

string

Incremental action for this entry. Defaults to add if omitted.. One of: add, update, remove

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

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

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

Not intended for consumer wearables syncing data streams (passive SDK); care team equipment; home monitoring interpreted data (vitals_updated). Internal-only: not produced by the FHIR bundle absorber; not submittable via public SDK. Use for server-side or trusted pipelines only.

Family history

Type: family_history · Source: SDK / REST, Integration · Lifecycle-tracked · Extensible Reserved for family medical history by relative (stable profile): relatives[] with relationship, conditions[] (each with condition_name, snomed_code, icd10_code, onset_age), deceased, notes. Entries are upserted by relationship — sending a relative again updates their conditions list. Payload

object[]

required

Show fields

string

required

Relationship to patient (e.g. mother, father, sibling, maternal_grandmother).

object[]

Show fields

string

required

Condition name (e.g. breast cancer, colorectal cancer, type 2 diabetes).

string

SNOMED CT code.

string

ICD-10 code.

integer

Age of onset for this family member.

boolean

Whether the family member is deceased.

string

Free-text notes about this family member’s history.

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

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

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

Related types: Use condition for patient’s own diagnoses, genomic_variant for genetic variant results. Maps to FHIR FamilyMemberHistory resource.

​Demographics

​Condition

​Preferences

​Emergency contact

​Care team

​Insurance

​Social determinants

​Pharmacy

​Treatment phase

​Allergy / intolerance

​Immunization

​Device

​Family history

Demographics

Condition

Preferences

Emergency contact

Care team

Insurance

Social determinants

Pharmacy

Treatment phase

Allergy / intolerance

Immunization

Device

Family history