1. REST API for Oracle Healthcare Translational Research
  2. Tasks
  3. Cohort Selection
  4. Patient

Retrieve Patients Count

post

/HSDataService-web/api/3.2.0/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 Parameter
Cohort Query Name,Creation Date,Retention Date Details for Patient
Root Schema : APIQueryRequest
Type: object
Nested Schema : OracleDBQueryDS
Type: object
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
Nested Schema : criteria
Type: object
Discriminator: type

Response

Supported Media Types
  • application/json
  • application/xml
200 Response
successful operation
Body
Root Schema : /paths/~1patientapi~1patients~1queries~1count/post/responses/200/schema
Type: integer

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:7001/HSDataService-web/api/3.2.0/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