care.emr.resources.service_request.spec module¶

class ServiceRequestStatusChoices(*values)¶

Bases: str, Enum

Status values for service requests

draft = 'draft'¶

active = 'active'¶

on_hold = 'on_hold'¶

entered_in_error = 'entered_in_error'¶

ended = 'ended'¶

completed = 'completed'¶

revoked = 'revoked'¶

class ServiceRequestIntentChoices(*values)¶

Bases: str, Enum

Intent values for service requests

proposal = 'proposal'¶

plan = 'plan'¶

directive = 'directive'¶

order = 'order'¶

class ServiceRequestPriorityChoices(*values)¶

Bases: str, Enum

Priority values for service requests

routine = 'routine'¶

urgent = 'urgent'¶

asap = 'asap'¶

stat = 'stat'¶

class BaseServiceRequestSpec(*, meta: dict = {}, id: str | None = None, title: str, status: ~care.emr.resources.service_request.spec.ServiceRequestStatusChoices, intent: ~care.emr.resources.service_request.spec.ServiceRequestIntentChoices, priority: ~care.emr.resources.service_request.spec.ServiceRequestPriorityChoices, category: ~care.emr.resources.activity_definition.spec.ActivityDefinitionCategoryOptions, do_not_perform: bool | None = None, note: str | None = None, body_site: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding | None = None, code: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, occurance: ~datetime.datetime | None = None, patient_instruction: str | None = None)¶

Bases: EMRResource

Base model for service requests

id: str | None¶

title: str¶

status: ServiceRequestStatusChoices¶

intent: ServiceRequestIntentChoices¶

priority: ServiceRequestPriorityChoices¶

category: ActivityDefinitionCategoryOptions¶

do_not_perform: bool | None¶

note: str | None¶

body_site: BoundCoding | None¶

code: BoundCoding¶

occurance: datetime | None¶

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

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 ServiceRequestWriteSpec(*, meta: dict = {}, id: str | None = None, title: str, status: ~care.emr.resources.service_request.spec.ServiceRequestStatusChoices, intent: ~care.emr.resources.service_request.spec.ServiceRequestIntentChoices, priority: ~care.emr.resources.service_request.spec.ServiceRequestPriorityChoices, category: ~care.emr.resources.activity_definition.spec.ActivityDefinitionCategoryOptions, do_not_perform: bool | None = None, note: str | None = None, body_site: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding | None = None, code: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, occurance: ~datetime.datetime | None = None, patient_instruction: str | None = None, healthcare_service: ~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)] | None = None, locations: list[~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)]] = [], requester: ~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)] | None = None)¶

Bases: BaseServiceRequestSpec

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

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

requester: 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]] = {'body_site': FieldInfo(annotation=Union[ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, NoneType], required=False, default=None), 'category': FieldInfo(annotation=ActivityDefinitionCategoryOptions, required=True), 'code': FieldInfo(annotation=ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, required=True), 'do_not_perform': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'healthcare_service': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'intent': FieldInfo(annotation=ServiceRequestIntentChoices, required=True), 'locations': FieldInfo(annotation=list[Annotated[UUID, UuidVersion]], required=False, default=[]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'note': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'occurance': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'patient_instruction': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'priority': FieldInfo(annotation=ServiceRequestPriorityChoices, required=True), 'requester': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'status': FieldInfo(annotation=ServiceRequestStatusChoices, required=True), 'title': 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 ServiceRequestUpdateSpec(*, meta: dict = {}, id: str | None = None, title: str | None = None, status: ~care.emr.resources.service_request.spec.ServiceRequestStatusChoices | None = None, intent: ~care.emr.resources.service_request.spec.ServiceRequestIntentChoices | None = None, priority: ~care.emr.resources.service_request.spec.ServiceRequestPriorityChoices | None = None, category: ~care.emr.resources.activity_definition.spec.ActivityDefinitionCategoryOptions | None = None, do_not_perform: bool | None = None, note: str | None = None, body_site: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding | None = None, code: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding | None = None, occurance: ~datetime.datetime | None = None, patient_instruction: str | None = None, healthcare_service: ~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)] | None = None, locations: list[~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)]] = [], requester: ~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)] | None = None)¶

Bases: ServiceRequestWriteSpec

Update specification for service requests

title: str | None¶

status: ServiceRequestStatusChoices | None¶

intent: ServiceRequestIntentChoices | None¶

priority: ServiceRequestPriorityChoices | None¶

category: ActivityDefinitionCategoryOptions | None¶

code: BoundCoding | 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]] = {'body_site': FieldInfo(annotation=Union[ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, NoneType], required=False, default=None), 'category': FieldInfo(annotation=Union[ActivityDefinitionCategoryOptions, NoneType], required=False, default=None), 'code': FieldInfo(annotation=Union[ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, NoneType], required=False, default=None), 'do_not_perform': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'healthcare_service': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'intent': FieldInfo(annotation=Union[ServiceRequestIntentChoices, NoneType], required=False, default=None), 'locations': FieldInfo(annotation=list[Annotated[UUID, UuidVersion]], required=False, default=[]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'note': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'occurance': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'patient_instruction': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'priority': FieldInfo(annotation=Union[ServiceRequestPriorityChoices, NoneType], required=False, default=None), 'requester': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[ServiceRequestStatusChoices, NoneType], required=False, default=None), 'title': 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 ServiceRequestCreateSpec(*, meta: dict = {}, id: str | None = None, title: str, status: ~care.emr.resources.service_request.spec.ServiceRequestStatusChoices, intent: ~care.emr.resources.service_request.spec.ServiceRequestIntentChoices, priority: ~care.emr.resources.service_request.spec.ServiceRequestPriorityChoices, category: ~care.emr.resources.activity_definition.spec.ActivityDefinitionCategoryOptions, do_not_perform: bool | None = None, note: str | None = None, body_site: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding | None = None, code: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, occurance: ~datetime.datetime | None = None, patient_instruction: str | None = None, healthcare_service: ~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)] | None = None, locations: list[~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)]] = [], requester: ~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)] | None = None, encounter: ~typing.Annotated[~uuid.UUID, ~pydantic.types.UuidVersion(uuid_version=4)])¶

Bases: ServiceRequestWriteSpec

Create specification for service requests

encounter: 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]] = {'body_site': FieldInfo(annotation=Union[ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, NoneType], required=False, default=None), 'category': FieldInfo(annotation=ActivityDefinitionCategoryOptions, required=True), 'code': FieldInfo(annotation=ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, required=True), 'do_not_perform': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'encounter': FieldInfo(annotation=UUID, required=True, metadata=[UuidVersion(uuid_version=4)]), 'healthcare_service': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'intent': FieldInfo(annotation=ServiceRequestIntentChoices, required=True), 'locations': FieldInfo(annotation=list[Annotated[UUID, UuidVersion]], required=False, default=[]), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'note': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'occurance': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'patient_instruction': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'priority': FieldInfo(annotation=ServiceRequestPriorityChoices, required=True), 'requester': FieldInfo(annotation=Union[Annotated[UUID, UuidVersion], NoneType], required=False, default=None), 'status': FieldInfo(annotation=ServiceRequestStatusChoices, required=True), 'title': 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 ServiceRequestReadSpec(*, meta: dict = {}, id: str | None = None, title: str, status: ~care.emr.resources.service_request.spec.ServiceRequestStatusChoices, intent: ~care.emr.resources.service_request.spec.ServiceRequestIntentChoices, priority: ~care.emr.resources.service_request.spec.ServiceRequestPriorityChoices, category: ~care.emr.resources.activity_definition.spec.ActivityDefinitionCategoryOptions, do_not_perform: bool | None = None, note: str | None = None, body_site: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding | None = None, code: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, occurance: ~datetime.datetime | None = None, patient_instruction: str | None = None, created_date: ~datetime.datetime, modified_date: ~datetime.datetime, encounter: dict, tags: list[dict] = [], requester: dict | None = None)¶

Bases: BaseServiceRequestSpec

Read specification for service requests

created_date: datetime¶

modified_date: datetime¶

encounter: dict¶

tags: list[dict]¶

requester: 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]] = {'body_site': FieldInfo(annotation=Union[ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, NoneType], required=False, default=None), 'category': FieldInfo(annotation=ActivityDefinitionCategoryOptions, required=True), 'code': FieldInfo(annotation=ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, required=True), 'created_date': FieldInfo(annotation=datetime, required=True), 'do_not_perform': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'encounter': FieldInfo(annotation=dict, required=True), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'intent': FieldInfo(annotation=ServiceRequestIntentChoices, required=True), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'modified_date': FieldInfo(annotation=datetime, required=True), 'note': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'occurance': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'patient_instruction': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'priority': FieldInfo(annotation=ServiceRequestPriorityChoices, required=True), 'requester': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'status': FieldInfo(annotation=ServiceRequestStatusChoices, required=True), 'tags': FieldInfo(annotation=list[dict], required=False, default=[]), 'title': 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 ServiceRequestRetrieveSpec(*, meta: dict = {}, id: str | None = None, title: str, status: ~care.emr.resources.service_request.spec.ServiceRequestStatusChoices, intent: ~care.emr.resources.service_request.spec.ServiceRequestIntentChoices, priority: ~care.emr.resources.service_request.spec.ServiceRequestPriorityChoices, category: ~care.emr.resources.activity_definition.spec.ActivityDefinitionCategoryOptions, do_not_perform: bool | None = None, note: str | None = None, body_site: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding | None = None, code: ~care.emr.utils.valueset_coding_type.ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, occurance: ~datetime.datetime | None = None, patient_instruction: str | None = None, created_date: ~datetime.datetime, modified_date: ~datetime.datetime, encounter: dict, tags: list[dict] = [], requester: dict | None = None, locations: list[dict], healthcare_service: dict | None = None, activity_definition: dict | None = None, specimens: list[dict] | None = None, created_by: dict | None = None, updated_by: dict | None = None, diagnostic_reports: list[dict] | None = None)¶

Bases: ServiceRequestReadSpec

Read specification for service requests

locations: list[dict]¶

healthcare_service: dict | None¶

activity_definition: dict | None¶

specimens: list[dict] | None¶

created_by: dict | None¶

updated_by: dict | None¶

diagnostic_reports: list[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]] = {'activity_definition': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'body_site': FieldInfo(annotation=Union[ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, NoneType], required=False, default=None), 'category': FieldInfo(annotation=ActivityDefinitionCategoryOptions, required=True), 'code': FieldInfo(annotation=ValueSetBoundCoding.__class_getitem__.<locals>.BoundCoding, required=True), 'created_by': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'created_date': FieldInfo(annotation=datetime, required=True), 'diagnostic_reports': FieldInfo(annotation=Union[list[dict], NoneType], required=False, default=None), 'do_not_perform': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'encounter': FieldInfo(annotation=dict, required=True), 'healthcare_service': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'intent': FieldInfo(annotation=ServiceRequestIntentChoices, required=True), 'locations': FieldInfo(annotation=list[dict], required=True), 'meta': FieldInfo(annotation=dict, required=False, default={}), 'modified_date': FieldInfo(annotation=datetime, required=True), 'note': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'occurance': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'patient_instruction': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'priority': FieldInfo(annotation=ServiceRequestPriorityChoices, required=True), 'requester': FieldInfo(annotation=Union[dict, NoneType], required=False, default=None), 'specimens': FieldInfo(annotation=Union[list[dict], NoneType], required=False, default=None), 'status': FieldInfo(annotation=ServiceRequestStatusChoices, required=True), 'tags': FieldInfo(annotation=list[dict], required=False, default=[]), 'title': 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.