openapi-directory/api/amazonaws.com/comprehendmedical.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2018-10-30","x-release":"v4","title":"AWS Comprehend Medical","description":" Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. ","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"comprehendmedical","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/comprehendmedical-2018-10-30.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/comprehendmedical/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/":{"post":{"operationId":"DetectEntities","description":" Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectEntitiesResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"484":{"description":"InvalidEncodingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidEncodingException"}}}},"485":{"description":"TextSizeLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextSizeLimitExceededException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectEntitiesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DetectPHI":{"post":{"operationId":"DetectPHI","description":" Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectPHIResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"484":{"description":"InvalidEncodingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidEncodingException"}}}},"485":{"description":"TextSizeLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextSizeLimitExceededException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectPHIRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"servers":[{"url":"https://comprehendmedical.amazonaws.com/"},{"url":"http://comprehendmedical.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"DetectEntitiesResponse":{"type":"object","required":["Entities"],"properties":{"Entities":{"$ref":"#/components/schemas/EntityList"},"UnmappedAttributes":{"$ref":"#/components/schemas/UnmappedAttributeList"},"PaginationToken":{"$ref":"#/components/schemas/String"}}},"DetectEntitiesRequest":{"type":"object","required":["Text"],"properties":{"Text":{"$ref":"#/components/schemas/BoundedLengthString"}}},"InternalServerException":{},"ServiceUnavailableException":{},"TooManyRequestsException":{},"InvalidRequestException":{},"InvalidEncodingException":{},"TextSizeLimitExceededException":{},"DetectPHIResponse":{"type":"object","required":["Entities"],"properties":{"Entities":{"$ref":"#/components/schemas/EntityList"},"PaginationToken":{"$ref":"#/components/schemas/String"}}},"DetectPHIRequest":{"type":"object","required":["Text"],"properties":{"Text":{"$ref":"#/components/schemas/BoundedLengthString"}}},"EntitySubType":{"type":"string","enum":["NAME","DOSAGE","ROUTE_OR_MODE","FORM","FREQUENCY","DURATION","GENERIC_NAME","BRAND_NAME","STRENGTH","RATE","ACUITY","TEST_NAME","TEST_VALUE","TEST_UNITS","PROCEDURE_NAME","TREATMENT_NAME","DATE","AGE","CONTACT_POINT","EMAIL","IDENTIFIER","URL","ADDRESS","PROFESSION","SYSTEM_ORGAN_SITE","DIRECTION","QUALITY","QUANTITY"]},"Float":{"type":"number","format":"float"},"Integer":{"type":"integer"},"String":{"type":"string","minLength":1},"TraitList":{"type":"array","items":{"$ref":"#/components/schemas/Trait"}},"Attribute":{"type":"object","properties":{"Type":{"$ref":"#/components/schemas/EntitySubType"},"Score":{"$ref":"#/components/schemas/Float"},"RelationshipScore":{"$ref":"#/components/schemas/Float"},"Id":{"$ref":"#/components/schemas/Integer"},"BeginOffset":{"$ref":"#/components/schemas/Integer"},"EndOffset":{"$ref":"#/components/schemas/Integer"},"Text":{"$ref":"#/components/schemas/String"},"Traits":{"$ref":"#/components/schemas/TraitList"}},"description":" An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text. "},"AttributeList":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"AttributeName":{"type":"string","enum":["SIGN","SYMPTOM","DIAGNOSIS","NEGATION"]},"BoundedLengthString":{"type":"string","minLength":1,"maxLength":20000},"EntityList":{"type":"array","items":{"$ref":"#/components/schemas/Entity"}},"UnmappedAttributeList":{"type":"array","items":{"$ref":"#/components/schemas/UnmappedAttribute"}},"EntityType":{"type":"string","enum":["MEDICATION","MEDICAL_CONDITION","PROTECTED_HEALTH_INFORMATION","TEST_TREATMENT_PROCEDURE","ANATOMY"]},"Entity":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Integer"},"BeginOffset":{"$ref":"#/components/schemas/Integer"},"EndOffset":{"$ref":"#/components/schemas/Integer"},"Score":{"$ref":"#/components/schemas/Float"},"Text":{"$ref":"#/components/schemas/String"},"Category":{"$ref":"#/components/schemas/EntityType"},"Type":{"$ref":"#/components/schemas/EntitySubType"},"Traits":{"$ref":"#/components/schemas/TraitList"},"Attributes":{"$ref":"#/components/schemas/AttributeList"}},"description":" Provides information about an extracted medical entity."},"Trait":{"type":"object","properties":{"Name":{"$ref":"#/components/schemas/AttributeName"},"Score":{"$ref":"#/components/schemas/Float"}},"description":" Provides contextual information about the extracted entity. "},"UnmappedAttribute":{"type":"object","properties":{"Type":{"$ref":"#/components/schemas/EntityType"},"Attribute":{"$ref":"#/components/schemas/Attribute"}},"description":" An attribute that we extracted, but were unable to relate to an entity. "}}}}