diagnos

SDK

PatientSummary

The plaintext of a patient's `encrypted_index`: what a list shows without opening any version. The SDK derives it from the record on every write (plus `tags`, which are not a record field); it never carries identity documents, because opening the summary is not audited.

Published from commit 4eb9d27
On this page

class

Signature # 

class PatientSummary(*, display_name: str | None = None, legal_name: str | None = None, external_id: str | None = None, birth_date: str | None = None, tags: list[str] = [])

Bases: BaseModel

The plaintext of a patient's encrypted_index: what a list shows without opening any version.

The SDK derives it from the record on every write (plus tags, which are not a record field); it never carries identity documents, because opening the summary is not audited.

Members #

display_name: str | None = None #

attribute

attribute

external_id: str | None = None #

attribute

birth_date: str | None = None #

attribute

tags: list[str] = [] #

attribute

of(record: PatientRecord, tags: Sequence[str]) -> PatientSummary #

method

The summary the web app would write for `record`.