SDK

PersonalIdentifier

An identity document (CPF, RG, passport…) whose `value` is sealed by the vault, not by this SDK. Opening one is audited server-side, which is why the value is `secret:v1:…` sealed material rather than plain text. The external API has no route to seal a new one yet: records read from the vault carry them through untouched, and a caller-built record must already hold sealed values. For a plain id from another system, use `PatientRecord.external_id`.

On this page

class

Signature #

class PersonalIdentifier(*, name: str, value: str)

Bases: BaseModel

An identity document (CPF, RG, passport…) whose value is sealed by the vault, not by this SDK.

Opening one is audited server-side, which is why the value is secret:v1:… sealed material rather than plain text. The external API has no route to seal a new one yet: records read from the vault carry them through untouched, and a caller-built record must already hold sealed values. For a plain id from another system, use PatientRecord.external_id.

Members #

name: str #

attribute

value: str #

attribute