flip_api.domain.schemas.cohort

Classes

`CohortResultsAge`	Model for age statistics in cohort results.
`CohortResultsGender`	Model for gender statistics in cohort results.
`CohortResultsClientVisit`	Model for client visit statistics in cohort results.
`ResultsStats`	Model for results statistics in cohort results.
`ReceivedCohortResults`	Model for received cohort results.
`CohortResultDataResponse`	Response model for cohort result data.
`Results`	Model for individual results in OMOP trust results.
`OMOPTrustResults`	Model for OMOP trust results.
`OMOPResult`	Model for OMOP results.
`OmopCohortResultsResponse`	Response model for OMOP cohort results.
`OMOPDbResult`	Model for OMOP database results.
`SubmitCohortQuery`	Model for submitting a cohort query.
`SubmitCohortQueryBody`	Model for the body of a cohort query submission.
`TrustDetails`	Model for trust details in cohort query submission.
`SubmitCohortQueryOutput`	Output model for cohort query submission.
`CohortQueryInput`	Input model for cohort query submission.
`SubmitCohortQueryInput`	Input model for submitting a cohort query with authentication token.

Module Contents

class flip_api.domain.schemas.cohort.CohortResultsAge

Bases: pydantic.BaseModel

Model for age statistics in cohort results.

mean: float

class flip_api.domain.schemas.cohort.CohortResultsGender

Bases: pydantic.BaseModel

Model for gender statistics in cohort results.

male: int

female: int

MissingData: int

class flip_api.domain.schemas.cohort.CohortResultsClientVisit

Bases: pydantic.BaseModel

Model for client visit statistics in cohort results.

Inpatient: int

Emergency: int

MissingData: int

class flip_api.domain.schemas.cohort.ResultsStats

Bases: pydantic.BaseModel

Model for results statistics in cohort results.

TotalCount: int

Age: CohortResultsAge

Gender: CohortResultsGender

ClientVisit: CohortResultsClientVisit

class flip_api.domain.schemas.cohort.ReceivedCohortResults

Bases: pydantic.BaseModel

Model for received cohort results.

project_id: str

query_id: str

trust_id: str

QueryName: str

Result: ResultsStats

class flip_api.domain.schemas.cohort.CohortResultDataResponse

Bases: pydantic.BaseModel

Response model for cohort result data.

data: str

class flip_api.domain.schemas.cohort.Results

Bases: pydantic.BaseModel

Model for individual results in OMOP trust results.

value: str

count: int

class flip_api.domain.schemas.cohort.OMOPTrustResults

Bases: pydantic.BaseModel

Model for OMOP trust results.

trust_name: str

trust_id: str

data: list[Results]

model_config

class flip_api.domain.schemas.cohort.OMOPResult

Bases: pydantic.BaseModel

Model for OMOP results.

name: str

results: list[OMOPTrustResults]

class flip_api.domain.schemas.cohort.OmopCohortResultsResponse

Bases: pydantic.BaseModel

Response model for OMOP cohort results.

record_count: int

trusts_results: list[OMOPResult]

trust_record_counts: dict[str, int]

trust_errors: dict[str, str]

trust_suppressed: list[str]

model_config

class flip_api.domain.schemas.cohort.OMOPDbResult

Bases: pydantic.BaseModel

Model for OMOP database results.

stats: str

class flip_api.domain.schemas.cohort.SubmitCohortQuery

Bases: pydantic.BaseModel

Model for submitting a cohort query.

authenticationToken: str

query: str

name: str

project_id: uuid.UUID

query_id: uuid.UUID

class flip_api.domain.schemas.cohort.SubmitCohortQueryBody

Bases: pydantic.BaseModel

Model for the body of a cohort query submission.

query: str

query_name: str

encrypted_project_id: str

query_id: uuid.UUID

trust_id: str

class flip_api.domain.schemas.cohort.TrustDetails

Bases: pydantic.BaseModel

Model for trust details in cohort query submission.

name: str

statusCode: int

message: str | None = None

class flip_api.domain.schemas.cohort.SubmitCohortQueryOutput

Bases: pydantic.BaseModel

Output model for cohort query submission.

trust: list[TrustDetails]

query_id: uuid.UUID

model_config

class flip_api.domain.schemas.cohort.CohortQueryInput

Bases: pydantic.BaseModel

Input model for cohort query submission.

query: str

name: str

project_id: uuid.UUID

model_config

class flip_api.domain.schemas.cohort.SubmitCohortQueryInput

Bases: CohortQueryInput

Input model for submitting a cohort query with authentication token.

authenticationToken: str

query_id: uuid.UUID