Retrieve Count of Patient Specimens for a Query Name/Criteria
post
/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/count
This endpoint supports the retrieval of Count of Patient Specimens based for a Query Name or Criteria provided.
Request
Supported Media Types
- application/json
- application/xml
Body Parameter
Cohort Query Name,Creation Date,Retention Date details
Root Schema : APIQueryRequest
Type:
object
- cohortQueryName
-
Type:
string
- createdOnDate
-
Type:
string
(date-time
) - executeAsync
-
Type:
boolean
Default Value:false
- minRetentionPeriodDays
-
Type:
integer
(int64
)Minimum Value:0
- queryCriteria
-
Type:
object
OracleDBQueryDSContains all the Query Criteria - retentionDate
-
Type:
string
(date-time
)
Nested Schema : OracleDBQueryDS
Type:
object
Contains all the Query Criteria
- allCriteriaList
-
Type:
array
allCriteriaListRequired:true
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
Nested Schema : criteria
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Body
Root Schema : /paths/~1patientapi~1clinicalspecimens~1queries~1count/post/responses/200/schema
Type:
integer
Examples
The following example submits a POST request. See the Criteria Classes for this endpoint.
Note: Based on the genomic information entered, patient identifiers are retrieved. Based on these patient identifiers, the specimens are retrieved.
API URL
http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/count
Example of Request Body
The following example shows the request sent in JSON format.
{ "queryCriteria" : { "allCriteriaList" : [ { "type" : "RelativeTimeEventsCriteria", "baseline" : { "diagnosisCodeList" : ["R092"] }, "comparator" : { "timeOperator" : "MORETHAN", "period" : "YEARS", "when" : "BEFORE", "numberPeriods" : "5", "atSpecificTime" : "true" }, "compareTo" : { "medicationCodeList" : ["104377"] } } ] } }
Example of Response Body
The following example shows the response returned in JSON format.
17