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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'admit_source': FieldInfo(annotation=Union[AdmitSourcesChoices, NoneType], required=False, default=None), 'diet_preference': FieldInfo(annotation=Union[DietPreferenceChoices, NoneType], required=False, default=None), 'discharge_disposition': FieldInfo(annotation=Union[DischargeDispositionChoices, NoneType], required=False, default=None), 're_admission': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'discharge_summary_advice': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'encounter_class': FieldInfo(annotation=ClassChoices, required=True), 'external_identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'hospitalization': FieldInfo(annotation=Union[HospitalizationSpec, NoneType], required=False, default={}), 'id': FieldInfo(annotation=UUID, required=False, default=None, metadata=[UuidVersion(uuid_version=4)]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'period': FieldInfo(annotation=PeriodSpec, required=False, default={}), 'priority': FieldInfo(annotation=EncounterPriorityChoices, required=True), 'status': FieldInfo(annotation=StatusChoices, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'appointment': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'discharge_summary_advice': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'encounter_class': FieldInfo(annotation=ClassChoices, required=True), 'external_identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'facility': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)]), 'hospitalization': FieldInfo(annotation=Union[HospitalizationSpec, NoneType], required=False, default={}), 'id': FieldInfo(annotation=UUID, required=False, default=None, metadata=[UuidVersion(uuid_version=4)]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'organizations': FieldInfo(annotation=list[Annotated[UUID, UuidVersion]], required=False, default=[]), 'patient': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)]), 'period': FieldInfo(annotation=PeriodSpec, required=False, default={}), 'priority': FieldInfo(annotation=EncounterPriorityChoices, required=True), 'status': FieldInfo(annotation=StatusChoices, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'discharge_summary_advice': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'encounter_class': FieldInfo(annotation=ClassChoices, required=True), 'external_identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'hospitalization': FieldInfo(annotation=Union[HospitalizationSpec, NoneType], required=False, default={}), 'id': FieldInfo(annotation=UUID, required=False, default=None, metadata=[UuidVersion(uuid_version=4)]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'period': FieldInfo(annotation=PeriodSpec, required=False, default={}), 'priority': FieldInfo(annotation=EncounterPriorityChoices, required=True), 'status': FieldInfo(annotation=StatusChoices, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'created_date': FieldInfo(annotation=datetime, required=True), 'discharge_summary_advice': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'encounter_class': FieldInfo(annotation=ClassChoices, required=True), 'encounter_class_history': FieldInfo(annotation=dict, required=True), 'external_identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'facility': FieldInfo(annotation=dict, required=True), 'hospitalization': FieldInfo(annotation=Union[HospitalizationSpec, NoneType], required=False, default={}), 'id': FieldInfo(annotation=UUID, required=False, default=None, metadata=[UuidVersion(uuid_version=4)]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'modified_date': FieldInfo(annotation=datetime, required=True), 'patient': FieldInfo(annotation=dict, required=True), 'period': FieldInfo(annotation=PeriodSpec, required=False, default={}), 'priority': FieldInfo(annotation=EncounterPriorityChoices, required=True), 'status': FieldInfo(annotation=StatusChoices, required=True), 'status_history': FieldInfo(annotation=dict, required=True), 'tags': FieldInfo(annotation=list[dict], required=False, default=[])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'appointment': FieldInfo(annotation=dict, required=False, default={}), 'care_team': FieldInfo(annotation=list[dict], required=False, default=[]), 'created_by': FieldInfo(annotation=dict, required=False, default={}), 'created_date': FieldInfo(annotation=datetime, required=True), 'current_location': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'discharge_summary_advice': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'encounter_class': FieldInfo(annotation=ClassChoices, required=True), 'encounter_class_history': FieldInfo(annotation=dict, required=True), 'external_identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'facility': FieldInfo(annotation=dict, required=True), 'hospitalization': FieldInfo(annotation=Union[HospitalizationSpec, NoneType], required=False, default={}), 'id': FieldInfo(annotation=UUID, required=False, default=None, metadata=[UuidVersion(uuid_version=4)]), 'location_history': FieldInfo(annotation=list[dict], required=False, default=[]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'modified_date': FieldInfo(annotation=datetime, required=True), 'organizations': FieldInfo(annotation=list[dict], required=False, default=[]), 'patient': FieldInfo(annotation=dict, required=True), 'period': FieldInfo(annotation=PeriodSpec, required=False, default={}), 'permissions': FieldInfo(annotation=list[str], required=False, default=[]), 'priority': FieldInfo(annotation=EncounterPriorityChoices, required=True), 'status': FieldInfo(annotation=StatusChoices, required=True), 'status_history': FieldInfo(annotation=dict, required=True), 'tags': FieldInfo(annotation=list[dict], required=False, default=[]), 'updated_by': FieldInfo(annotation=dict, required=False, default={})}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'role': FieldInfo(annotation=ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, required=True), 'user_id': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

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

Bases: BaseModel

members: list[EncounterCareTeamMemberSpec]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'members': FieldInfo(annotation=list[EncounterCareTeamMemberSpec], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.