ComprehendMedical / Client / infer_snomedct

infer_snomedct#

ComprehendMedical.Client.infer_snomedct(**kwargs)#

InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology

See also: AWS API Documentation

Request Syntax

response = client.infer_snomedct(
    Text='string'
)

Parameters:

Text (string) –

[REQUIRED]

The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters.

Return type:

dict

Returns:

Response Syntax

{
    'Entities': [
        {
            'Id': 123,
            'Text': 'string',
            'Category': 'MEDICAL_CONDITION'|'ANATOMY'|'TEST_TREATMENT_PROCEDURE',
            'Type': 'DX_NAME'|'TEST_NAME'|'PROCEDURE_NAME'|'TREATMENT_NAME',
            'Score': ...,
            'BeginOffset': 123,
            'EndOffset': 123,
            'Attributes': [
                {
                    'Category': 'MEDICAL_CONDITION'|'ANATOMY'|'TEST_TREATMENT_PROCEDURE',
                    'Type': 'ACUITY'|'QUALITY'|'DIRECTION'|'SYSTEM_ORGAN_SITE'|'TEST_VALUE'|'TEST_UNIT',
                    'Score': ...,
                    'RelationshipScore': ...,
                    'RelationshipType': 'ACUITY'|'QUALITY'|'TEST_VALUE'|'TEST_UNITS'|'DIRECTION'|'SYSTEM_ORGAN_SITE',
                    'Id': 123,
                    'BeginOffset': 123,
                    'EndOffset': 123,
                    'Text': 'string',
                    'Traits': [
                        {
                            'Name': 'NEGATION'|'DIAGNOSIS'|'SIGN'|'SYMPTOM'|'PERTAINS_TO_FAMILY'|'HYPOTHETICAL'|'LOW_CONFIDENCE'|'PAST_HISTORY'|'FUTURE',
                            'Score': ...
                        },
                    ],
                    'SNOMEDCTConcepts': [
                        {
                            'Description': 'string',
                            'Code': 'string',
                            'Score': ...
                        },
                    ]
                },
            ],
            'Traits': [
                {
                    'Name': 'NEGATION'|'DIAGNOSIS'|'SIGN'|'SYMPTOM'|'PERTAINS_TO_FAMILY'|'HYPOTHETICAL'|'LOW_CONFIDENCE'|'PAST_HISTORY'|'FUTURE',
                    'Score': ...
                },
            ],
            'SNOMEDCTConcepts': [
                {
                    'Description': 'string',
                    'Code': 'string',
                    'Score': ...
                },
            ]
        },
    ],
    'PaginationToken': 'string',
    'ModelVersion': 'string',
    'SNOMEDCTDetails': {
        'Edition': 'string',
        'Language': 'string',
        'VersionDate': 'string'
    },
    'Characters': {
        'OriginalTextCharacters': 123
    }
}

Response Structure

(dict) –
- Entities (list) –
  
  The collection of medical concept entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
  - (dict) –
    
    The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
    - Id (integer) –
      
      The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    - Text (string) –
      
      The segment of input text extracted as this entity.
    - Category (string) –
      
      The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    - Type (string) –
      
      Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    - Score (float) –
      
      The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
    - BeginOffset (integer) –
      
      The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.
    - EndOffset (integer) –
      
      The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.
    - Attributes (list) –
      
      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.
      - (dict) –
        
        The extracted attributes that relate to an entity. 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.
        
        Category (string) –
        
        The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.
        
        Type (string) –
        
        The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.
        
        Score (float) –
        
        The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
        
        RelationshipScore (float) –
        
        The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.
        
        RelationshipType (string) –
        
        The type of relationship that exists between the entity and the related attribute.
        
        Id (integer) –
        
        The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
        
        BeginOffset (integer) –
        
        The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.
        
        EndOffset (integer) –
        
        The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.
        
        Text (string) –
        
        The segment of input text extracted as this attribute.
        
        Traits (list) –
        
        Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.
        
        (dict) –
        
        Contextual information for an entity.
        
        Name (string) –
        
        The name or contextual description of a detected trait.
        
        Score (float) –
        
        The level of confidence that Comprehend Medical has in the accuracy of a detected trait.
        
        SNOMEDCTConcepts (list) –
        
        The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.
        
        (dict) –
        
        The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.
        
        Description (string) –
        
        The description of the SNOMED-CT concept.
        
        Code (string) –
        
        The numeric ID for the SNOMED-CT concept.
        
        Score (float) –
        
        The level of confidence Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
    - Traits (list) –
      
      Contextual information for the entity.
      - (dict) –
        
        Contextual information for an entity.
        
        Name (string) –
        
        The name or contextual description of a detected trait.
        
        Score (float) –
        
        The level of confidence that Comprehend Medical has in the accuracy of a detected trait.
    - SNOMEDCTConcepts (list) –
      
      The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
      - (dict) –
        
        The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.
        
        Description (string) –
        
        The description of the SNOMED-CT concept.
        
        Code (string) –
        
        The numeric ID for the SNOMED-CT concept.
        
        Score (float) –
        
        The level of confidence Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
- PaginationToken (string) –
  
  If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.
- ModelVersion (string) –
  
  The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.
- SNOMEDCTDetails (dict) –
  
  The details of the SNOMED-CT revision, including the edition, language, and version date.
  - Edition (string) –
    
    The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions is the US edition.
  - Language (string) –
    
    The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical operations are US English (en).
  - VersionDate (string) –
    
    The version date of the SNOMED-CT ontology used.
- Characters (dict) –
  
  The number of characters in the input request documentation.
  - OriginalTextCharacters (integer) –
    
    The number of characters present in the input text document as processed by Comprehend Medical.

Exceptions

ComprehendMedical.Client.exceptions.InternalServerException
ComprehendMedical.Client.exceptions.ServiceUnavailableException
ComprehendMedical.Client.exceptions.TooManyRequestsException
ComprehendMedical.Client.exceptions.InvalidRequestException
ComprehendMedical.Client.exceptions.InvalidEncodingException
ComprehendMedical.Client.exceptions.TextSizeLimitExceededException