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 TypeAllowed 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 TypeAllowed 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 queriedAllowed 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 queriedAllowed 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 queriedAllowed 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 queriedAllowed Values:
[ "Equals", "StartsWith", "Contains", "NotEquals" ]
- sysId(optional): array
-
sysIdOperator(optional): string
Dimension's Clinical Event parameters to be queriedAllowed Values:
[ "Equals", "StartsWith", "Contains", "NotEquals" ]
- sysName(optional): array
-
sysNameOperator(optional): string
Dimension's Clinical Event parameters to be queriedAllowed 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 queriedAllowed Values:
[ "Equals", "StartsWith", "Contains", "NotEquals" ]
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Nested Schema : items
Type:
object
400 Response
Invalid parameters supplied
404 Response
No data found