care.emr.resources.file_upload.spec module

class FileTypeChoices(*values)

Bases: str, Enum

patient = 'patient'

encounter = 'encounter'

consent = 'consent'

diagnostic_report = 'diagnostic_report'

service_request = 'service_request'

class FileCategoryChoices(*values)

Bases: str, Enum

audio = 'audio'

xray = 'xray'

identity_proof = 'identity_proof'

unspecified = 'unspecified'

discharge_summary = 'discharge_summary'

consent_attachment = 'consent_attachment'

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

Bases: EMRResource

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

name: str

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={}), 'name': 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 FileUploadUpdateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, name: str)

Bases: FileUploadBaseSpec

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={}), 'name': 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 FileUploadCreateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, name: str, original_name: str, file_type: FileTypeChoices, file_category: FileCategoryChoices, associating_id: str, mime_type: str)

Bases: FileUploadBaseSpec

original_name: str

file_type: FileTypeChoices

file_category: FileCategoryChoices

associating_id: str

mime_type: str

perform_extra_deserialization(is_update, obj)

classmethod validate_mime_type(mime_type: str)

classmethod validate_original_name(original_name: str)

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]] = {'associating_id': FieldInfo(annotation=str, required=True), 'file_category': FieldInfo(annotation=FileCategoryChoices, required=True), 'file_type': FieldInfo(annotation=FileTypeChoices, required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'mime_type': FieldInfo(annotation=str, required=True), 'name': FieldInfo(annotation=str, required=True), 'original_name': 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 FileUploadListSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, name: str, file_type: FileTypeChoices, file_category: FileCategoryChoices, associating_id: str, archived_by: UserSpec | None = None, archived_datetime: datetime | None = None, upload_completed: bool, is_archived: bool | None = None, archive_reason: str | None = None, created_date: datetime, extension: str, uploaded_by: dict, mime_type: str)

Bases: FileUploadBaseSpec

file_type: FileTypeChoices

file_category: FileCategoryChoices

associating_id: str

archived_by: UserSpec | None

archived_datetime: datetime | None

upload_completed: bool

is_archived: bool | None

archive_reason: str | None

created_date: datetime

extension: str

uploaded_by: dict

mime_type: 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]] = {'archive_reason': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'archived_by': FieldInfo(annotation=Union[UserSpec, NoneType], required=False, default=None), 'archived_datetime': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'associating_id': FieldInfo(annotation=str, required=True), 'created_date': FieldInfo(annotation=datetime, required=True), 'extension': FieldInfo(annotation=str, required=True), 'file_category': FieldInfo(annotation=FileCategoryChoices, required=True), 'file_type': FieldInfo(annotation=FileTypeChoices, required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'is_archived': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'mime_type': FieldInfo(annotation=str, required=True), 'name': FieldInfo(annotation=str, required=True), 'upload_completed': FieldInfo(annotation=bool, required=True), 'uploaded_by': FieldInfo(annotation=dict, 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 FileUploadRetrieveSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, name: str, file_type: FileTypeChoices, file_category: FileCategoryChoices, associating_id: str, archived_by: UserSpec | None = None, archived_datetime: datetime | None = None, upload_completed: bool, is_archived: bool | None = None, archive_reason: str | None = None, created_date: datetime, extension: str, uploaded_by: dict, mime_type: str, signed_url: str | None = None, read_signed_url: str | None = None, internal_name: str)

Bases: FileUploadListSpec

signed_url: str | None

read_signed_url: str | None

internal_name: 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]] = {'archive_reason': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'archived_by': FieldInfo(annotation=Union[UserSpec, NoneType], required=False, default=None), 'archived_datetime': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'associating_id': FieldInfo(annotation=str, required=True), 'created_date': FieldInfo(annotation=datetime, required=True), 'extension': FieldInfo(annotation=str, required=True), 'file_category': FieldInfo(annotation=FileCategoryChoices, required=True), 'file_type': FieldInfo(annotation=FileTypeChoices, required=True), 'id': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'internal_name': FieldInfo(annotation=str, required=True), 'is_archived': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'mime_type': FieldInfo(annotation=str, required=True), 'name': FieldInfo(annotation=str, required=True), 'read_signed_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'signed_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'upload_completed': FieldInfo(annotation=bool, required=True), 'uploaded_by': FieldInfo(annotation=dict, 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 ConsentFileUploadCreateSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, name: str, original_name: str, associating_id: Annotated[UUID, UuidVersion(uuid_version=4)])

Bases: FileUploadBaseSpec

original_name: str

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

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