HclsImagesetSearch

pydantic model openapi_client.models.hcls_imageset_search.HclsImagesetSearch

HealthImaging imageset search filters. At least one top-level key is required by the backend (not enforced by API Gateway). Allowed keys: Patient, Study, Series, CreatedAt, StudyTimestamp. CreatedAt and StudyTimestamp require StartTime and EndTime by the backend.

Fields:
field patient: Optional[Dict[str, Any]] = None (alias 'Patient')

Patient-level DICOM tag equality filters (tag name to value).

field study: Optional[Dict[str, Any]] = None (alias 'Study')

Study-level DICOM tag equality filters (tag name to value).

field series: Optional[Dict[str, Any]] = None (alias 'Series')

Series-level filters (contains matching).

field created_at: Optional[HclsImagesetSearchCreatedAt] = None (alias 'CreatedAt')
field study_timestamp: Optional[HclsImagesetSearchStudyTimestamp] = None (alias 'StudyTimestamp')
to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of HclsImagesetSearch from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of HclsImagesetSearch from a dict

Return type:

Optional[Self]