Retrieve Patient Clinical Specimen Using Query Criteria
post
/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries
This endpoint supports the retrieval of all specimens of the patients identified for this query criteria. It returns Status information like Reference Links to Execution Status for checking Progress and to Access Results when the execution is done. Note: In future release this API would retrieve only the specimen which fall under the query criteria and not just all specimen of patients identified for this 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
- 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/post/responses/200/schema
Nested Schema : Link
Type:
object
- params
-
Type:
object
paramsAdditional Properties Allowed: additionalProperties - rel
-
Type:
string
- rels
-
Type:
array
rels - title
-
Type:
string
- type
-
Type:
string
- uri
-
Type:
string
(uri
) - uriBuilder
-
Type:
object
UriBuilder
Nested Schema : params
Nested Schema : rels
Type:
array
-
Type:
string
Nested Schema : UriBuilder
Type:
object
202 Response
Query accepted
400 Response
Invalid Parameters
406 Response
Failed to accept query
Examples
The following example submits a POST request. See the Criteria Classes for this endpoint.
API URL
http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries
Example of Request Body
The following example shows the request sent in JSON format.
{ "queryCriteria" : { "allCriteriaList" : [ { "type" : "MedicationCriteria", "medicationCodeList": ["1000000"], "medicationOutcomeCodeList":["1"] }, { "type":"SequenceVariantsCriteria", "fileTypeVCFSelected":true, "geneInformation":{ "type":"SequenceVariantsGeneDetails", "geneList":[ "BID" ], "dnaAlignmentList":[ "GRCh37" ], "dnaVersionList":[ 2 ] }, "geneRegionsList":[ "PROMOTER" ] } ] } }
Example of Response Body
The following example shows the response returned in JSON format.
[ { "rel": "status", "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/999" }, { "rel": "result", "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/999/data" } ]