Jump to

• Request
• Response
• Examples

Retrieve Patients Count

post

/ohfapi/cg/v3.3/patientapi/patients/queries/count

This endpoint supports the retrieval of Patient Count based on Query Name or Criteria.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Cohort Query Name,Creation Date,Retention Date Details for Patient

Root Schema : APIQueryRequest

Type: object

Show Source

• cohortQueryName(optional): string
• createdOnDate(optional): string(date-time)
• executeAsync(optional): boolean
• minRetentionPeriodDays(optional): integer(int64)
  Minimum Value: 0
• queryCriteria(optional): object AllCriteriaList
  Contains all the Query Criteria
• retentionDate(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "executeAsync":{
            "type":"boolean"
        },
        "cohortQueryName":{
            "type":"string"
        },
        "minRetentionPeriodDays":{
            "type":"integer",
            "format":"int64",
            "minimum":0
        },
        "queryCriteria":{
            "$ref":"#/definitions/OracleDBQueryDS"
        },
        "createdOnDate":{
            "type":"string",
            "format":"date-time"
        },
        "retentionDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : AllCriteriaList

Type: object

Contains all the Query Criteria

Show Source

• allCriteriaList: array allCriteriaList
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria

{
    "type":"object",
    "required":[
        "allCriteriaList"
    ],
    "properties":{
        "allCriteriaList":{
            "type":"array",
            "description":"List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria",
            "items":{
                "$ref":"#/definitions/criteria"
            },
            "maxItems":2147483647,
            "minItems":1
        }
    },
    "xml":{
        "name":"AllCriteriaList"
    },
    "description":"Contains all the Query Criteria"
}

Nested Schema : allCriteriaList

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria

Show Source

• Array of: object criteria
  Discriminator: type

{
    "type":"array",
    "description":"List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria",
    "items":{
        "$ref":"#/definitions/criteria"
    },
    "maxItems":2147483647,
    "minItems":1
}

Nested Schema : criteria

Type: object

Discriminator: type

Show Source

• disabled(optional): boolean
• exclude(optional): boolean

{
    "type":"object",
    "discriminator":"type",
    "properties":{
        "exclude":{
            "type":"boolean"
        },
        "disabled":{
            "type":"boolean"
        }
    }
}

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : schema

Type: integer

Back to Top

Examples

The following example shows how to view a list of patient count by submitting a POST request. See the Criteria Classes for this endpoint.

API URL

http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/queries/count

Example of Request Body

The following example shows the request sent in JSON format.

{
   "queryCriteria":{
      "allCriteriaList":[
         {
            "type":"SpecimenCriteria",
            "specimenTypeCodeList":[
               "57003"
            ]
         },
         {
            "type":"SequenceVariantsCriteria",
            "exclude":false,
            "radioOptionMode":"VAR_IN_SELECTED_GENES",
            "geneInformation":{
               "type":"SequenceVariantsGeneDetails",
               "geneList":[
                  "TMIE"
               ],
               "dnaAlignmentList":[
                  "GRCh37"
               ]
            },
            "variantTypesList":[
               {
                  "variantType":"deletion",
                  "impacts":[
                     "in-frame deletion"
                  ]
               }
            ],
            "geneRegionsList":[
               "GENE"
            ]
         }
      ]
   }
}

Example of Response Body

The following example shows the response returned in JSON format.

5

Back to Top