care.emr.resources.facility_organization.spec module¶

class FacilityOrganizationTypeChoices(*values)¶

Bases: str, Enum

dept = 'dept'¶

team = 'team'¶

root = 'root'¶

role = 'role'¶

other = 'other'¶

class FacilityOrganizationBaseSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, active: bool = True, name: str, description: str = '', metadata: dict = {})¶

Bases: EMRResource

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

active: bool¶

name: str¶

description: str¶

metadata: dict¶

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].

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 FacilityOrganizationUpdateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, active: bool = True, name: str, description: str = '', metadata: dict = {})¶

Bases: FacilityOrganizationBaseSpec

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].

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 FacilityOrganizationWriteSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, active: bool = True, name: str, description: str = '', metadata: dict = {}, facility: Annotated[UUID, UuidVersion(uuid_version=4)], org_type: FacilityOrganizationTypeChoices, parent: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None)¶

Bases: FacilityOrganizationBaseSpec

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

org_type: FacilityOrganizationTypeChoices¶

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

classmethod validate_encounter_exists(facility)¶

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]] = {'active': FieldInfo(annotation=bool, required=False, default=True), 'description': FieldInfo(annotation=str, required=False, default=''), 'facility': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)]), 'id': FieldInfo(annotation=UUID, required=False, default=None, metadata=[UuidVersion(uuid_version=4)]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'metadata': FieldInfo(annotation=dict, required=False, default={}), 'name': FieldInfo(annotation=str, required=True), 'org_type': FieldInfo(annotation=FacilityOrganizationTypeChoices, required=True), 'parent': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], 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 FacilityOrganizationReadSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, active: bool = True, name: str, description: str = '', metadata: dict = {}, org_type: FacilityOrganizationTypeChoices, parent: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, created_by: UserSpec = {}, updated_by: UserSpec = {}, system_generated: bool, level_cache: int = 0, has_children: bool)¶

Bases: FacilityOrganizationBaseSpec

org_type: FacilityOrganizationTypeChoices¶

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

created_by: UserSpec¶

updated_by: UserSpec¶

system_generated: bool¶

level_cache: int¶

has_children: bool¶

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]] = {'active': FieldInfo(annotation=bool, required=False, default=True), 'created_by': FieldInfo(annotation=UserSpec, required=False, default={}), 'description': FieldInfo(annotation=str, required=False, default=''), 'has_children': FieldInfo(annotation=bool, required=True), 'id': FieldInfo(annotation=UUID, required=False, default=None, metadata=[UuidVersion(uuid_version=4)]), 'level_cache': FieldInfo(annotation=int, required=False, default=0), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'metadata': FieldInfo(annotation=dict, required=False, default={}), 'name': FieldInfo(annotation=str, required=True), 'org_type': FieldInfo(annotation=FacilityOrganizationTypeChoices, required=True), 'parent': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'system_generated': FieldInfo(annotation=bool, required=True), 'updated_by': FieldInfo(annotation=UserSpec, 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 FacilityOrganizationRetrieveSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, active: bool = True, name: str, description: str = '', metadata: dict = {}, org_type: FacilityOrganizationTypeChoices, parent: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, created_by: UserSpec = {}, updated_by: UserSpec = {}, system_generated: bool, level_cache: int = 0, has_children: bool, permissions: list[str] = [])¶

Bases: FacilityOrganizationReadSpec

permissions: list[str]¶

classmethod perform_extra_user_serialization(mapping, obj, user)¶

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]] = {'active': FieldInfo(annotation=bool, required=False, default=True), 'created_by': FieldInfo(annotation=UserSpec, required=False, default={}), 'description': FieldInfo(annotation=str, required=False, default=''), 'has_children': FieldInfo(annotation=bool, required=True), 'id': FieldInfo(annotation=UUID, required=False, default=None, metadata=[UuidVersion(uuid_version=4)]), 'level_cache': FieldInfo(annotation=int, required=False, default=0), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'metadata': FieldInfo(annotation=dict, required=False, default={}), 'name': FieldInfo(annotation=str, required=True), 'org_type': FieldInfo(annotation=FacilityOrganizationTypeChoices, required=True), 'parent': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'permissions': FieldInfo(annotation=list[str], required=False, default=[]), 'system_generated': FieldInfo(annotation=bool, required=True), 'updated_by': FieldInfo(annotation=UserSpec, 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.