SDK

Patient

A patient as an application wants it: the index, the decrypted record and its summary.

On this page

class

Signature #

class Patient(*, index: DocumentIndex, version_id: str | None = None, draft_rev: int | None = None, record: PatientRecord, summary: PatientSummary | None = None)

Bases: BaseModel

A patient as an application wants it: the index, the decrypted record and its summary.

Members #

record: PatientRecord #

attribute

summary: PatientSummary | None = None #

attribute

index: DocumentIndex #

attribute

version_id: str | None = None #

attribute

The committed version the record came from; `None` when it came from the draft head.

draft_rev: int | None = None #

attribute

The draft revision the record came from, when the draft was newer.

tags: list[str] #

property

The sealed list/search tags (`summary.tags`).

id: str #

property

The document id — shorthand for `index.document_id`.

updated_at: str #

property

Shorthand for `index.updated_at`.

security_group_id: str #

property

Shorthand for `index.security_group_id`.

from_draft: bool #

property

`True` when the record is the (newer) draft head, not a committed version.