Clinical Genomic APIs for Oracle Healthcare Foundation

Retrieve Count of Patient Specimens for a Query Name/Criteria

post

/ohfapi/cg/v3.3/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

Cohort Query Name,Creation Date,Retention Date details

Root Schema : APIQueryRequest

Type: object

Show Source

cohortQueryName(optional): string
createdOnDate(optional): string(date-time)
executeAsync(optional): boolean

Default Value: false
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",
            "default":false
        },
        "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
        }
    },
    "description":"Contains all the Query Criteria",
    "xml":{
        "name":"AllCriteriaList"
    }
}

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

exclude(optional): boolean

Default Value: false

{
    "type":"object",
    "discriminator":"type",
    "properties":{
        "exclude":{
            "type":"boolean",
            "default":false
        }
    }
}

Security

basicAuth: basic

Type: basic

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Root Schema : 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:7010/ohfapi/cg/v3.3/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.