care.emr.resources.device.spec module¶

class DeviceStatusChoices(*values)¶

Bases: str, Enum

active = 'active'¶

inactive = 'inactive'¶

entered_in_error = 'entered_in_error'¶

class DeviceAvailabilityStatusChoices(*values)¶

Bases: str, Enum

lost = 'lost'¶

damaged = 'damaged'¶

destroyed = 'destroyed'¶

available = 'available'¶

class DeviceSpecBase(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, identifier: str | None = None, status: DeviceStatusChoices, availability_status: DeviceAvailabilityStatusChoices, manufacturer: str | None = None, manufacture_date: datetime | None = None, expiration_date: datetime | None = None, lot_number: str | None = None, serial_number: str | None = None, registered_name: str, user_friendly_name: str | None = None, model_number: str | None = None, part_number: str | None = None, contact: list[ContactPoint] = [])¶

Bases: EMRResource

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

identifier: str | None¶

status: DeviceStatusChoices¶

availability_status: DeviceAvailabilityStatusChoices¶

manufacturer: str | None¶

manufacture_date: datetime | None¶

expiration_date: datetime | None¶

lot_number: str | None¶

serial_number: str | None¶

registered_name: str¶

user_friendly_name: str | None¶

model_number: str | None¶

part_number: str | None¶

contact: list[ContactPoint]¶

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=DeviceAvailabilityStatusChoices, required=True), 'contact': FieldInfo(annotation=list[ContactPoint], required=False, default=[]), 'expiration_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'lot_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'manufacture_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'manufacturer': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'model_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'part_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'registered_name': FieldInfo(annotation=str, required=True), 'serial_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=DeviceStatusChoices, required=True), 'user_friendly_name': FieldInfo(annotation=Union[str, 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 DeviceCreateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, identifier: str | None = None, status: DeviceStatusChoices, availability_status: DeviceAvailabilityStatusChoices, manufacturer: str | None = None, manufacture_date: datetime | None = None, expiration_date: datetime | None = None, lot_number: str | None = None, serial_number: str | None = None, registered_name: str, user_friendly_name: str | None = None, model_number: str | None = None, part_number: str | None = None, contact: list[ContactPoint] = [], care_type: str | None = None, care_metadata: dict = {})¶

Bases: DeviceSpecBase

care_type: str | None¶

care_metadata: dict¶

classmethod validate_care_type(value)¶

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=DeviceAvailabilityStatusChoices, required=True), 'care_metadata': FieldInfo(annotation=dict, required=False, default={}), 'care_type': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'contact': FieldInfo(annotation=list[ContactPoint], required=False, default=[]), 'expiration_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'lot_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'manufacture_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'manufacturer': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'model_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'part_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'registered_name': FieldInfo(annotation=str, required=True), 'serial_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=DeviceStatusChoices, required=True), 'user_friendly_name': FieldInfo(annotation=Union[str, 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 DeviceUpdateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, identifier: str | None = None, status: DeviceStatusChoices, availability_status: DeviceAvailabilityStatusChoices, manufacturer: str | None = None, manufacture_date: datetime | None = None, expiration_date: datetime | None = None, lot_number: str | None = None, serial_number: str | None = None, registered_name: str, user_friendly_name: str | None = None, model_number: str | None = None, part_number: str | None = None, contact: list[ContactPoint] = [], care_metadata: dict = {})¶

Bases: DeviceSpecBase

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'availability_status': FieldInfo(annotation=DeviceAvailabilityStatusChoices, required=True), 'care_metadata': FieldInfo(annotation=dict, required=False, default={}), 'contact': FieldInfo(annotation=list[ContactPoint], required=False, default=[]), 'expiration_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'lot_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'manufacture_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'manufacturer': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'model_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'part_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'registered_name': FieldInfo(annotation=str, required=True), 'serial_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=DeviceStatusChoices, required=True), 'user_friendly_name': FieldInfo(annotation=Union[str, 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 DeviceListSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, identifier: str | None = None, status: DeviceStatusChoices, availability_status: DeviceAvailabilityStatusChoices, manufacturer: str | None = None, manufacture_date: datetime | None = None, expiration_date: datetime | None = None, lot_number: str | None = None, serial_number: str | None = None, registered_name: str, user_friendly_name: str | None = None, model_number: str | None = None, part_number: str | None = None, contact: list[ContactPoint] = [], care_type: str | None = None, care_metadata: dict = {})¶

Bases: DeviceCreateSpec

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

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 DeviceRetrieveSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, identifier: str | None = None, status: DeviceStatusChoices, availability_status: DeviceAvailabilityStatusChoices, manufacturer: str | None = None, manufacture_date: datetime | None = None, expiration_date: datetime | None = None, lot_number: str | None = None, serial_number: str | None = None, registered_name: str, user_friendly_name: str | None = None, model_number: str | None = None, part_number: str | None = None, contact: list[ContactPoint] = [], care_type: str | None = None, care_metadata: dict = {}, current_encounter: dict | None = None, current_location: dict, created_by: dict | None = None, updated_by: dict | None = None, managing_organization: dict | None = None)¶

Bases: DeviceListSpec

current_encounter: dict | None¶

current_location: dict¶

created_by: dict | None¶

updated_by: dict | None¶

managing_organization: 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=DeviceAvailabilityStatusChoices, required=True), 'care_metadata': FieldInfo(annotation=dict, required=False, default={}), 'care_type': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'contact': FieldInfo(annotation=list[ContactPoint], required=False, default=[]), 'created_by': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'current_encounter': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'current_location': FieldInfo(annotation=dict, required=True), 'expiration_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'lot_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'managing_organization': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'manufacture_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'manufacturer': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'model_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'part_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'registered_name': FieldInfo(annotation=str, required=True), 'serial_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=DeviceStatusChoices, required=True), 'updated_by': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'user_friendly_name': FieldInfo(annotation=Union[str, 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 DeviceLocationHistoryListSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] = None, location: dict, created_by: dict, start: datetime, end: datetime | None = None)¶

Bases: EMRResource

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

location: dict¶

created_by: dict¶

start: datetime¶

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

Bases: EMRResource

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

encounter: dict¶

created_by: dict¶

start: datetime¶

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