npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_comprehendmedical

v5.0.0

Published

DataFire integration for AWS Comprehend Medical

Downloads

6

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/amazonaws_comprehendmedical

Client library for AWS Comprehend Medical

Installation and Usage

npm install --save @datafire/amazonaws_comprehendmedical
let amazonaws_comprehendmedical = require('@datafire/amazonaws_comprehendmedical').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.

Actions

DescribeEntitiesDetectionV2Job

amazonaws_comprehendmedical.DescribeEntitiesDetectionV2Job({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribeICD10CMInferenceJob

amazonaws_comprehendmedical.DescribeICD10CMInferenceJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribePHIDetectionJob

amazonaws_comprehendmedical.DescribePHIDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribeRxNormInferenceJob

amazonaws_comprehendmedical.DescribeRxNormInferenceJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DetectEntities

amazonaws_comprehendmedical.DetectEntities({
  "Text": null
}, context)

Input

  • input object
    • Text required

Output

DetectEntitiesV2

amazonaws_comprehendmedical.DetectEntitiesV2({
  "Text": null
}, context)

Input

  • input object
    • Text required

Output

DetectPHI

amazonaws_comprehendmedical.DetectPHI({
  "Text": null
}, context)

Input

  • input object
    • Text required

Output

InferICD10CM

amazonaws_comprehendmedical.InferICD10CM({
  "Text": null
}, context)

Input

  • input object
    • Text required

Output

InferRxNorm

amazonaws_comprehendmedical.InferRxNorm({
  "Text": null
}, context)

Input

  • input object
    • Text required

Output

ListEntitiesDetectionV2Jobs

amazonaws_comprehendmedical.ListEntitiesDetectionV2Jobs({}, context)

Input

  • input object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListICD10CMInferenceJobs

amazonaws_comprehendmedical.ListICD10CMInferenceJobs({}, context)

Input

  • input object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListPHIDetectionJobs

amazonaws_comprehendmedical.ListPHIDetectionJobs({}, context)

Input

  • input object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListRxNormInferenceJobs

amazonaws_comprehendmedical.ListRxNormInferenceJobs({}, context)

Input

  • input object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

StartEntitiesDetectionV2Job

amazonaws_comprehendmedical.StartEntitiesDetectionV2Job({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • S3Bucket required
      • S3Key
    • JobName
    • KMSKey
    • LanguageCode required
    • OutputDataConfig required
      • S3Bucket required
      • S3Key

Output

StartICD10CMInferenceJob

amazonaws_comprehendmedical.StartICD10CMInferenceJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • S3Bucket required
      • S3Key
    • JobName
    • KMSKey
    • LanguageCode required
    • OutputDataConfig required
      • S3Bucket required
      • S3Key

Output

StartPHIDetectionJob

amazonaws_comprehendmedical.StartPHIDetectionJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • S3Bucket required
      • S3Key
    • JobName
    • KMSKey
    • LanguageCode required
    • OutputDataConfig required
      • S3Bucket required
      • S3Key

Output

StartRxNormInferenceJob

amazonaws_comprehendmedical.StartRxNormInferenceJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • S3Bucket required
      • S3Key
    • JobName
    • KMSKey
    • LanguageCode required
    • OutputDataConfig required
      • S3Bucket required
      • S3Key

Output

StopEntitiesDetectionV2Job

amazonaws_comprehendmedical.StopEntitiesDetectionV2Job({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopICD10CMInferenceJob

amazonaws_comprehendmedical.StopICD10CMInferenceJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopPHIDetectionJob

amazonaws_comprehendmedical.StopPHIDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopRxNormInferenceJob

amazonaws_comprehendmedical.StopRxNormInferenceJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

Definitions

AnyLengthString

  • AnyLengthString string

Attribute

  • Attribute object: 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.
    • BeginOffset
    • Category
    • EndOffset
    • Id
    • RelationshipScore
    • RelationshipType
    • Score
    • Text
    • Traits
    • Type

AttributeList

AttributeName

  • AttributeName string (values: SIGN, SYMPTOM, DIAGNOSIS, NEGATION)

BoundedLengthString

  • BoundedLengthString string

ClientRequestTokenString

  • ClientRequestTokenString string

ComprehendMedicalAsyncJobFilter

  • ComprehendMedicalAsyncJobFilter object: Provides information for filtering a list of detection jobs.
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

ComprehendMedicalAsyncJobProperties

  • ComprehendMedicalAsyncJobProperties object: Provides information about a detection job.
    • DataAccessRoleArn
    • EndTime
    • ExpirationTime
    • InputDataConfig
      • S3Bucket required
      • S3Key
    • JobId
    • JobName
    • JobStatus
    • KMSKey
    • LanguageCode
    • ManifestFilePath
    • Message
    • ModelVersion
    • OutputDataConfig
      • S3Bucket required
      • S3Key
    • SubmitTime

ComprehendMedicalAsyncJobPropertiesList

DescribeEntitiesDetectionV2JobRequest

  • DescribeEntitiesDetectionV2JobRequest object
    • JobId required

DescribeEntitiesDetectionV2JobResponse

  • DescribeEntitiesDetectionV2JobResponse object
    • ComprehendMedicalAsyncJobProperties
      • DataAccessRoleArn
      • EndTime
      • ExpirationTime
      • InputDataConfig
        • S3Bucket required
        • S3Key
      • JobId
      • JobName
      • JobStatus
      • KMSKey
      • LanguageCode
      • ManifestFilePath
      • Message
      • ModelVersion
      • OutputDataConfig
        • S3Bucket required
        • S3Key
      • SubmitTime

DescribeICD10CMInferenceJobRequest

  • DescribeICD10CMInferenceJobRequest object
    • JobId required

DescribeICD10CMInferenceJobResponse

  • DescribeICD10CMInferenceJobResponse object
    • ComprehendMedicalAsyncJobProperties
      • DataAccessRoleArn
      • EndTime
      • ExpirationTime
      • InputDataConfig
        • S3Bucket required
        • S3Key
      • JobId
      • JobName
      • JobStatus
      • KMSKey
      • LanguageCode
      • ManifestFilePath
      • Message
      • ModelVersion
      • OutputDataConfig
        • S3Bucket required
        • S3Key
      • SubmitTime

DescribePHIDetectionJobRequest

  • DescribePHIDetectionJobRequest object
    • JobId required

DescribePHIDetectionJobResponse

  • DescribePHIDetectionJobResponse object
    • ComprehendMedicalAsyncJobProperties
      • DataAccessRoleArn
      • EndTime
      • ExpirationTime
      • InputDataConfig
        • S3Bucket required
        • S3Key
      • JobId
      • JobName
      • JobStatus
      • KMSKey
      • LanguageCode
      • ManifestFilePath
      • Message
      • ModelVersion
      • OutputDataConfig
        • S3Bucket required
        • S3Key
      • SubmitTime

DescribeRxNormInferenceJobRequest

  • DescribeRxNormInferenceJobRequest object
    • JobId required

DescribeRxNormInferenceJobResponse

  • DescribeRxNormInferenceJobResponse object
    • ComprehendMedicalAsyncJobProperties
      • DataAccessRoleArn
      • EndTime
      • ExpirationTime
      • InputDataConfig
        • S3Bucket required
        • S3Key
      • JobId
      • JobName
      • JobStatus
      • KMSKey
      • LanguageCode
      • ManifestFilePath
      • Message
      • ModelVersion
      • OutputDataConfig
        • S3Bucket required
        • S3Key
      • SubmitTime

DetectEntitiesRequest

  • DetectEntitiesRequest object
    • Text required

DetectEntitiesResponse

  • DetectEntitiesResponse object

DetectEntitiesV2Request

  • DetectEntitiesV2Request object
    • Text required

DetectEntitiesV2Response

  • DetectEntitiesV2Response object

DetectPHIRequest

  • DetectPHIRequest object
    • Text required

DetectPHIResponse

  • DetectPHIResponse object
    • Entities required
    • ModelVersion required
    • PaginationToken

Entity

  • Entity object: Provides information about an extracted medical entity.
    • Attributes
    • BeginOffset
    • Category
    • EndOffset
    • Id
    • Score
    • Text
    • Traits
    • Type

EntityList

EntitySubType

  • EntitySubType string (values: 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, TIME_EXPRESSION, TIME_TO_MEDICATION_NAME, TIME_TO_DX_NAME, TIME_TO_TEST_NAME, TIME_TO_PROCEDURE_NAME, TIME_TO_TREATMENT_NAME)

EntityType

  • EntityType string (values: MEDICATION, MEDICAL_CONDITION, PROTECTED_HEALTH_INFORMATION, TEST_TREATMENT_PROCEDURE, ANATOMY, TIME_EXPRESSION)

Float

  • Float number

ICD10CMAttribute

  • ICD10CMAttribute object: The detected attributes that relate to an entity. This includes an extracted segment of the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM detects the following attributes: Direction, System, Organ or Site, and Acuity.
    • BeginOffset
    • EndOffset
    • Id
    • RelationshipScore
    • Score
    • Text
    • Traits
    • Type

ICD10CMAttributeList

ICD10CMAttributeType

  • ICD10CMAttributeType string (values: ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, QUALITY, QUANTITY)

ICD10CMConcept

  • ICD10CMConcept object: The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    • Code
    • Description
    • Score

ICD10CMConceptList

ICD10CMEntity

  • ICD10CMEntity object: 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.

ICD10CMEntityCategory

  • ICD10CMEntityCategory string (values: MEDICAL_CONDITION)

ICD10CMEntityList

ICD10CMEntityType

  • ICD10CMEntityType string (values: DX_NAME)

ICD10CMTrait

  • ICD10CMTrait object: Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.
    • Name
    • Score

ICD10CMTraitList

ICD10CMTraitName

  • ICD10CMTraitName string (values: NEGATION, DIAGNOSIS, SIGN, SYMPTOM)

IamRoleArn

  • IamRoleArn string

InferICD10CMRequest

  • InferICD10CMRequest object
    • Text required

InferICD10CMResponse

  • InferICD10CMResponse object

InferRxNormRequest

  • InferRxNormRequest object
    • Text required

InferRxNormResponse

  • InferRxNormResponse object
    • Entities required
    • ModelVersion
    • PaginationToken

InputDataConfig

  • InputDataConfig object: The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed. See batch-manifest for more information.
    • S3Bucket required
    • S3Key

Integer

  • Integer integer

InternalServerException

InvalidEncodingException

InvalidRequestException

JobId

  • JobId string

JobName

  • JobName string

JobStatus

  • JobStatus string (values: SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED)

KMSKey

  • KMSKey string

LanguageCode

  • LanguageCode string (values: en)

ListEntitiesDetectionV2JobsRequest

  • ListEntitiesDetectionV2JobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListEntitiesDetectionV2JobsResponse

ListICD10CMInferenceJobsRequest

  • ListICD10CMInferenceJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListICD10CMInferenceJobsResponse

ListPHIDetectionJobsRequest

  • ListPHIDetectionJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListPHIDetectionJobsResponse

ListRxNormInferenceJobsRequest

  • ListRxNormInferenceJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListRxNormInferenceJobsResponse

ManifestFilePath

  • ManifestFilePath string

MaxResultsInteger

  • MaxResultsInteger integer

ModelVersion

  • ModelVersion string

OntologyLinkingBoundedLengthString

  • OntologyLinkingBoundedLengthString string

OutputDataConfig

  • OutputDataConfig object: The output properties for a detection job.
    • S3Bucket required
    • S3Key

RelationshipType

  • RelationshipType string (values: EVERY, WITH_DOSAGE, ADMINISTERED_VIA, FOR, NEGATIVE, OVERLAP, DOSAGE, ROUTE_OR_MODE, FORM, FREQUENCY, DURATION, STRENGTH, RATE, ACUITY, TEST_VALUE, TEST_UNITS, DIRECTION, SYSTEM_ORGAN_SITE)

ResourceNotFoundException

RxNormAttribute

  • RxNormAttribute object: The extracted attributes that relate to this entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE.
    • BeginOffset
    • EndOffset
    • Id
    • RelationshipScore
    • Score
    • Text
    • Traits
    • Type

RxNormAttributeList

RxNormAttributeType

  • RxNormAttributeType string (values: DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, STRENGTH)

RxNormConcept

  • RxNormConcept object: The RxNorm concept that the entity could refer to, along with a score indicating the likelihood of the match.
    • Code
    • Description
    • Score

RxNormConceptList

RxNormEntity

  • RxNormEntity object: 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.

RxNormEntityCategory

  • RxNormEntityCategory string (values: MEDICATION)

RxNormEntityList

RxNormEntityType

  • RxNormEntityType string (values: BRAND_NAME, GENERIC_NAME)

RxNormTrait

  • RxNormTrait object: The contextual information for the entity. InferRxNorm recognizes the trait NEGATION, which is any indication that the patient is not taking a medication.
    • Name
    • Score

RxNormTraitList

RxNormTraitName

  • RxNormTraitName string (values: NEGATION)

S3Bucket

  • S3Bucket string

S3Key

  • S3Key string

ServiceUnavailableException

StartEntitiesDetectionV2JobRequest

  • StartEntitiesDetectionV2JobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • S3Bucket required
      • S3Key
    • JobName
    • KMSKey
    • LanguageCode required
    • OutputDataConfig required
      • S3Bucket required
      • S3Key

StartEntitiesDetectionV2JobResponse

  • StartEntitiesDetectionV2JobResponse object
    • JobId

StartICD10CMInferenceJobRequest

  • StartICD10CMInferenceJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • S3Bucket required
      • S3Key
    • JobName
    • KMSKey
    • LanguageCode required
    • OutputDataConfig required
      • S3Bucket required
      • S3Key

StartICD10CMInferenceJobResponse

  • StartICD10CMInferenceJobResponse object
    • JobId

StartPHIDetectionJobRequest

  • StartPHIDetectionJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • S3Bucket required
      • S3Key
    • JobName
    • KMSKey
    • LanguageCode required
    • OutputDataConfig required
      • S3Bucket required
      • S3Key

StartPHIDetectionJobResponse

  • StartPHIDetectionJobResponse object
    • JobId

StartRxNormInferenceJobRequest

  • StartRxNormInferenceJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • S3Bucket required
      • S3Key
    • JobName
    • KMSKey
    • LanguageCode required
    • OutputDataConfig required
      • S3Bucket required
      • S3Key

StartRxNormInferenceJobResponse

  • StartRxNormInferenceJobResponse object
    • JobId

StopEntitiesDetectionV2JobRequest

  • StopEntitiesDetectionV2JobRequest object
    • JobId required

StopEntitiesDetectionV2JobResponse

  • StopEntitiesDetectionV2JobResponse object
    • JobId

StopICD10CMInferenceJobRequest

  • StopICD10CMInferenceJobRequest object
    • JobId required

StopICD10CMInferenceJobResponse

  • StopICD10CMInferenceJobResponse object
    • JobId

StopPHIDetectionJobRequest

  • StopPHIDetectionJobRequest object
    • JobId required

StopPHIDetectionJobResponse

  • StopPHIDetectionJobResponse object
    • JobId

StopRxNormInferenceJobRequest

  • StopRxNormInferenceJobRequest object
    • JobId required

StopRxNormInferenceJobResponse

  • StopRxNormInferenceJobResponse object
    • JobId

String

  • String string

TextSizeLimitExceededException

Timestamp

  • Timestamp string

TooManyRequestsException

Trait

  • Trait object: Provides contextual information about the extracted entity.
    • Name
    • Score

TraitList

  • TraitList array

UnmappedAttribute

  • UnmappedAttribute object: An attribute that we extracted, but were unable to relate to an entity.
    • Attribute
      • BeginOffset
      • Category
      • EndOffset
      • Id
      • RelationshipScore
      • RelationshipType
      • Score
      • Text
      • Traits
      • Type
    • Type

UnmappedAttributeList

ValidationException