Jump to

• Request
• Response

Save Cohort for a Patient/Subject

post

/ohfapi/cg/v3.3/cohort

This endpoint supports authorized user to 'Save'/'Save as' a Cohort Criteria.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Cohort Criteria,Cohort Name,Cohort description,Cohort Privacy

Root Schema : SaveCohortModel

Type: object

Model for a Saving a Cohort.

Show Source

• cohortAccess: string
  Cohort Query Access
• cohortDesc(optional): string
  Cohort Query Description
• cohortId(optional): string
  Cohort Query Identifier(provided when updating an existing cohort)
• cohortName: string
  Cohort Query Name
• context: string
  Patient/Subject Context
• createdOnDate(optional): string(date-time)
• executeAsync(optional): boolean
• minRetentionPeriodDays(optional): integer(int64)
  Minimum Value: 0
• queryCriteria(optional): object AllCriteriaList
  Contains all the Query Criteria
• retentionDate(optional): string(date-time)

{
    "type":"object",
    "required":[
        "cohortAccess",
        "cohortName",
        "context"
    ],
    "properties":{
        "cohortName":{
            "type":"string",
            "description":"Cohort Query Name"
        },
        "cohortDesc":{
            "type":"string",
            "description":"Cohort Query Description"
        },
        "cohortId":{
            "type":"string",
            "description":"Cohort Query Identifier(provided when updating an existing cohort)"
        },
        "cohortAccess":{
            "type":"string",
            "description":"Cohort Query Access"
        },
        "context":{
            "type":"string",
            "description":"Patient/Subject Context"
        },
        "executeAsync":{
            "type":"boolean"
        },
        "minRetentionPeriodDays":{
            "type":"integer",
            "format":"int64",
            "minimum":0
        },
        "queryCriteria":{
            "description":"Cohort Query Criteria",
            "$ref":"#/definitions/OracleDBQueryDS"
        },
        "createdOnDate":{
            "type":"string",
            "format":"date-time"
        },
        "retentionDate":{
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"Model for a Saving a Cohort."
}

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
        }
    },
    "xml":{
        "name":"AllCriteriaList"
    },
    "description":"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

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

• disabled(optional): boolean
• exclude(optional): boolean

{
    "type":"object",
    "discriminator":"type",
    "properties":{
        "exclude":{
            "type":"boolean"
        },
        "disabled":{
            "type":"boolean"
        }
    }
}

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Saved successfully

400 Response

Invalid parameters supplied

Back to Top