{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-comprehendmedical","description":"AWS Comprehend Medical","version":"2018-10-30","base_url":"","endpoints":26,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS Comprehend Medical\n@version 2018-10-30\n@auth AWS SigV4\n@endpoints 26\n@hint download_for_search\n@toc root(26)\n\n@endpoint POST /\n@desc Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.\n@required {JobId: str}\n@returns(200) {ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobProperties?{JobId: str?, JobName: str?, JobStatus: str?, Message: str?, SubmitTime: str(timestamp)?, EndTime: str(timestamp)?, ExpirationTime: str(timestamp)?, InputDataConfig: InputDataConfig?{S3Bucket: str, S3Key: str?}, OutputDataConfig: OutputDataConfig?{S3Bucket: str, S3Key: str?}, LanguageCode: str?, DataAccessRoleArn: str?, ManifestFilePath: str?, KMSKey: str?, ModelVersion: str?}}\n\n@endpoint POST /\n@desc Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.\n@required {JobId: str}\n@returns(200) {ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobProperties?{JobId: str?, JobName: str?, JobStatus: str?, Message: str?, SubmitTime: str(timestamp)?, EndTime: str(timestamp)?, ExpirationTime: str(timestamp)?, InputDataConfig: InputDataConfig?{S3Bucket: str, S3Key: str?}, OutputDataConfig: OutputDataConfig?{S3Bucket: str, S3Key: str?}, LanguageCode: str?, DataAccessRoleArn: str?, ManifestFilePath: str?, KMSKey: str?, ModelVersion: str?}}\n\n@endpoint POST /\n@desc Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.\n@required {JobId: str}\n@returns(200) {ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobProperties?{JobId: str?, JobName: str?, JobStatus: str?, Message: str?, SubmitTime: str(timestamp)?, EndTime: str(timestamp)?, ExpirationTime: str(timestamp)?, InputDataConfig: InputDataConfig?{S3Bucket: str, S3Key: str?}, OutputDataConfig: OutputDataConfig?{S3Bucket: str, S3Key: str?}, LanguageCode: str?, DataAccessRoleArn: str?, ManifestFilePath: str?, KMSKey: str?, ModelVersion: str?}}\n\n@endpoint POST /\n@desc Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.\n@required {JobId: str}\n@returns(200) {ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobProperties?{JobId: str?, JobName: str?, JobStatus: str?, Message: str?, SubmitTime: str(timestamp)?, EndTime: str(timestamp)?, ExpirationTime: str(timestamp)?, InputDataConfig: InputDataConfig?{S3Bucket: str, S3Key: str?}, OutputDataConfig: OutputDataConfig?{S3Bucket: str, S3Key: str?}, LanguageCode: str?, DataAccessRoleArn: str?, ManifestFilePath: str?, KMSKey: str?, ModelVersion: str?}}\n\n@endpoint POST /\n@desc Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.\n@required {JobId: str}\n@returns(200) {ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobProperties?{JobId: str?, JobName: str?, JobStatus: str?, Message: str?, SubmitTime: str(timestamp)?, EndTime: str(timestamp)?, ExpirationTime: str(timestamp)?, InputDataConfig: InputDataConfig?{S3Bucket: str, S3Key: str?}, OutputDataConfig: OutputDataConfig?{S3Bucket: str, S3Key: str?}, LanguageCode: str?, DataAccessRoleArn: str?, ManifestFilePath: str?, KMSKey: str?, ModelVersion: str?}}\n\n@endpoint POST /\n@desc The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead. 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.\n@required {Text: str}\n@returns(200) {Entities: [Entity], UnmappedAttributes: [UnmappedAttribute]?, PaginationToken: str?, ModelVersion: str}\n\n@endpoint POST /\n@desc 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. Amazon Comprehend Medical only detects medical entities in English language texts. The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications. The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.\n@required {Text: str}\n@returns(200) {Entities: [Entity], UnmappedAttributes: [UnmappedAttribute]?, PaginationToken: str?, ModelVersion: str}\n\n@endpoint POST /\n@desc Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.\n@required {Text: str}\n@returns(200) {Entities: [Entity], PaginationToken: str?, ModelVersion: str}\n\n@endpoint POST /\n@desc InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.\n@required {Text: str}\n@returns(200) {Entities: [ICD10CMEntity], PaginationToken: str?, ModelVersion: str?}\n\n@endpoint POST /\n@desc InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.\n@required {Text: str}\n@returns(200) {Entities: [RxNormEntity], PaginationToken: str?, ModelVersion: str?}\n\n@endpoint POST /\n@desc InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology\n@required {Text: str}\n@returns(200) {Entities: [SNOMEDCTEntity], PaginationToken: str?, ModelVersion: str?, SNOMEDCTDetails: SNOMEDCTDetails?{Edition: str?, Language: str?, VersionDate: str?}, Characters: Characters?{OriginalTextCharacters: int?}}\n\n@endpoint POST /\n@desc Gets a list of medical entity detection jobs that you have submitted.\n@optional {Filter: ComprehendMedicalAsyncJobFilter, NextToken: str, MaxResults: int}\n@returns(200) {ComprehendMedicalAsyncJobPropertiesList: [ComprehendMedicalAsyncJobProperties]?, NextToken: str?}\n\n@endpoint POST /\n@desc Gets a list of InferICD10CM jobs that you have submitted.\n@optional {Filter: ComprehendMedicalAsyncJobFilter, NextToken: str, MaxResults: int}\n@returns(200) {ComprehendMedicalAsyncJobPropertiesList: [ComprehendMedicalAsyncJobProperties]?, NextToken: str?}\n\n@endpoint POST /\n@desc Gets a list of protected health information (PHI) detection jobs you have submitted.\n@optional {Filter: ComprehendMedicalAsyncJobFilter, NextToken: str, MaxResults: int}\n@returns(200) {ComprehendMedicalAsyncJobPropertiesList: [ComprehendMedicalAsyncJobProperties]?, NextToken: str?}\n\n@endpoint POST /\n@desc Gets a list of InferRxNorm jobs that you have submitted.\n@optional {Filter: ComprehendMedicalAsyncJobFilter, NextToken: str, MaxResults: int}\n@returns(200) {ComprehendMedicalAsyncJobPropertiesList: [ComprehendMedicalAsyncJobProperties]?, NextToken: str?}\n\n@endpoint POST /\n@desc Gets a list of InferSNOMEDCT jobs a user has submitted.\n@optional {Filter: ComprehendMedicalAsyncJobFilter, NextToken: str, MaxResults: int}\n@returns(200) {ComprehendMedicalAsyncJobPropertiesList: [ComprehendMedicalAsyncJobProperties]?, NextToken: str?}\n\n@endpoint POST /\n@desc Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.\n@required {InputDataConfig: InputDataConfig, OutputDataConfig: OutputDataConfig, DataAccessRoleArn: str, LanguageCode: str}\n@optional {JobName: str, ClientRequestToken: str, KMSKey: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a job.\n@required {InputDataConfig: InputDataConfig, OutputDataConfig: OutputDataConfig, DataAccessRoleArn: str, LanguageCode: str}\n@optional {JobName: str, ClientRequestToken: str, KMSKey: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.\n@required {InputDataConfig: InputDataConfig, OutputDataConfig: OutputDataConfig, DataAccessRoleArn: str, LanguageCode: str}\n@optional {JobName: str, ClientRequestToken: str, KMSKey: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the DescribeRxNormInferenceJob operation to track the status of a job.\n@required {InputDataConfig: InputDataConfig, OutputDataConfig: OutputDataConfig, DataAccessRoleArn: str, LanguageCode: str}\n@optional {JobName: str, ClientRequestToken: str, KMSKey: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.\n@required {InputDataConfig: InputDataConfig, OutputDataConfig: OutputDataConfig, DataAccessRoleArn: str, LanguageCode: str}\n@optional {JobName: str, ClientRequestToken: str, KMSKey: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Stops a medical entities detection job in progress.\n@required {JobId: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Stops an InferICD10CM inference job in progress.\n@required {JobId: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Stops a protected health information (PHI) detection job in progress.\n@required {JobId: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Stops an InferRxNorm inference job in progress.\n@required {JobId: str}\n@returns(200) {JobId: str?}\n\n@endpoint POST /\n@desc Stops an InferSNOMEDCT inference job in progress.\n@required {JobId: str}\n@returns(200) {JobId: str?}\n\n@end\n"}