SDK
Exam
An exam as an application wants it: the index, the decrypted record and its summary.
On this page
class
Signature #
class Exam(*, index: DocumentIndex, version_id: str | None = None, draft_rev: int | None = None, record: ExamRecord, summary: ExamSummary | None = None)Bases: BaseModel
An exam as an application wants it: the index, the decrypted record and its summary.
Members #
record: ExamRecord #
attribute
summary: ExamSummary | 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.
patient_id: str | None #
property
The exam's patient, read from clear `meta` (`docs/PROTOCOL.md §8`) — never guessed from content.
report_status: str | None #
property
`draft` or `published`, from clear `meta`; `None` when never set.
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.