flip_api.domain.schemas.cohort
==============================

.. py:module:: flip_api.domain.schemas.cohort


Classes
-------

.. autoapisummary::

   flip_api.domain.schemas.cohort.CohortResultsAge
   flip_api.domain.schemas.cohort.CohortResultsGender
   flip_api.domain.schemas.cohort.CohortResultsClientVisit
   flip_api.domain.schemas.cohort.ResultsStats
   flip_api.domain.schemas.cohort.ReceivedCohortResults
   flip_api.domain.schemas.cohort.CohortResultDataResponse
   flip_api.domain.schemas.cohort.Results
   flip_api.domain.schemas.cohort.OMOPTrustResults
   flip_api.domain.schemas.cohort.OMOPResult
   flip_api.domain.schemas.cohort.OmopCohortResultsResponse
   flip_api.domain.schemas.cohort.OMOPDbResult
   flip_api.domain.schemas.cohort.SubmitCohortQuery
   flip_api.domain.schemas.cohort.SubmitCohortQueryBody
   flip_api.domain.schemas.cohort.TrustDetails
   flip_api.domain.schemas.cohort.SubmitCohortQueryOutput
   flip_api.domain.schemas.cohort.CohortQueryInput
   flip_api.domain.schemas.cohort.SubmitCohortQueryInput


Module Contents
---------------

.. py:class:: CohortResultsAge

   Bases: :py:obj:`pydantic.BaseModel`


   Model for age statistics in cohort results.


   .. py:attribute:: mean
      :type:  float


.. py:class:: CohortResultsGender

   Bases: :py:obj:`pydantic.BaseModel`


   Model for gender statistics in cohort results.


   .. py:attribute:: male
      :type:  int


   .. py:attribute:: female
      :type:  int


   .. py:attribute:: MissingData
      :type:  int


.. py:class:: CohortResultsClientVisit

   Bases: :py:obj:`pydantic.BaseModel`


   Model for client visit statistics in cohort results.


   .. py:attribute:: Inpatient
      :type:  int


   .. py:attribute:: Emergency
      :type:  int


   .. py:attribute:: MissingData
      :type:  int


.. py:class:: ResultsStats

   Bases: :py:obj:`pydantic.BaseModel`


   Model for results statistics in cohort results.


   .. py:attribute:: TotalCount
      :type:  int


   .. py:attribute:: Age
      :type:  CohortResultsAge


   .. py:attribute:: Gender
      :type:  CohortResultsGender


   .. py:attribute:: ClientVisit
      :type:  CohortResultsClientVisit


.. py:class:: ReceivedCohortResults

   Bases: :py:obj:`pydantic.BaseModel`


   Model for received cohort results.


   .. py:attribute:: project_id
      :type:  str


   .. py:attribute:: query_id
      :type:  str


   .. py:attribute:: trust_id
      :type:  str


   .. py:attribute:: QueryName
      :type:  str


   .. py:attribute:: Result
      :type:  ResultsStats


.. py:class:: CohortResultDataResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for cohort result data.


   .. py:attribute:: data
      :type:  str


.. py:class:: Results

   Bases: :py:obj:`pydantic.BaseModel`


   Model for individual results in OMOP trust results.


   .. py:attribute:: value
      :type:  str


   .. py:attribute:: count
      :type:  int


.. py:class:: OMOPTrustResults

   Bases: :py:obj:`pydantic.BaseModel`


   Model for OMOP trust results.


   .. py:attribute:: trust_name
      :type:  str


   .. py:attribute:: trust_id
      :type:  str


   .. py:attribute:: data
      :type:  list[Results]


   .. py:attribute:: model_config


.. py:class:: OMOPResult

   Bases: :py:obj:`pydantic.BaseModel`


   Model for OMOP results.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: results
      :type:  list[OMOPTrustResults]


.. py:class:: OmopCohortResultsResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for OMOP cohort results.


   .. py:attribute:: record_count
      :type:  int


   .. py:attribute:: trusts_results
      :type:  list[OMOPResult]


   .. py:attribute:: model_config


.. py:class:: OMOPDbResult

   Bases: :py:obj:`pydantic.BaseModel`


   Model for OMOP database results.


   .. py:attribute:: stats
      :type:  str


.. py:class:: SubmitCohortQuery

   Bases: :py:obj:`pydantic.BaseModel`


   Model for submitting a cohort query.


   .. py:attribute:: authenticationToken
      :type:  str


   .. py:attribute:: query
      :type:  str


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: project_id
      :type:  uuid.UUID


   .. py:attribute:: query_id
      :type:  uuid.UUID


.. py:class:: SubmitCohortQueryBody

   Bases: :py:obj:`pydantic.BaseModel`


   Model for the body of a cohort query submission.


   .. py:attribute:: query
      :type:  str


   .. py:attribute:: query_name
      :type:  str


   .. py:attribute:: encrypted_project_id
      :type:  str


   .. py:attribute:: query_id
      :type:  uuid.UUID


   .. py:attribute:: trust_id
      :type:  str


.. py:class:: TrustDetails

   Bases: :py:obj:`pydantic.BaseModel`


   Model for trust details in cohort query submission.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: statusCode
      :type:  int


   .. py:attribute:: message
      :type:  str | None
      :value: None



.. py:class:: SubmitCohortQueryOutput

   Bases: :py:obj:`pydantic.BaseModel`


   Output model for cohort query submission.


   .. py:attribute:: trust
      :type:  list[TrustDetails]


   .. py:attribute:: query_id
      :type:  uuid.UUID


   .. py:attribute:: model_config


.. py:class:: CohortQueryInput

   Bases: :py:obj:`pydantic.BaseModel`


   Input model for cohort query submission.


   .. py:attribute:: query
      :type:  str


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: project_id
      :type:  uuid.UUID


   .. py:attribute:: model_config


.. py:class:: SubmitCohortQueryInput

   Bases: :py:obj:`CohortQueryInput`


   Input model for submitting a cohort query with authentication token.


   .. py:attribute:: authenticationToken
      :type:  str


   .. py:attribute:: query_id
      :type:  uuid.UUID