1. Clinical Genomic APIs for Oracle Healthcare Foundation
  2. Tasks
  3. Cohort Selection
  4. Subject

Retrieve Subjects Count

post

/ohfapi/cg/v3.3/subjectapi/subjects/queries/count

This endpoint supports the retrieval of Count of Subjects by Query Name or Criteria.

Request

Supported Media Types
Body ()
Cohort Query Name,Creation Date,Retention Date Details for Subject
Root Schema : APIQueryRequest
Type: object
Show Source
Nested Schema : AllCriteriaList
Type: object
Contains all the Query Criteria
Show Source
  • 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
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
Nested Schema : criteria
Type: object
Discriminator: type
Show Source
Security
Back to Top

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : schema
Type: integer
Back to Top

Examples

The following example submits a POST request. See the Criteria Classes for this endpoint.

API URL

http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects/queries/count

Example of Request Body

The following example shows the request sent in JSON format.

{
    "queryCriteria" : {
            "allCriteriaList" : [
           {
            "type" : "DiagnosisCriteria",
            "diagnosisCodeList": ["S280","M518","C9000","C9001","C900"]
           },
           {
        "type":"SequenceVariantsCriteria",
        "exclude":false,
        "radioOptionMode":"VARS_IN_GEN_REGION",
        "genomicPosition" : "CHR1:1,200,000-1,900,000",
        "genomicPositionAlignment" : "GRCh37",
        "variantTypesList":[
           {
              "variantType":"deletion"
           }
        ]
    },
           {
            "type" : "HistoryCriteria",
            "historyCodeList": ["9822","1937","1"]
           }
        ]
    }
}

Example of Response Body

The following example shows the response returned in JSON format.

3
Back to Top