[ aws . comprehendmedical ]
infer-rx-norm¶
Description¶
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.
See also: AWS API Documentation
Synopsis¶
infer-rx-norm
--text <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--text (string)
The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: To detect medication entities and link to RxNorm directly from text
The following infer-rx-norm example shows and labels the detected medication entities and links those entities to concept identifiers (RxCUI) from the National Library of Medicine RxNorm database.
aws comprehendmedical infer-rx-norm \
--text "Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid."
Output:
{
"Entities": [
{
"Id": 0,
"Text": "Levothyroxine",
"Category": "MEDICATION",
"Type": "GENERIC_NAME",
"Score": 0.9996285438537598,
"BeginOffset": 23,
"EndOffset": 36,
"Attributes": [
{
"Type": "DOSAGE",
"Score": 0.9892290830612183,
"RelationshipScore": 0.9997978806495667,
"Id": 1,
"BeginOffset": 37,
"EndOffset": 51,
"Text": "125 micrograms",
"Traits": []
},
{
"Type": "ROUTE_OR_MODE",
"Score": 0.9988924860954285,
"RelationshipScore": 0.998291552066803,
"Id": 2,
"BeginOffset": 52,
"EndOffset": 56,
"Text": "p.o.",
"Traits": []
},
{
"Type": "FREQUENCY",
"Score": 0.9953463673591614,
"RelationshipScore": 0.9999889135360718,
"Id": 3,
"BeginOffset": 57,
"EndOffset": 67,
"Text": "once daily",
"Traits": []
}
],
"Traits": [],
"RxNormConcepts": [
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet",
"Code": "966224",
"Score": 0.9912070631980896
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Capsule",
"Code": "966405",
"Score": 0.8698278665542603
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]",
"Code": "966191",
"Score": 0.7448257803916931
},
{
"Description": "levothyroxine",
"Code": "10582",
"Score": 0.7050482630729675
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Levoxyl]",
"Code": "966190",
"Score": 0.6921631693840027
}
]
},
{
"Id": 4,
"Text": "Synthroid",
"Category": "MEDICATION",
"Type": "BRAND_NAME",
"Score": 0.9946461319923401,
"BeginOffset": 86,
"EndOffset": 95,
"Attributes": [],
"Traits": [
{
"Name": "NEGATION",
"Score": 0.5167351961135864
}
],
"RxNormConcepts": [
{
"Description": "Synthroid",
"Code": "224920",
"Score": 0.9462039470672607
},
{
"Description": "Levothyroxine Sodium 0.088 MG Oral Tablet [Synthroid]",
"Code": "966282",
"Score": 0.8309829235076904
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]",
"Code": "966191",
"Score": 0.4945160448551178
},
{
"Description": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]",
"Code": "966247",
"Score": 0.3674522042274475
},
{
"Description": "Levothyroxine Sodium 0.025 MG Oral Tablet [Synthroid]",
"Code": "966158",
"Score": 0.2588822841644287
}
]
}
],
"ModelVersion": "0.0.0"
}
For more information, see Infer RxNorm in the Amazon Comprehend Medical Developer Guide.
Example 2: To detect medication entities and link to RxNorm from a file path.
The following infer-rx-norm example shows and labels the detected medication entities and links those entities to concept identifiers (RxCUI) from the National Library of Medicine RxNorm database.
aws comprehendmedical infer-rx-norm \
--text file://rxnorm.txt
Contents of rxnorm.txt:
{
"Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid."
}
Output:
{
"Entities": [
{
"Id": 0,
"Text": "Levothyroxine",
"Category": "MEDICATION",
"Type": "GENERIC_NAME",
"Score": 0.9996285438537598,
"BeginOffset": 23,
"EndOffset": 36,
"Attributes": [
{
"Type": "DOSAGE",
"Score": 0.9892290830612183,
"RelationshipScore": 0.9997978806495667,
"Id": 1,
"BeginOffset": 37,
"EndOffset": 51,
"Text": "125 micrograms",
"Traits": []
},
{
"Type": "ROUTE_OR_MODE",
"Score": 0.9988924860954285,
"RelationshipScore": 0.998291552066803,
"Id": 2,
"BeginOffset": 52,
"EndOffset": 56,
"Text": "p.o.",
"Traits": []
},
{
"Type": "FREQUENCY",
"Score": 0.9953463673591614,
"RelationshipScore": 0.9999889135360718,
"Id": 3,
"BeginOffset": 57,
"EndOffset": 67,
"Text": "once daily",
"Traits": []
}
],
"Traits": [],
"RxNormConcepts": [
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet",
"Code": "966224",
"Score": 0.9912070631980896
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Capsule",
"Code": "966405",
"Score": 0.8698278665542603
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]",
"Code": "966191",
"Score": 0.7448257803916931
},
{
"Description": "levothyroxine",
"Code": "10582",
"Score": 0.7050482630729675
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Levoxyl]",
"Code": "966190",
"Score": 0.6921631693840027
}
]
},
{
"Id": 4,
"Text": "Synthroid",
"Category": "MEDICATION",
"Type": "BRAND_NAME",
"Score": 0.9946461319923401,
"BeginOffset": 86,
"EndOffset": 95,
"Attributes": [],
"Traits": [
{
"Name": "NEGATION",
"Score": 0.5167351961135864
}
],
"RxNormConcepts": [
{
"Description": "Synthroid",
"Code": "224920",
"Score": 0.9462039470672607
},
{
"Description": "Levothyroxine Sodium 0.088 MG Oral Tablet [Synthroid]",
"Code": "966282",
"Score": 0.8309829235076904
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]",
"Code": "966191",
"Score": 0.4945160448551178
},
{
"Description": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]",
"Code": "966247",
"Score": 0.3674522042274475
},
{
"Description": "Levothyroxine Sodium 0.025 MG Oral Tablet [Synthroid]",
"Code": "966158",
"Score": 0.2588822841644287
}
]
}
],
"ModelVersion": "0.0.0"
}
For more information, see Infer RxNorm in the Amazon Comprehend Medical Developer Guide.
Output¶
Entities -> (list)
The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.
(structure)
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 Amazon 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 from which the entity was detected.
Category -> (string)
The category of the entity. The recognized categories are
GENERICorBRAND_NAME.Type -> (string)
Describes the specific type of entity. For InferRxNorm, the recognized entity type is
MEDICATION.Score -> (float)
The level of confidence that Amazon 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)
The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are
DOSAGE,DURATION,FORM,FREQUENCY,RATE,ROUTE_OR_MODE, andSTRENGTH.(structure)
The extracted attributes that relate to this entity. The attributes recognized by InferRxNorm are
DOSAGE,DURATION,FORM,FREQUENCY,RATE,ROUTE_OR_MODE.Type -> (string)
The type of attribute. The types of attributes recognized by InferRxNorm are
BRAND_NAMEandGENERIC_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 Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
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 which corresponds to the detected attribute.
Traits -> (list)
Contextual information for the attribute. InferRxNorm recognizes the trait
NEGATIONfor attributes, i.e. that the patient is not taking a specific dose or form of a medication.(structure)
The contextual information for the entity. InferRxNorm recognizes the trait
NEGATION, which is any indication that the patient is not taking a medication.Name -> (string)
Provides a name or contextual description about the trait.
Score -> (float)
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected trait.
Traits -> (list)
Contextual information for the entity.
(structure)
The contextual information for the entity. InferRxNorm recognizes the trait
NEGATION, which is any indication that the patient is not taking a medication.Name -> (string)
Provides a name or contextual description about the trait.
Score -> (float)
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected trait.
RxNormConcepts -> (list)
The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
(structure)
The RxNorm concept that the entity could refer to, along with a score indicating the likelihood of the match.
Description -> (string)
The description of the RxNorm concept.
Code -> (string)
RxNorm concept ID, also known as the RxCUI.
Score -> (float)
The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to the reported RxNorm concept.
PaginationToken -> (string)
If the result of the previous request to
InferRxNormwas truncated, include thePaginationTokento fetch the next page of medication 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.