{"openapi":"3.0.1","info":{"title":"Clinical Order Guidance Service","version":"v1","description":"The service delivers Clinical Order Guidance content that includes genetic test catalog records, the laboratories certified to perform them, and the diagnoses that support them to two kinds of consumer through one endpoint."},"paths":{"/abm/clinicalorderguidancesearch/v1":{"get":{"summary":"Clinical Order Guidance Content Search endpoint that returns relevant content based on the provided query parameters","tags":["COG_Content_Search"],"parameters":[{"name":"line_of_business","in":"query","schema":{"type":"string"}},{"name":"from_date","in":"query","schema":{"type":"string"}},{"name":"to_date","in":"query","schema":{"type":"string"}},{"name":"DEX_Z_Code","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"TestName","in":"query","schema":{"type":"string"}},{"name":"RenderingLabNPI","in":"query","schema":{"type":"string"}},{"name":"RenderingLabName","in":"query","schema":{"type":"string"}},{"name":"Clia","in":"query","schema":{"type":"string"}},{"name":"internal_lab_id","in":"query","schema":{"type":"string"}},{"name":"cpt_code","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"KitName","in":"query","schema":{"type":"string"}},{"name":"Genes","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"DIAGNOSIS_CODE","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}}}},"422":{"description":"Client Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}}}},"500":{"description":"Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}}}}},"security":[{"OAuth2":[]}],"servers":[{"url":"https://sandbox-apigw.optum.com"}]},"post":{"summary":"Clinical Order Guidance Content Search endpoint that returns relevant content based on the provided query parameters","tags":["COG_Content_Search"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/COGContentSearchRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}}}},"422":{"description":"Client Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}}}},"500":{"description":"Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"application/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}},"text/json":{"schema":{"$ref":"#/components/schemas/COGContentSearchOutputRecord"}}}}},"security":[{"OAuth2":[]}],"servers":[{"url":"https://sandbox-apigw.optum.com"}]}},"/abm/clinicalorderguidancehc/v1":{"get":{"summary":"This is the endpoint that confirms the Clinical Order Guidance service process is running and all critical dependencies(database, logs and configurations) are working.","tags":["HealthCheck"],"responses":{"200":{"description":"Success"},"500":{"description":"Server Error"}},"security":[{"OAuth2":[]}],"servers":[{"url":"https://sandbox-apigw.optum.com"}]}},"/clinicalorderguidance/api/PingCheck":{"get":{"summary":"Liveness check for the Clinical Order Guidance service.","tags":["PingCheck"],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}},"servers":[{"url":"https://uat.abm.o360.cloud"}]}}},"components":{"schemas":{"ApiError":{"type":"object","properties":{"code":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"$ref":"#/components/schemas/ApiErrorDetail"},"nullable":true}},"additionalProperties":false},"ApiErrorDetail":{"type":"object","properties":{"field":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"additionalProperties":false},"COGContentSearchOutputRecord":{"type":"object","properties":{"requestParameters":{"nullable":true},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"error":{"$ref":"#/components/schemas/ApiError"},"isSuccessful":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Result"},"nullable":true}},"additionalProperties":false},"COGContentSearchRequest":{"type":"object","properties":{"line_of_business":{"type":"string","nullable":true},"from_date":{"type":"string","nullable":true},"to_date":{"type":"string","nullable":true},"DEX_Z_Code":{"type":"array","items":{"type":"string"},"nullable":true},"TestName":{"type":"string","nullable":true},"RenderingLabNPI":{"type":"string","nullable":true},"RenderingLabName":{"type":"string","nullable":true},"Clia":{"type":"string","nullable":true},"internal_lab_id":{"type":"string","nullable":true},"cpt_code":{"type":"array","items":{"type":"string"},"nullable":true},"KitName":{"type":"string","nullable":true},"Genes":{"type":"array","items":{"type":"string"},"nullable":true},"DIAGNOSIS_CODE":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Diagnosis":{"type":"object","properties":{"DIAGNOSIS_CODE":{"type":"string","nullable":true},"EFFECTIVE_DATE":{"type":"string","format":"date","nullable":true},"EXPIRATION_DATE":{"type":"string","format":"date","nullable":true},"Covered":{"type":"string","nullable":true},"Source":{"type":"string","nullable":true}},"additionalProperties":false},"LabReference":{"type":"object","properties":{"Clia":{"type":"string","nullable":true},"LabName":{"type":"string","nullable":true},"CLIAStatus":{"type":"string","nullable":true},"CLIAExpDate":{"type":"string","format":"date","nullable":true},"CLIARiskIndicator":{"type":"string","nullable":true},"CLIAStatusAsOfDate":{"type":"string","format":"date","nullable":true}},"additionalProperties":false},"LaboratoryAttributes":{"type":"object","properties":{"RenderingLabName":{"type":"string","nullable":true},"RenderingLabNPI":{"type":"string","nullable":true},"OrgType":{"type":"string","nullable":true},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/LabReference"},"nullable":true}},"additionalProperties":false},"PerformingLab":{"type":"object","properties":{"laboratoryAttributes":{"$ref":"#/components/schemas/LaboratoryAttributes"},"thisTest":{"$ref":"#/components/schemas/ThisTest"}},"additionalProperties":false},"ResponseMeta":{"type":"object","properties":{"total_count":{"type":"integer","format":"int32"},"empty_result_message":{"type":"string","nullable":true}},"additionalProperties":false},"Result":{"type":"object","properties":{"zCode":{"type":"string","nullable":true},"testAttributes":{"$ref":"#/components/schemas/TestAttributes"},"diagnosis":{"type":"array","items":{"$ref":"#/components/schemas/Diagnosis"},"nullable":true},"performingLabs":{"type":"array","items":{"$ref":"#/components/schemas/PerformingLab"},"nullable":true}},"additionalProperties":false},"TestAttributes":{"type":"object","properties":{"DEX_Z_Code":{"type":"string","nullable":true},"DEX_CPT":{"type":"string","nullable":true},"CMS_Policy_Number":{"type":"string","nullable":true},"TechnicalAssessmentRationale":{"type":"string","nullable":true},"TechnicalAssessmentResult":{"type":"string","nullable":true},"MedicareCovered":{"type":"string","nullable":true},"FDA501kStatus":{"type":"string","nullable":true},"AnalyticalValidity":{"type":"string","nullable":true},"ClinicalUtility":{"type":"string","nullable":true},"ClinicalValidity":{"type":"string","nullable":true},"KitIndicator":{"type":"string","nullable":true},"DiagnosisCount":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"ThisTest":{"type":"object","properties":{"TestName":{"type":"string","nullable":true},"InternalLabOrderId":{"type":"array","items":{"type":"string"},"nullable":true},"RecordEffectiveDate":{"type":"string","format":"date","nullable":true},"RecordEndDate":{"type":"string","format":"date","nullable":true},"LastDateModified":{"type":"string","format":"date","nullable":true},"LabRecommendedCPT":{"type":"array","items":{"type":"string"},"nullable":true},"EstablishedClassification":{"type":"string","nullable":true},"TestType":{"type":"array","items":{"type":"string"},"nullable":true},"Genes":{"type":"array","items":{"type":"string"},"nullable":true},"Methodology":{"type":"string","nullable":true},"AlgorithmIndicator":{"type":"string","nullable":true},"ComparableAssays":{"type":"string","nullable":true},"FDANumber":{"type":"array","items":{"type":"string"},"nullable":true},"FDAModifications":{"type":"string","nullable":true},"KitName":{"type":"string","nullable":true},"KitManufacturer":{"type":"string","nullable":true},"mutation_type":{"type":"string","nullable":true},"FrequencyLimit":{"type":"string","nullable":true},"Units":{"type":"string","nullable":true},"BiologicalSex":{"type":"string","nullable":true},"TestDescription":{"type":"string","nullable":true},"GeneVariant":{"type":"array","items":{"type":"string"},"nullable":true},"ContributingComponents":{"type":"string","nullable":true},"SpecimenInstructions":{"type":"string","nullable":true}},"additionalProperties":false}},"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-apigw.optum.com/apip/auth/sntl/v1/token","scopes":{}}}}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}