care.emr.resources.patient_identifier.spec module¶

class PatientIdentifierUse(*values)¶

Bases: str, Enum

usual = 'usual'¶

official = 'official'¶

temp = 'temp'¶

secondary = 'secondary'¶

old = 'old'¶

class PatientIdentifierStatus(*values)¶

Bases: str, Enum

draft = 'draft'¶

active = 'active'¶

inactive = 'inactive'¶

class PatientIdentifierRetrieveConfig(*, retrieve_with_dob: bool = False, retrieve_with_year_of_birth: bool = False, retrieve_with_otp: bool = False, retrieve_partial_search: bool = False)¶

Bases: BaseModel

retrieve_with_dob: bool¶

retrieve_with_year_of_birth: bool¶

retrieve_with_otp: bool¶

retrieve_partial_search: bool¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class IdentifierConfig(*, use: PatientIdentifierUse, description: str = '', system: str, required: bool, unique: bool, regex: str, display: str, retrieve_config: PatientIdentifierRetrieveConfig = {}, default_value: str | None = None, auto_maintained: bool = False)¶

Bases: BaseModel

use: PatientIdentifierUse¶

description: str¶

system: str¶

required: bool¶

unique: bool¶

regex: str¶

display: str¶

retrieve_config: PatientIdentifierRetrieveConfig¶

default_value: str | None¶

auto_maintained: bool¶

classmethod validate_default_value(v)¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class BasePatientIdentifierSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, config: IdentifierConfig, status: PatientIdentifierStatus)¶

Bases: EMRResource

id: Annotated[UUID, UuidVersion(uuid_version=4)] | None¶

config: IdentifierConfig¶

status: PatientIdentifierStatus¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PatientIdentifierCreateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, config: IdentifierConfig, status: PatientIdentifierStatus, facility: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None)¶

Bases: BasePatientIdentifierSpec

facility: Annotated[UUID, UuidVersion(uuid_version=4)] | None¶

perform_extra_deserialization(is_update, obj)¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PatientIdentifierListSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, config: IdentifierConfig, status: PatientIdentifierStatus)¶

Bases: BasePatientIdentifierSpec

classmethod perform_extra_serialization(mapping, obj)¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].