Jump to

• Request
• Response

Find Clinical Event Types

get

/ohfapi/cg/v3.3/dimension/{dimensiontype}/{clinicalType}

This end point finds the matching values for the corresponsding Dimension Type and Clinical Type provided.If the operator is null, then it defaults to equals. If limit is null then defaults to 100.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• clinicalType: string
  Clinical Event Type

  Allowed Values: [ "Diagnosis", "DiagnosisNameCode", "Severity", "SeverityNameCode", "Status", "StatusNameCode", "AnatomicalSite", "AnatomicalSiteNameCode", "HospitalAcquiredConcern", "CancerGrade", "CancerGradeNameCode", "CancerStage", "CancerStageNameCode", "StagingSystem", "StagingSystemNameCode", "PrimaryTumor", "PrimaryTumorNameCode", "NodeExtension", "NodeExtensionNameCode", "Metastasis", "MetastasisNameCode", "Datasource", "DatasourceNameCode", "Medication", "MedicationNameCode", "MedicationOutcome", "MedicationOutcomeNameCode", "Uom", "UomNameCode", "Procedure", "ProcedureNameCode", "ProcedureType", "ProcedureTypeNameCode", "ProcedureOutcome", "ProcedureOutcomeNameCode", "Observation", "ObservationNameCode", "CodedResult", "CodedResultNameCode", "TextResult", "PatientHistory", "HistoryNameCode", "HistoryValue", "HistoryValueNameCode", "HistoryApplicableTo", "Specimen", "SpecimenNameCode", "SpecimenNumber", "SpecimenVendorNumber", "SpecimenAlias", "ConsentType", "ConsentTypeNameCode", "Consent", "ConsentNameCode", "ConsentStatus", "ConsentStatusNameCode", "Encounter", "EncounterNameCode", "Facility", "FacilityNameCode" ]
• dimensiontype: string
  Dimension Type

  Allowed Values: [ "Diagnosis", "Procedure", "Medication", "Observation", "Consent", "History", "PatientHistory", "Specimen", "Encounter" ]

Query Parameters

• code(optional): string
  Dimension's Clinical Event parameters to be queried
• codeOperator(optional): string
  Dimension's Clinical Event parameters to be queried

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]
• limit(optional): integer(int32)
  Dimension's Clinical Event parameters to be queried
• name(optional): string
  Dimension's Clinical Event parameters to be queried
• nameOperator(optional): string
  Dimension's Clinical Event parameters to be queried

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]
• providerId(optional): string
  Dimension's Clinical Event parameters to be queried
• providerIdOperator(optional): string
  Dimension's Clinical Event parameters to be queried

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]
• providerName(optional): string
  Dimension's Clinical Event parameters to be queried
• providerNameOperator(optional): string
  Dimension's Clinical Event parameters to be queried

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]
• sysId(optional): array
  Collection Format: multi

  Dimension's Clinical Event parameters to be queried

  • [0]: string

  {
      "name":"sysId",
      "in":"query",
      "description":"Dimension's Clinical Event parameters to be queried",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• sysIdOperator(optional): string
  Dimension's Clinical Event parameters to be queried

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]
• sysName(optional): array
  Collection Format: multi

  Dimension's Clinical Event parameters to be queried

  • [0]: string

  {
      "name":"sysName",
      "in":"query",
      "description":"Dimension's Clinical Event parameters to be queried",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• sysNameOperator(optional): string
  Dimension's Clinical Event parameters to be queried

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]
• type(optional): string
  Dimension's Clinical Event parameters to be queried
• typeOperator(optional): string
  Dimension's Clinical Event parameters to be queried

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Invalid parameters supplied

404 Response

No data found

Back to Top