UNPKG

21.4 kBJSONView Raw
1{"openapi":"3.0.0","info":{"contact":{"x-twitter":"Infermedica"},"description":"Empower your healthcare services with intelligent diagnostic insights of Infermedica API.","title":"Infermedica","version":"v2","x-logo":{"backgroundColor":"#1576D1","url":"https://twitter.com/Infermedica/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://api.infermedica.com/v2/swagger.json","version":"2.0"}],"x-providerName":"infermedica.com"},"tags":[{"name":"info"},{"name":"diagnosis"},{"name":"explain"},{"name":"conditions"},{"name":"symptoms"},{"name":"lab_tests"},{"name":"risk_factors"},{"name":"search"},{"name":"parse"},{"name":"lookup"},{"name":"triage"},{"name":"suggest"}],"paths":{"/conditions":{"get":{"description":"Returns a list of all available conditions.","operationId":"getAllConditions","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Condition_Public"},"type":"array"}}}}},"summary":"List all conditions","tags":["conditions"]}},"/conditions/{id}":{"get":{"description":"Returns details of a single condition specified by id parameter.","operationId":"getCondition","parameters":[{"description":"condition id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Condition_Details"}}}},"400":{"description":"Invalid id specified"},"404":{"description":"Condition not found"}},"summary":"Get condition by id","tags":["conditions"]}},"/diagnosis":{"post":{"description":"Suggests possible diagnoses and relevant observations based on provided patient information.","operationId":"computeDiagnosis","requestBody":{"$ref":"#/components/requestBodies/DiagnosisRequest"},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagnosisResponse"}}}}},"summary":"Query diagnostic engine","tags":["diagnosis"]}},"/explain":{"post":{"description":"Explains which evidence impact probability of selected condition.","operationId":"getExplanation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExplanationRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExplanationResponse"}}}}},"summary":"Query diagnostic engine for explanation","tags":["explain"]}},"/info":{"get":{"description":"Returns information about data used by diagnostic engine.","operationId":"getDatabaseInfo","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Info_Public"}}}}},"summary":"Get database information","tags":["info"]}},"/lab_tests":{"get":{"description":"Returns a list of all available lab tests.","operationId":"getAllLabTests","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LabTest_Public"},"type":"array"}}}}},"summary":"List all lab tests","tags":["lab_tests"]}},"/lab_tests/{id}":{"get":{"description":"Returns details of a single lab test specified by id parameter.","operationId":"getLabTest","parameters":[{"description":"lab test id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabTest_Details"}}}},"400":{"description":"Invalid id specified"},"404":{"description":"Lab test not found"}},"summary":"Get lab test by id","tags":["lab_tests"]}},"/lookup":{"get":{"description":"Returns a single observation matching given phrase.","operationId":"getMatchingObservation","parameters":[{"description":"phrase to match","in":"query","name":"phrase","required":true,"schema":{"type":"string"}},{"description":"sex filter","in":"query","name":"sex","required":false,"schema":{"type":"string","enum":["male","female"]}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResult"}}}},"400":{"description":"Phrase missing or invalid sex specified"},"404":{"description":"No observation matches given phrase"}},"summary":"Find observation matching given phrase","tags":["lookup"]}},"/parse":{"post":{"description":"Returns list of mentions of observation found in given text.","operationId":"getMentions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParseRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParseResponse"}}}},"400":{"description":"Text too long"}},"summary":"Find mentions of observations in given text","tags":["parse"]}},"/risk_factors":{"get":{"description":"Returns a list of all available risk factors.","operationId":"getAllRiskFactors","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RiskFactor_Public"},"type":"array"}}}}},"summary":"List all risk factors","tags":["risk_factors"]}},"/risk_factors/{id}":{"get":{"description":"Returns details of a single risk factor specified by id parameter.","operationId":"getRiskFactor","parameters":[{"description":"risk factor id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskFactor_Details"}}}},"400":{"description":"Invalid id specified"},"404":{"description":"Risk factor not found"}},"summary":"Get risk factor by id","tags":["risk_factors"]}},"/search":{"get":{"description":"Returns list of observations matching the given phrase.","operationId":"getMatchingObservations","parameters":[{"description":"phrase to match","in":"query","name":"phrase","required":true,"schema":{"type":"string"}},{"description":"sex filter","in":"query","name":"sex","required":false,"schema":{"type":"string","enum":["male","female"]}},{"description":"maximum number of results","in":"query","name":"max_results","required":false,"schema":{"type":"integer","format":"int32","default":8}},{"description":"type of results","in":"query","name":"type","required":false,"explode":true,"schema":{"type":"array","items":{"enum":["symptom","risk_factor","lab_test"],"type":"string"}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SearchResult"},"type":"array"}}}},"400":{"description":"Phrase missing or invalid sex specified"}},"summary":"Find observations matching given phrase","tags":["search"]}},"/suggest":{"post":{"description":"Suggests possible symptoms based on provided patient information.","operationId":"getSuggestions","parameters":[{"description":"maximum number of results","in":"query","name":"max_results","required":false,"schema":{"type":"integer","format":"int32","default":8}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SuggestResult"},"type":"array"}}}}},"summary":"Query diagnostic engine for related symptoms","tags":["suggest"]}},"/symptoms":{"get":{"description":"Returns a list of all available symptoms.","operationId":"getAllSymptoms","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Symptom_Public"},"type":"array"}}}}},"summary":"List all symptoms","tags":["symptoms"]}},"/symptoms/{id}":{"get":{"description":"Returns details of a single symptom specified by id parameter.","operationId":"getSymptom","parameters":[{"description":"symptoms id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Symptom_Details"}}}},"400":{"description":"Invalid id specified"},"404":{"description":"symptom not found"}},"summary":"Get symptoms by id","tags":["symptoms"]}},"/triage":{"post":{"description":"Estimates triage level based on provided patient information.","operationId":"computeDiagnosis_1","requestBody":{"$ref":"#/components/requestBodies/DiagnosisRequest"},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriageResponse"}}}}},"summary":"Query diagnostic engine for triage level","tags":["triage"]}}},"servers":[{"url":"https://api.infermedica.com/v2"}],"components":{"requestBodies":{"DiagnosisRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagnosisRequest"}}},"required":true}},"schemas":{"Choice":{"properties":{"id":{"enum":["present","absent","unknown"],"type":"string"},"label":{"type":"string"}},"required":["id","label"],"type":"object"},"ConditionProbability":{"properties":{"common_name":{"description":"condition common name","type":"string"},"id":{"description":"condition id","type":"string"},"name":{"description":"condition name","type":"string"},"probability":{"format":"double","type":"number"}},"required":["id","name","probability"],"type":"object"},"Condition_Details":{"properties":{"acuteness":{"enum":["chronic","chronic_with_exacerbations","acute_potentially_chronic","acute"],"type":"string"},"categories":{"items":{"type":"string"},"type":"array"},"common_name":{"type":"string"},"extras":{"additionalProperties":{"type":"object"},"description":"additional content, like custom properties or images","type":"object"},"id":{"type":"string"},"name":{"type":"string"},"prevalence":{"enum":["very_rare","rare","moderate","common"],"type":"string"},"severity":{"enum":["mild","moderate","severe"],"type":"string"},"sex_filter":{"enum":["both","male","female"],"type":"string"},"triage_level":{"enum":["emergency","consultation","self_care"],"type":"string"}},"required":["categories","id","name","sex_filter"],"type":"object"},"Condition_Public":{"properties":{"acuteness":{"enum":["chronic","chronic_with_exacerbations","acute_potentially_chronic","acute"],"type":"string"},"categories":{"items":{"type":"string"},"type":"array"},"common_name":{"type":"string"},"extras":{"additionalProperties":{"type":"object"},"description":"additional content, like custom properties or images","type":"object"},"id":{"type":"string"},"name":{"type":"string"},"prevalence":{"enum":["very_rare","rare","moderate","common"],"type":"string"},"severity":{"enum":["mild","moderate","severe"],"type":"string"},"sex_filter":{"enum":["both","male","female"],"type":"string"},"triage_level":{"enum":["emergency","consultation","self_care"],"type":"string"}},"required":["categories","id","name","sex_filter"],"type":"object"},"DiagnosisRequest":{"properties":{"age":{"format":"int32","type":"integer"},"evaluated_at":{"description":"time when diagnosis was evaluated in ISO 8601 format","type":"string"},"evidence":{"items":{"$ref":"#/components/schemas/Evidence"},"type":"array"},"extras":{"additionalProperties":{"type":"object"},"type":"object"},"sex":{"enum":["male","female"],"type":"string"}},"required":["age","sex"],"type":"object"},"DiagnosisResponse":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/ConditionProbability"},"type":"array"},"extras":{"additionalProperties":{"type":"object"},"type":"object"},"question":{"$ref":"#/components/schemas/Question"},"should_stop":{"type":"boolean"}},"type":"object"},"Evidence":{"properties":{"choice_id":{"enum":["present","absent","unknown"],"type":"string"},"id":{"description":"id of observation or condition","type":"string"},"initial":{"description":"true for initial evidence, false for evidence reported during interview","type":"boolean"},"observed_at":{"description":"time when evidence was observed in ISO 8601 format","type":"string"},"related":{"description":"true for related evidence, false for evidence reported during interview","type":"boolean"}},"required":["choice_id","id"],"type":"object"},"ExplanationEvidence":{"properties":{"common_name":{"description":"observation common name","type":"string"},"id":{"description":"observation id","type":"string"},"name":{"description":"observation name","type":"string"}},"required":["id","name"],"type":"object"},"ExplanationRequest":{"properties":{"age":{"format":"int32","type":"integer"},"evaluated_at":{"description":"time when diagnosis was evaluated in ISO 8601 format","type":"string"},"evidence":{"items":{"$ref":"#/components/schemas/Evidence"},"type":"array"},"extras":{"additionalProperties":{"type":"object"},"type":"object"},"sex":{"enum":["male","female"],"type":"string"},"target":{"description":"target condition id","type":"string"}},"required":["age","sex","target"],"type":"object"},"ExplanationResponse":{"properties":{"conflicting_evidence":{"description":"conflicting evidence","items":{"$ref":"#/components/schemas/ExplanationEvidence"},"type":"array"},"supporting_evidence":{"description":"supporting evidence","items":{"$ref":"#/components/schemas/ExplanationEvidence"},"type":"array"},"unconfirmed_evidence":{"description":"unconfirmed evidence","items":{"$ref":"#/components/schemas/ExplanationEvidence"},"type":"array"}},"required":["conflicting_evidence","supporting_evidence","unconfirmed_evidence"],"type":"object"},"Info_Public":{"properties":{"conditions_count":{"format":"int32","type":"integer"},"lab_tests_count":{"format":"int32","type":"integer"},"risk_factors_count":{"format":"int32","type":"integer"},"symptoms_count":{"format":"int32","type":"integer"},"updated_at":{"description":"time of last model update in ISO 8601 format","type":"string"}},"required":["conditions_count","lab_tests_count","risk_factors_count","symptoms_count","updated_at"],"type":"object"},"LabTestResult_Details":{"properties":{"id":{"type":"string"},"type":{"enum":["very_low","low","normal","high","very_high","absent","present"],"type":"string"}},"required":["id","type"],"type":"object"},"LabTestResult_Public":{"properties":{"id":{"type":"string"},"type":{"enum":["very_low","low","normal","high","very_high","absent","present"],"type":"string"}},"required":["id","type"],"type":"object"},"LabTest_Details":{"properties":{"category":{"type":"string"},"common_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabTestResult_Details"},"type":"array"}},"required":["id","name"],"type":"object"},"LabTest_Public":{"properties":{"category":{"type":"string"},"common_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabTestResult_Public"},"type":"array"}},"required":["id","name"],"type":"object"},"ObservationMention":{"properties":{"choice_id":{"enum":["present","absent","unknown"],"type":"string"},"common_name":{"description":"observation common name","type":"string"},"head_position":{"format":"int32","type":"integer"},"id":{"description":"observation id","type":"string"},"name":{"description":"observation name","type":"string"},"orth":{"type":"string"},"positions":{"items":{"format":"int32","type":"integer"},"type":"array"}},"required":["choice_id","head_position","id","name","orth","positions"],"type":"object"},"ParseRequest":{"properties":{"concept_types":{"description":"list of concept types that should be captured","items":{"enum":["symptom","risk_factor"],"type":"string"},"type":"array"},"context":{"description":"ordered list of ids of present symptoms that were already captured and can be used as context","items":{"type":"string"},"type":"array"},"correct_spelling":{"description":"correct spelling of input text before proper analysis","type":"boolean"},"include_tokens":{"description":"include tokenization details in output","type":"boolean"},"text":{"description":"user text to process","type":"string"}},"required":["text"],"type":"object"},"ParseResponse":{"properties":{"mentions":{"description":"list of recognized symptom or risk factor mentions","items":{"$ref":"#/components/schemas/ObservationMention"},"type":"array"},"obvious":{"description":"indicates that entire input text has been parsed successfully and unambiguously","type":"boolean"},"tokens":{"items":{"type":"string"},"type":"array"}},"required":["mentions","obvious"],"type":"object"},"Question":{"properties":{"extras":{"additionalProperties":{"type":"object"},"description":"additional content, like images or HTML","type":"object"},"items":{"description":"one or more observations to evaluate","items":{"$ref":"#/components/schemas/QuestionItem"},"type":"array"},"text":{"description":"question text","type":"string"},"type":{"enum":["single","group_single","group_multiple"],"type":"string"}},"required":["items","text"],"type":"object"},"QuestionItem":{"properties":{"choices":{"description":"list of available answer choices","items":{"$ref":"#/components/schemas/Choice"},"type":"array"},"id":{"description":"observation id","type":"string"},"name":{"description":"name or alias of observation","type":"string"}},"required":["choices","id","name"],"type":"object"},"RiskFactor_Details":{"properties":{"category":{"type":"string"},"common_name":{"type":"string"},"extras":{"additionalProperties":{"type":"object"},"description":"additional content, like custom properties or images","type":"object"},"id":{"type":"string"},"image_source":{"type":"string"},"image_url":{"type":"string"},"name":{"type":"string"},"question":{"description":"only available in object details, not in listing","type":"string"},"sex_filter":{"enum":["both","male","female"],"type":"string"}},"required":["id","name","question","sex_filter"],"type":"object"},"RiskFactor_Public":{"properties":{"category":{"type":"string"},"common_name":{"type":"string"},"extras":{"additionalProperties":{"type":"object"},"description":"additional content, like custom properties or images","type":"object"},"id":{"type":"string"},"image_source":{"type":"string"},"image_url":{"type":"string"},"name":{"type":"string"},"sex_filter":{"enum":["both","male","female"],"type":"string"}},"required":["id","name","sex_filter"],"type":"object"},"SearchResult":{"properties":{"id":{"type":"string"},"label":{"description":"matched phrase, name or its synonym","type":"string"}},"required":["id","label"],"type":"object"},"SeriousObservation":{"properties":{"common_name":{"description":"observation common name","type":"string"},"id":{"description":"observation id","type":"string"},"is_emergency":{"type":"boolean"},"name":{"description":"observation name","type":"string"}},"required":["id","name"],"type":"object"},"SuggestRequest":{"properties":{"age":{"format":"int32","type":"integer"},"evaluated_at":{"description":"time when diagnosis was evaluated in ISO 8601 format","type":"string"},"evidence":{"items":{"$ref":"#/components/schemas/Evidence"},"type":"array"},"extras":{"additionalProperties":{"type":"object"},"type":"object"},"sex":{"enum":["male","female"],"type":"string"}},"type":"object"},"SuggestResult":{"properties":{"common_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"Symptom_Details":{"properties":{"category":{"type":"string"},"children":{"description":"list of child symptoms","type":"object"},"common_name":{"type":"string"},"extras":{"additionalProperties":{"type":"object"},"description":"additional content, like custom properties or images","type":"object"},"id":{"type":"string"},"image_source":{"type":"string"},"image_url":{"type":"string"},"name":{"type":"string"},"parent_id":{"description":"id of parent symptom","type":"string"},"parent_relation":{"description":"type of relation with parent symptom","enum":["base","duration","severity","character","exacerbating_factor","diminishing_factor","location","radiation"],"type":"string"},"question":{"description":"only available in object details, not in listing","type":"string"},"sex_filter":{"enum":["both","male","female"],"type":"string"}},"required":["id","name","question","sex_filter"],"type":"object"},"Symptom_Public":{"properties":{"category":{"type":"string"},"children":{"description":"list of child symptoms","type":"object"},"common_name":{"type":"string"},"extras":{"additionalProperties":{"type":"object"},"description":"additional content, like custom properties or images","type":"object"},"id":{"type":"string"},"image_source":{"type":"string"},"image_url":{"type":"string"},"name":{"type":"string"},"parent_id":{"description":"id of parent symptom","type":"string"},"parent_relation":{"description":"type of relation with parent symptom","enum":["base","duration","severity","character","exacerbating_factor","diminishing_factor","location","radiation"],"type":"string"},"sex_filter":{"enum":["both","male","female"],"type":"string"}},"required":["id","name","sex_filter"],"type":"object"},"TriageResponse":{"properties":{"serious":{"items":{"$ref":"#/components/schemas/SeriousObservation"},"type":"array"},"triage_level":{"enum":["emergency","consultation","self_care"],"type":"string"}},"type":"object"}}}}
\No newline at end of file