care.emr.resources.location.spec module

class LocationEncounterAvailabilityStatusChoices(*values)

Bases: str, Enum

planned = 'planned'

active = 'active'

reserved = 'reserved'

completed = 'completed'

class StatusChoices(*values)

Bases: str, Enum

active = 'active'

inactive = 'inactive'

unknown = 'unknown'

class FacilityLocationOperationalStatusChoices(*values)

Bases: str, Enum

C = 'C'

H = 'H'

O = 'O'

U = 'U'

K = 'K'

I = 'I'

class FacilityLocationModeChoices(*values)

Bases: str, Enum

instance = 'instance'

kind = 'kind'

class FacilityLocationFormChoices(*values)

Bases: str, Enum

si = 'si'

bu = 'bu'

wi = 'wi'

wa = 'wa'

lvl = 'lvl'

co = 'co'

ro = 'ro'

bd = 'bd'

ve = 've'

ho = 'ho'

ca = 'ca'

rd = 'rd'

area = 'area'

jdn = 'jdn'

vi = 'vi'

class FacilityLocationBaseSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None)

Bases: EMRResource

id: Annotated[UUID, UuidVersion(uuid_version=4)] | 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]] = {'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'meta': 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 FacilityLocationSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, status: StatusChoices, operational_status: FacilityLocationOperationalStatusChoices, name: str, description: str, location_type: Coding | None = None, form: FacilityLocationFormChoices, sort_index: Annotated[int | None, Ge(ge=0), Le(le=10000)] = 0)

Bases: FacilityLocationBaseSpec

status: StatusChoices

operational_status: FacilityLocationOperationalStatusChoices

name: str

description: str

location_type: Coding | None

form: FacilityLocationFormChoices

sort_index: int | 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]] = {'description': FieldInfo(annotation=str, required=True), 'form': FieldInfo(annotation=FacilityLocationFormChoices, required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'location_type': FieldInfo(annotation=Union[Coding, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'name': FieldInfo(annotation=str, required=True), 'operational_status': FieldInfo(annotation=FacilityLocationOperationalStatusChoices, required=True), 'sort_index': FieldInfo(annotation=Union[int, NoneType], required=False, default=0, metadata=[Ge(ge=0), Le(le=10000)]), '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 FacilityLocationUpdateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, status: StatusChoices, operational_status: FacilityLocationOperationalStatusChoices, name: str, description: str, location_type: Coding | None = None, form: FacilityLocationFormChoices, sort_index: Annotated[int | None, Ge(ge=0), Le(le=10000)] = 0)

Bases: FacilityLocationSpec

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]] = {'description': FieldInfo(annotation=str, required=True), 'form': FieldInfo(annotation=FacilityLocationFormChoices, required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'location_type': FieldInfo(annotation=Union[Coding, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'name': FieldInfo(annotation=str, required=True), 'operational_status': FieldInfo(annotation=FacilityLocationOperationalStatusChoices, required=True), 'sort_index': FieldInfo(annotation=Union[int, NoneType], required=False, default=0, metadata=[Ge(ge=0), Le(le=10000)]), '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 FacilityLocationWriteSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, status: StatusChoices, operational_status: FacilityLocationOperationalStatusChoices, name: str, description: str, location_type: Coding | None = None, form: FacilityLocationFormChoices, sort_index: Annotated[int | None, Ge(ge=0), Le(le=10000)] = 0, parent: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, organizations: list[Annotated[UUID, UuidVersion(uuid_version=4)]], mode: FacilityLocationModeChoices)

Bases: FacilityLocationSpec

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

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

mode: FacilityLocationModeChoices

validate_parent_organization()

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]] = {'description': FieldInfo(annotation=str, required=True), 'form': FieldInfo(annotation=FacilityLocationFormChoices, required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'location_type': FieldInfo(annotation=Union[Coding, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'mode': FieldInfo(annotation=FacilityLocationModeChoices, required=True), 'name': FieldInfo(annotation=str, required=True), 'operational_status': FieldInfo(annotation=FacilityLocationOperationalStatusChoices, required=True), 'organizations': FieldInfo(annotation=list[Annotated[UUID, UuidVersion]], required=True), 'parent': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'sort_index': FieldInfo(annotation=Union[int, NoneType], required=False, default=0, metadata=[Ge(ge=0), Le(le=10000)]), '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 FacilityLocationListSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, status: StatusChoices, operational_status: FacilityLocationOperationalStatusChoices, name: str, description: str, location_type: Coding | None = None, form: FacilityLocationFormChoices, sort_index: Annotated[int | None, Ge(ge=0), Le(le=10000)] = 0, parent: dict, mode: str, has_children: bool, availability_status: str, current_encounter: dict | None = None)

Bases: FacilityLocationSpec

parent: dict

mode: str

has_children: bool

availability_status: str

current_encounter: dict | None

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]] = {'availability_status': FieldInfo(annotation=str, required=True), 'current_encounter': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'description': FieldInfo(annotation=str, required=True), 'form': FieldInfo(annotation=FacilityLocationFormChoices, required=True), 'has_children': FieldInfo(annotation=bool, required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'location_type': FieldInfo(annotation=Union[Coding, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'mode': FieldInfo(annotation=str, required=True), 'name': FieldInfo(annotation=str, required=True), 'operational_status': FieldInfo(annotation=FacilityLocationOperationalStatusChoices, required=True), 'parent': FieldInfo(annotation=dict, required=True), 'sort_index': FieldInfo(annotation=Union[int, NoneType], required=False, default=0, metadata=[Ge(ge=0), Le(le=10000)]), '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 FacilityLocationRetrieveSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, status: StatusChoices, operational_status: FacilityLocationOperationalStatusChoices, name: str, description: str, location_type: Coding | None = None, form: FacilityLocationFormChoices, sort_index: Annotated[int | None, Ge(ge=0), Le(le=10000)] = 0, parent: dict, mode: str, has_children: bool, availability_status: str, current_encounter: dict | None = None, created_by: dict | None = None, updated_by: dict | None = None)

Bases: FacilityLocationListSpec

created_by: dict | None

updated_by: dict | None

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]] = {'availability_status': FieldInfo(annotation=str, required=True), 'created_by': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'current_encounter': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'description': FieldInfo(annotation=str, required=True), 'form': FieldInfo(annotation=FacilityLocationFormChoices, required=True), 'has_children': FieldInfo(annotation=bool, required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'location_type': FieldInfo(annotation=Union[Coding, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'mode': FieldInfo(annotation=str, required=True), 'name': FieldInfo(annotation=str, required=True), 'operational_status': FieldInfo(annotation=FacilityLocationOperationalStatusChoices, required=True), 'parent': FieldInfo(annotation=dict, required=True), 'sort_index': FieldInfo(annotation=Union[int, NoneType], required=False, default=0, metadata=[Ge(ge=0), Le(le=10000)]), 'status': FieldInfo(annotation=StatusChoices, required=True), 'updated_by': FieldInfo(annotation=Union[dict, 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 FacilityLocationEncounterBaseSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None)

Bases: EMRResource

id: Annotated[UUID, UuidVersion(uuid_version=4)] | 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]] = {'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'meta': 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 FacilityLocationEncounterCreateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, status: LocationEncounterAvailabilityStatusChoices, encounter: Annotated[UUID, UuidVersion(uuid_version=4)], start_datetime: datetime, end_datetime: datetime | None = None)

Bases: FacilityLocationEncounterBaseSpec

status: LocationEncounterAvailabilityStatusChoices

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

start_datetime: datetime

end_datetime: datetime | None

validate_encounter()

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]] = {'encounter': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)]), 'end_datetime': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'start_datetime': FieldInfo(annotation=datetime, required=True), 'status': FieldInfo(annotation=LocationEncounterAvailabilityStatusChoices, 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 FacilityLocationEncounterUpdateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, status: LocationEncounterAvailabilityStatusChoices, start_datetime: datetime, end_datetime: datetime | None)

Bases: FacilityLocationEncounterBaseSpec

status: LocationEncounterAvailabilityStatusChoices

start_datetime: datetime

end_datetime: datetime | 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]] = {'end_datetime': FieldInfo(annotation=Union[datetime, NoneType], required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'start_datetime': FieldInfo(annotation=datetime, required=True), 'status': FieldInfo(annotation=LocationEncounterAvailabilityStatusChoices, 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 FacilityLocationEncounterListSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, encounter: Annotated[UUID, UuidVersion(uuid_version=4)], start_datetime: datetime, end_datetime: datetime | None = None, status: str)

Bases: FacilityLocationEncounterBaseSpec

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

start_datetime: datetime

end_datetime: datetime | None

status: str

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]] = {'encounter': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)]), 'end_datetime': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'start_datetime': FieldInfo(annotation=datetime, required=True), 'status': FieldInfo(annotation=str, 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 FacilityLocationEncounterListSpecWithLocation(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, encounter: Annotated[UUID, UuidVersion(uuid_version=4)], start_datetime: datetime, end_datetime: datetime | None = None, status: str, location: dict)

Bases: FacilityLocationEncounterListSpec

location: 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]] = {'encounter': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)]), 'end_datetime': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'location': FieldInfo(annotation=dict, required=True), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'start_datetime': FieldInfo(annotation=datetime, required=True), 'status': FieldInfo(annotation=str, 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 FacilityLocationEncounterReadSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, encounter: Annotated[UUID, UuidVersion(uuid_version=4)], start_datetime: datetime, end_datetime: datetime | None = None, status: str, created_by: dict | None = None, updated_by: dict | None = None)

Bases: FacilityLocationEncounterBaseSpec

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

start_datetime: datetime

end_datetime: datetime | None

status: str

created_by: dict | None

updated_by: dict | None

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_by': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'encounter': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)]), 'end_datetime': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'start_datetime': FieldInfo(annotation=datetime, required=True), 'status': FieldInfo(annotation=str, required=True), 'updated_by': FieldInfo(annotation=Union[dict, 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.