> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olira.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Profile
> Stable patient facts: demographics, conditions, care team, insurance, allergies, and related records. 13 log types with payload schemas and examples.
Stable patient facts: demographics, conditions, care team, insurance, allergies, and related records. Submit these via `POST /v1/logs/batch` or the [Python SDK](/reference/sdk); see [How logs work](/send-data/how-logs-work) for submission fields and the difference between **lifecycle-tracked** and point-in-time log types.
## Demographics
**Type:** `demographics` · **Source:** Python 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**
Full name of the patient.
Date of birth in ISO 8601 date format (YYYY-MM-DD).
Biological sex or sex assigned at birth.
Patient's marital status (e.g. single, married, widowed).
Street address.
City.
State or region.
Postal/ZIP code.
Country.
Contact phone number (legacy scalar; superseded by telecom). Still accepted via computed back-read.
Contact email address (legacy scalar; superseded by telecom). Still accepted via computed back-read.
ContactPoint list (phone/email/...); supersedes scalar phone/email.
ContactPoint system (e.g. phone, email, fax, sms).
The contact value.
ContactPoint use (e.g. home, work, mobile).
Preference order; 1 = most preferred.
Address list; supersedes scalar address.
Street address.
City.
State or region.
Postal/ZIP code.
Country.
External identifiers (e.g. MRN).
Identifier system (e.g. MRN, SSN, MBI).
The identifier value.
Identifier type label, e.g. 'MRN', 'NPI', 'MBI'.
Preferred language as BCP 47 tag (e.g. en-US, es-MX).
Patient's self-reported ethnicity.
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).
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.DEMOGRAPHICS,
patient_id="your-patient-id",
payload={},
)
```
```http HTTP theme={null}
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`](/reference/log-types/profile#care-team) for care team providers, [`emergency_contact`](/reference/log-types/profile#emergency-contact) for emergency contact. Not intended for clinical or event data.
## Condition
**Type:** `condition` · **Source:** Python 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**
Primary/legacy condition name (e.g. breast cancer, COPD, type 2 diabetes).
Disease stage or grade (e.g. Stage III, T2N1M0, Grade 2).
ISO 8601 datetime of diagnosis.
ICD-10-CM codes for the condition.
Current clinical status of the condition.. One of: `active`, `resolved`, `remission`, `inactive`, `entered_in_error`
SNOMED CT concept code for coded interoperability.
Date of symptom onset (may predate formal diagnosis).
Date the condition was recorded in the source system.
True when this is the patient's primary/index condition.
Multi-condition payload; each entry maps to ConditionEntry.
Condition name (mirrors top-level disease\_type).
Disease stage or grade (e.g. Stage III, T2N1M0, Grade 2).
ISO 8601 datetime of diagnosis.
ICD-10-CM codes for this condition.
Current clinical status of this condition.. One of: `active`, `resolved`, `remission`, `inactive`, `entered_in_error`
SNOMED CT concept code for coded interoperability.
Date of symptom onset (may predate formal diagnosis).
Date this condition was recorded in the source system.
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).
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.CONDITION,
patient_id="your-patient-id",
payload={},
)
```
```http HTTP theme={null}
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`](/reference/log-types/profile#treatment-phase) for treatment phase transitions, [`procedure`](/reference/log-types/lab-clinical#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:** Python 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**
Patient's preferred reading or health literacy level (e.g. basic, intermediate, advanced).
Preferred communication tone (e.g. formal, conversational, supportive).
Dietary restrictions or preferences (e.g. vegetarian, low-sodium, gluten-free).
Self-reported comfort with digital tools (e.g. low, moderate, high).
Self-reported typical energy level.
Symptoms the patient wants help tracking or managing.
Health metrics or topics the patient wants to monitor.
Whether push notifications are enabled.
Whether email notifications are enabled.
Whether SMS notifications are enabled.
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).
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.PREFERENCES,
patient_id="your-patient-id",
payload={},
)
```
```http HTTP theme={null}
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:** Python SDK / REST · **Extensible**
Reserved for healthcare proxy or emergency contact (stable profile): name, relationship, phone, email; patch style.
**Payload**
Full name of the emergency contact or healthcare proxy.
Relationship to the patient (e.g. spouse, parent, sibling, friend).
Contact phone number.
Contact email address.
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).
Incremental action for this entry. Defaults to add; 'remove' deletes the matching entry.. One of: `add`, `update`, `remove`
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.EMERGENCY_CONTACT,
patient_id="your-patient-id",
payload={},
)
```
```http HTTP theme={null}
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`](/reference/log-types/profile#care-team) for care team providers, [`demographics`](/reference/log-types/profile#demographics) for demographics.
## Care team
**Type:** `care_team` · **Source:** Python SDK / REST, Integration · **Extensible**
Reserved for care team providers (stable profile): members\[] with action (add/update/remove), role, name, npi, organization.
**Payload**
Whether this member is being added, updated, or removed from the care team.. One of: `add`, `update`, `remove`
Clinical role of the provider (e.g. oncologist, cardiologist, primary\_care, nurse, pharmacist).
Provider's full name.
Provider's National Provider Identifier.
Healthcare organization or practice the provider is affiliated with.
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).
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.CARE_TEAM,
patient_id="your-patient-id",
payload={
"members": [...]
},
)
```
```http HTTP theme={null}
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`](/reference/log-types/lab-clinical#care-encounter) for care encounters or visits, [`emergency_contact`](/reference/log-types/profile#emergency-contact) for emergency contact, [`clinical_plan_item`](/reference/log-types/lab-clinical#clinical-plan-item) for plan items or referrals.
## Insurance
**Type:** `insurance` · **Source:** Python SDK / REST · **Extensible**
Reserved for payer and plan (stable profile): payer, plan\_name, member\_id, group\_id; patch style.
**Payload**
Name of the insurance company or payer.
Name of the insurance plan.
Patient's member ID on the insurance plan.
Group number associated with the insurance plan.
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).
Coverage rank; identity discriminator for the multi-entry insurance module. Omit for a single/primary plan.. One of: `primary`, `secondary`
Incremental action for this entry. Defaults to add; 'remove' deletes the matching entry.. One of: `add`, `update`, `remove`
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.INSURANCE,
patient_id="your-patient-id",
payload={},
)
```
```http HTTP theme={null}
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`](/reference/log-types/profile#pharmacy) for pharmacy. Not intended for other profile or event data.
## Social determinants
**Type:** `social_determinants` · **Source:** Python 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**
Patient's living arrangement (e.g. lives alone, lives with family, assisted living).
Availability and nature of social support (e.g. strong family support, limited support network).
Access to transportation for healthcare and daily needs (e.g. has car, relies on public transport, no access).
Employment status (e.g. employed full-time, unemployed, retired, on disability).
Stability of housing situation (e.g. stable, at risk, unhoused).
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).
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.SOCIAL_DETERMINANTS,
patient_id="your-patient-id",
payload={},
)
```
```http HTTP theme={null}
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`](/reference/log-types/profile#demographics) for demographics, [`care_team`](/reference/log-types/profile#care-team) for care team. Not intended for clinical findings or events.
## Pharmacy
**Type:** `pharmacy` · **Source:** Python SDK / REST · **Extensible**
Reserved for the patient's pharmacy contact (stable profile): name, address, phone; patch style.
**Payload**
Name of the patient's preferred pharmacy.
Street address.
City.
State or region.
Postal/ZIP code.
Country.
Pharmacy contact phone number.
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).
Pharmacy type; identity discriminator for the multi-entry pharmacy module.. One of: `retail`, `mail_order`
Incremental action for this entry. Defaults to add; 'remove' deletes the matching entry.. One of: `add`, `update`, `remove`
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.PHARMACY,
patient_id="your-patient-id",
payload={},
)
```
```http HTTP theme={null}
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`](/reference/log-types/medication#medication-list-update) for medications list, [`insurance`](/reference/log-types/profile#insurance) for insurance.
## Treatment phase
**Type:** `treatment_phase` · **Source:** Python 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**
Prior treatment phase for audit purposes. Omit if first phase transition.
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`
ISO 8601 date when the new phase becomes effective.
clinician = explicit provider decision; system = triggered automatically by clinical logic.. One of: `clinician`, `system`
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
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"
},
)
```
```http HTTP theme={null}
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`](/reference/log-types/lab-clinical#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:** Python 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**
Allergen substance or product name (e.g. penicillin, shellfish, peanuts, latex).
Category of the allergen.. One of: `food`, `medication`, `environment`, `biologic`, `other`
Potential severity of a future reaction.. One of: `high`, `low`, `unable_to_assess`
Current clinical status of the allergy.. One of: `active`, `inactive`, `resolved`
Observed or reported reactions (e.g. anaphylaxis, hives, rash).
SNOMED CT code for the allergen substance.
ISO 8601 datetime when this allergy was first recorded.
Incremental action for this entry. Defaults to add if omitted.. One of: `add`, `update`, `remove`
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).
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.ALLERGY_INTOLERANCE,
patient_id="your-patient-id",
payload={
"allergies": [...]
},
)
```
```http HTTP theme={null}
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`](/reference/log-types/medication#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:** Python 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**
Vaccine product name (e.g. Moderna COVID-19 mRNA, Fluzone High-Dose).
CDC CVX code (e.g. 208 for Moderna COVID-19).
Vaccine lot number.
ISO 8601 UTC datetime the vaccine was administered.
Whether the dose was administered.. One of: `completed`, `not_done`
Dose sequence number in the series (1, 2, booster…).
Immunization series name (e.g. Primary, Booster).
Provider or facility that administered the vaccine.
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).
Incremental action for this entry. Defaults to add; 'remove' deletes the matching entry.. One of: `add`, `update`, `remove`
Optional explicit upsert/dedup identity for this entry; resolved server-side when omitted.
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.IMMUNIZATION,
patient_id="your-patient-id",
payload={
"immunizations": [...]
},
)
```
```http HTTP theme={null}
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`](/reference/log-types/medication#medication-list-update) for medication administration, [`allergy_intolerance`](/reference/log-types/profile#allergy-/-intolerance) for allergic reactions to vaccines, [`lab_results`](/reference/log-types/lab-clinical#lab-results) for lab serology results. Maps to FHIR Immunization resource.
## Device
**Type:** `device` · **Source:** Python 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**
Device name or model (e.g. Medtronic MRI SureScan ICD, Dexcom G7).
Device category.. One of: `implanted`, `external`, `wearable`
Unique Device Identifier from the device label.
Device manufacturer.
ISO 8601 UTC datetime of implantation.
ISO 8601 UTC datetime of removal (if removed).
Anatomical location (e.g. left chest wall, abdomen).
Current device status.. One of: `active`, `inactive`, `removed`
Additional notes.
Incremental action for this entry. Defaults to add if omitted.. One of: `add`, `update`, `remove`
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).
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.DEVICE,
patient_id="your-patient-id",
payload={
"devices": [...]
},
)
```
```http HTTP theme={null}
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:** Python 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**
Relationship to patient (e.g. mother, father, sibling, maternal\_grandmother).
Condition name (e.g. breast cancer, colorectal cancer, type 2 diabetes).
SNOMED CT code.
ICD-10 code.
Age of onset for this family member.
Whether the family member is deceased.
Free-text notes about this family member's history.
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).
Incremental action for this entry. Defaults to add; 'remove' deletes the matching entry.. One of: `add`, `update`, `remove`
Optional explicit upsert/dedup identity for this entry; resolved server-side when omitted.
Who asserted this fact. Legacy string or structured Source object.
**Example**
```python Python theme={null}
import olira
from olira import OliraLogType
olira.log(
log_type=OliraLogType.FAMILY_HISTORY,
patient_id="your-patient-id",
payload={
"relatives": [...]
},
)
```
```http HTTP theme={null}
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`](/reference/log-types/profile#condition) for patient's own diagnoses, [`genomic_variant`](/reference/log-types/lab-clinical#genomic-variant) for genetic variant results. Maps to FHIR FamilyMemberHistory resource.