care.emr.resources.encounter.spec module¶

class HospitalizationSpec(*, re_admission: bool | None = None, admit_source: AdmitSourcesChoices | None = None, discharge_disposition: DischargeDispositionChoices | None = None, diet_preference: DietPreferenceChoices | None = None)¶

Bases: BaseModel

re_admission: bool | None¶

admit_source: AdmitSourcesChoices | None¶

discharge_disposition: DischargeDispositionChoices | None¶

diet_preference: DietPreferenceChoices | None¶

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

class EncounterSpecBase(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, status: StatusChoices, encounter_class: ClassChoices, period: PeriodSpec = {}, hospitalization: HospitalizationSpec | None = {}, priority: EncounterPriorityChoices, external_identifier: str | None = None, discharge_summary_advice: str | None = None)¶

Bases: EMRResource

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

status: StatusChoices¶

encounter_class: ClassChoices¶

period: PeriodSpec¶

hospitalization: HospitalizationSpec | None¶

priority: EncounterPriorityChoices¶

external_identifier: str | None¶

discharge_summary_advice: str | None¶

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

class EncounterCreateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, status: StatusChoices, encounter_class: ClassChoices, period: PeriodSpec = {}, hospitalization: HospitalizationSpec | None = {}, priority: EncounterPriorityChoices, external_identifier: str | None = None, discharge_summary_advice: str | None = None, patient: Annotated[UUID, UuidVersion(uuid_version=4)], facility: Annotated[UUID, UuidVersion(uuid_version=4)], organizations: list[Annotated[UUID, UuidVersion(uuid_version=4)]] = [], appointment: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None)¶

Bases: EncounterSpecBase

patient: Annotated[UUID, UuidVersion(uuid_version=4)]¶

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

organizations: list[Annotated[UUID, UuidVersion(uuid_version=4)]]¶

appointment: 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 EncounterUpdateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, status: StatusChoices, encounter_class: ClassChoices, period: PeriodSpec = {}, hospitalization: HospitalizationSpec | None = {}, priority: EncounterPriorityChoices, external_identifier: str | None = None, discharge_summary_advice: str | None = None)¶

Bases: EncounterSpecBase

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 EncounterListSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, status: StatusChoices, encounter_class: ClassChoices, period: PeriodSpec = {}, hospitalization: HospitalizationSpec | None = {}, priority: EncounterPriorityChoices, external_identifier: str | None = None, discharge_summary_advice: str | None = None, patient: dict, facility: dict, status_history: dict, encounter_class_history: dict, created_date: datetime, modified_date: datetime, tags: list[dict] = [])¶

Bases: EncounterSpecBase

patient: dict¶

facility: dict¶

status_history: dict¶

encounter_class_history: dict¶

created_date: datetime¶

modified_date: datetime¶

tags: list[dict]¶

classmethod perform_extra_serialization(mapping, obj)¶

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

class EncounterRetrieveSpec(*, meta: dict = {}, permissions: list[str] = [], id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, status: StatusChoices, encounter_class: ClassChoices, period: PeriodSpec = {}, hospitalization: HospitalizationSpec | None = {}, priority: EncounterPriorityChoices, external_identifier: str | None = None, discharge_summary_advice: str | None = None, patient: dict, facility: dict, status_history: dict, encounter_class_history: dict, created_date: datetime, modified_date: datetime, tags: list[dict] = [], appointment: dict = {}, created_by: dict = {}, updated_by: dict = {}, organizations: list[dict] = [], current_location: dict | None = None, location_history: list[dict] = [], care_team: list[dict] = [])¶

Bases: EncounterListSpec, EncounterPermissionsMixin

appointment: dict¶

created_by: dict¶

updated_by: dict¶

organizations: list[dict]¶

current_location: dict | None¶

location_history: list[dict]¶

care_team: list[dict]¶

classmethod perform_extra_serialization(mapping, obj)¶

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

class EncounterCareTeamMemberSpec(*, user_id: ~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)], role: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding)¶

Bases: BaseModel

user_id: Annotated[UUID, UuidVersion(uuid_version=4)]¶

role: BoundCoding¶

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

class EncounterCareTeamMemberWriteSpec(*, members: list[EncounterCareTeamMemberSpec])¶

Bases: BaseModel

members: list[EncounterCareTeamMemberSpec]¶

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