AWS.ComprehendMedical reference

DescribeEntitiesDetectionV2Job

Source: src/AWS/ComprehendMedical/DescribeEntitiesDetectionV2Job.ts

Runtime binding for comprehendmedical:DescribeEntitiesDetectionV2Job — get the properties and status of an asynchronous medical entity detection job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:DescribeEntitiesDetectionV2Job on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.DescribeEntitiesDetectionV2JobHttp).

DescribeEntitiesDetectionV2Job: Batch Entity Detection Jobs

// init
const describeEntitiesDetectionV2Job = yield* AWS.ComprehendMedical.DescribeEntitiesDetectionV2Job();

// runtime
const status = yield* describeEntitiesDetectionV2Job({ JobId: jobId });
console.log(status.ComprehendMedicalAsyncJobProperties?.JobStatus);

DescribeICD10CMInferenceJob

Source: src/AWS/ComprehendMedical/DescribeICD10CMInferenceJob.ts

Runtime binding for comprehendmedical:DescribeICD10CMInferenceJob — get the properties and status of an asynchronous ICD-10-CM ontology linking job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:DescribeICD10CMInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.DescribeICD10CMInferenceJobHttp).

DescribeICD10CMInferenceJob: Batch ICD-10-CM Inference Jobs

// init
const describeICD10CMInferenceJob = yield* AWS.ComprehendMedical.DescribeICD10CMInferenceJob();

// runtime
const status = yield* describeICD10CMInferenceJob({ JobId: jobId });
console.log(status.ComprehendMedicalAsyncJobProperties?.JobStatus);

DescribePHIDetectionJob

Source: src/AWS/ComprehendMedical/DescribePHIDetectionJob.ts

Runtime binding for comprehendmedical:DescribePHIDetectionJob — get the properties and status of an asynchronous protected health information (PHI) detection job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:DescribePHIDetectionJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.DescribePHIDetectionJobHttp).

DescribePHIDetectionJob: Batch PHI Detection Jobs

// init
const describePHIDetectionJob = yield* AWS.ComprehendMedical.DescribePHIDetectionJob();

// runtime
const status = yield* describePHIDetectionJob({ JobId: jobId });
console.log(status.ComprehendMedicalAsyncJobProperties?.JobStatus);

DescribeRxNormInferenceJob

Source: src/AWS/ComprehendMedical/DescribeRxNormInferenceJob.ts

Runtime binding for comprehendmedical:DescribeRxNormInferenceJob — get the properties and status of an asynchronous RxNorm ontology linking job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:DescribeRxNormInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.DescribeRxNormInferenceJobHttp).

DescribeRxNormInferenceJob: Batch RxNorm Inference Jobs

// init
const describeRxNormInferenceJob = yield* AWS.ComprehendMedical.DescribeRxNormInferenceJob();

// runtime
const status = yield* describeRxNormInferenceJob({ JobId: jobId });
console.log(status.ComprehendMedicalAsyncJobProperties?.JobStatus);

DescribeSNOMEDCTInferenceJob

Source: src/AWS/ComprehendMedical/DescribeSNOMEDCTInferenceJob.ts

Runtime binding for comprehendmedical:DescribeSNOMEDCTInferenceJob — get the properties and status of an asynchronous SNOMED CT ontology linking job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:DescribeSNOMEDCTInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.DescribeSNOMEDCTInferenceJobHttp).

DescribeSNOMEDCTInferenceJob: Batch SNOMED CT Inference Jobs

// init
const describeSNOMEDCTInferenceJob = yield* AWS.ComprehendMedical.DescribeSNOMEDCTInferenceJob();

// runtime
const status = yield* describeSNOMEDCTInferenceJob({ JobId: jobId });
console.log(status.ComprehendMedicalAsyncJobProperties?.JobStatus);

DetectEntitiesV2

Source: src/AWS/ComprehendMedical/DetectEntitiesV2.ts

Runtime binding for comprehendmedical:DetectEntitiesV2 — extract medical entities (medications, medical conditions, anatomy, PHI, tests/treatments) and their attributes and traits from clinical text.

Comprehend Medical is a pure pay-per-call service with no resource to manage: the binding takes no arguments and grants the function comprehendmedical:DetectEntitiesV2 (the action has no resource-level IAM). Pass the clinical note as raw text — no marshalling.

DetectEntitiesV2: Detecting Medical Entities

// init
const detectEntities = yield* AWS.ComprehendMedical.DetectEntitiesV2();

// runtime
const result = yield* detectEntities({
  Text: "Patient takes 50 mg atenolol daily for hypertension.",
});
const names = (result.Entities ?? []).map((entity) => entity.Text);

DetectPHI

Source: src/AWS/ComprehendMedical/DetectPHI.ts

Runtime binding for comprehendmedical:DetectPHI — detect protected health information (PHI) entities (name, address, age, ID numbers, dates…) in clinical text.

Comprehend Medical is a pure pay-per-call service with no resource to manage: the binding takes no arguments and grants the function comprehendmedical:DetectPHI (the action has no resource-level IAM). Pass the clinical note as raw text — no marshalling.

DetectPHI: Detecting PHI

// init
const detectPHI = yield* AWS.ComprehendMedical.DetectPHI();

// runtime
const result = yield* detectPHI({
  Text: "John Doe, age 47, was seen on 2024-01-03.",
});
const phi = (result.Entities ?? []).map((entity) => entity.Type);

InferICD10CM

Source: src/AWS/ComprehendMedical/InferICD10CM.ts

Runtime binding for comprehendmedical:InferICD10CM — detect medical conditions in clinical text and link them to ICD-10-CM ontology codes with confidence scores.

Comprehend Medical is a pure pay-per-call service with no resource to manage: the binding takes no arguments and grants the function comprehendmedical:InferICD10CM (the action has no resource-level IAM). Pass the clinical note as raw text — no marshalling.

InferICD10CM: Inferring ICD-10-CM Codes

// init
const inferICD10CM = yield* AWS.ComprehendMedical.InferICD10CM();

// runtime
const result = yield* inferICD10CM({
  Text: "Patient presents with type 2 diabetes and hypertension.",
});
const codes = (result.Entities ?? []).flatMap((entity) =>
  (entity.ICD10CMConcepts ?? []).map((concept) => concept.Code),
);

InferRxNorm

Source: src/AWS/ComprehendMedical/InferRxNorm.ts

Runtime binding for comprehendmedical:InferRxNorm — detect medication entities in clinical text and link them to concept identifiers in the RxNorm ontology (medication names, dosages, frequencies).

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:InferRxNorm on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.InferRxNormHttp).

InferRxNorm: Linking Medications to RxNorm

// init
const inferRxNorm = yield* AWS.ComprehendMedical.InferRxNorm();

// runtime
const result = yield* inferRxNorm({
  Text: "Patient takes 50 mg atenolol daily.",
});
const concepts = (result.Entities ?? []).flatMap((e) => e.RxNormConcepts ?? []);

InferSNOMEDCT

Source: src/AWS/ComprehendMedical/InferSNOMEDCT.ts

Runtime binding for comprehendmedical:InferSNOMEDCT — detect medical concepts in clinical text and link them to codes in the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED CT) ontology.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:InferSNOMEDCT on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.InferSNOMEDCTHttp).

InferSNOMEDCT: Linking Concepts to SNOMED CT

// init
const inferSNOMEDCT = yield* AWS.ComprehendMedical.InferSNOMEDCT();

// runtime
const result = yield* inferSNOMEDCT({
  Text: "Patient presents with type 2 diabetes.",
});
const concepts = (result.Entities ?? []).flatMap((e) => e.SNOMEDCTConcepts ?? []);

ListEntitiesDetectionV2Jobs

Source: src/AWS/ComprehendMedical/ListEntitiesDetectionV2Jobs.ts

Runtime binding for comprehendmedical:ListEntitiesDetectionV2Jobs — list the asynchronous medical entity detection jobs you have submitted.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:ListEntitiesDetectionV2Jobs on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.ListEntitiesDetectionV2JobsHttp).

ListEntitiesDetectionV2Jobs: Batch Entity Detection Jobs

// init
const listEntitiesDetectionV2Jobs = yield* AWS.ComprehendMedical.ListEntitiesDetectionV2Jobs();

// runtime
const jobs = yield* listEntitiesDetectionV2Jobs({});
console.log(jobs.ComprehendMedicalAsyncJobPropertiesList?.length ?? 0);

ListICD10CMInferenceJobs

Source: src/AWS/ComprehendMedical/ListICD10CMInferenceJobs.ts

Runtime binding for comprehendmedical:ListICD10CMInferenceJobs — list the asynchronous ICD-10-CM ontology linking jobs you have submitted.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:ListICD10CMInferenceJobs on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.ListICD10CMInferenceJobsHttp).

ListICD10CMInferenceJobs: Batch ICD-10-CM Inference Jobs

// init
const listICD10CMInferenceJobs = yield* AWS.ComprehendMedical.ListICD10CMInferenceJobs();

// runtime
const jobs = yield* listICD10CMInferenceJobs({});
console.log(jobs.ComprehendMedicalAsyncJobPropertiesList?.length ?? 0);

ListPHIDetectionJobs

Source: src/AWS/ComprehendMedical/ListPHIDetectionJobs.ts

Runtime binding for comprehendmedical:ListPHIDetectionJobs — list the asynchronous protected health information (PHI) detection jobs you have submitted.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:ListPHIDetectionJobs on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.ListPHIDetectionJobsHttp).

ListPHIDetectionJobs: Batch PHI Detection Jobs

// init
const listPHIDetectionJobs = yield* AWS.ComprehendMedical.ListPHIDetectionJobs();

// runtime
const jobs = yield* listPHIDetectionJobs({});
console.log(jobs.ComprehendMedicalAsyncJobPropertiesList?.length ?? 0);

ListRxNormInferenceJobs

Source: src/AWS/ComprehendMedical/ListRxNormInferenceJobs.ts

Runtime binding for comprehendmedical:ListRxNormInferenceJobs — list the asynchronous RxNorm ontology linking jobs you have submitted.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:ListRxNormInferenceJobs on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.ListRxNormInferenceJobsHttp).

ListRxNormInferenceJobs: Batch RxNorm Inference Jobs

// init
const listRxNormInferenceJobs = yield* AWS.ComprehendMedical.ListRxNormInferenceJobs();

// runtime
const jobs = yield* listRxNormInferenceJobs({});
console.log(jobs.ComprehendMedicalAsyncJobPropertiesList?.length ?? 0);

ListSNOMEDCTInferenceJobs

Source: src/AWS/ComprehendMedical/ListSNOMEDCTInferenceJobs.ts

Runtime binding for comprehendmedical:ListSNOMEDCTInferenceJobs — list the asynchronous SNOMED CT ontology linking jobs you have submitted.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:ListSNOMEDCTInferenceJobs on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.ListSNOMEDCTInferenceJobsHttp).

ListSNOMEDCTInferenceJobs: Batch SNOMED CT Inference Jobs

// init
const listSNOMEDCTInferenceJobs = yield* AWS.ComprehendMedical.ListSNOMEDCTInferenceJobs();

// runtime
const jobs = yield* listSNOMEDCTInferenceJobs({});
console.log(jobs.ComprehendMedicalAsyncJobPropertiesList?.length ?? 0);

StartEntitiesDetectionV2Job

Source: src/AWS/ComprehendMedical/StartEntitiesDetectionV2Job.ts

Runtime binding for comprehendmedical:StartEntitiesDetectionV2Job — start an asynchronous medical entity detection job over a collection of documents in S3. Also grants iam:PassRole (conditioned to comprehendmedical.amazonaws.com) for the job’s data-access role.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StartEntitiesDetectionV2Job on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StartEntitiesDetectionV2JobHttp).

StartEntitiesDetectionV2Job: Batch Entity Detection Jobs

// init
const startEntitiesDetectionV2Job = yield* AWS.ComprehendMedical.StartEntitiesDetectionV2Job();

// runtime
const job = yield* startEntitiesDetectionV2Job({
  InputDataConfig: { S3Bucket: "my-input-bucket", S3Key: "notes/" },
  OutputDataConfig: { S3Bucket: "my-output-bucket" },
  DataAccessRoleArn: dataAccessRole.roleArn,
  LanguageCode: "en",
});

StartICD10CMInferenceJob

Source: src/AWS/ComprehendMedical/StartICD10CMInferenceJob.ts

Runtime binding for comprehendmedical:StartICD10CMInferenceJob — start an asynchronous ICD-10-CM ontology linking job over a collection of documents in S3. Also grants iam:PassRole (conditioned to comprehendmedical.amazonaws.com) for the job’s data-access role.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StartICD10CMInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StartICD10CMInferenceJobHttp).

StartICD10CMInferenceJob: Batch ICD-10-CM Inference Jobs

// init
const startICD10CMInferenceJob = yield* AWS.ComprehendMedical.StartICD10CMInferenceJob();

// runtime
const job = yield* startICD10CMInferenceJob({
  InputDataConfig: { S3Bucket: "my-input-bucket", S3Key: "notes/" },
  OutputDataConfig: { S3Bucket: "my-output-bucket" },
  DataAccessRoleArn: dataAccessRole.roleArn,
  LanguageCode: "en",
});

StartPHIDetectionJob

Source: src/AWS/ComprehendMedical/StartPHIDetectionJob.ts

Runtime binding for comprehendmedical:StartPHIDetectionJob — start an asynchronous protected health information (PHI) detection job over a collection of documents in S3. Also grants iam:PassRole (conditioned to comprehendmedical.amazonaws.com) for the job’s data-access role.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StartPHIDetectionJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StartPHIDetectionJobHttp).

StartPHIDetectionJob: Batch PHI Detection Jobs

// init
const startPHIDetectionJob = yield* AWS.ComprehendMedical.StartPHIDetectionJob();

// runtime
const job = yield* startPHIDetectionJob({
  InputDataConfig: { S3Bucket: "my-input-bucket", S3Key: "notes/" },
  OutputDataConfig: { S3Bucket: "my-output-bucket" },
  DataAccessRoleArn: dataAccessRole.roleArn,
  LanguageCode: "en",
});

StartRxNormInferenceJob

Source: src/AWS/ComprehendMedical/StartRxNormInferenceJob.ts

Runtime binding for comprehendmedical:StartRxNormInferenceJob — start an asynchronous RxNorm ontology linking job over a collection of documents in S3. Also grants iam:PassRole (conditioned to comprehendmedical.amazonaws.com) for the job’s data-access role.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StartRxNormInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StartRxNormInferenceJobHttp).

StartRxNormInferenceJob: Batch RxNorm Inference Jobs

// init
const startRxNormInferenceJob = yield* AWS.ComprehendMedical.StartRxNormInferenceJob();

// runtime
const job = yield* startRxNormInferenceJob({
  InputDataConfig: { S3Bucket: "my-input-bucket", S3Key: "notes/" },
  OutputDataConfig: { S3Bucket: "my-output-bucket" },
  DataAccessRoleArn: dataAccessRole.roleArn,
  LanguageCode: "en",
});

StartSNOMEDCTInferenceJob

Source: src/AWS/ComprehendMedical/StartSNOMEDCTInferenceJob.ts

Runtime binding for comprehendmedical:StartSNOMEDCTInferenceJob — start an asynchronous SNOMED CT ontology linking job over a collection of documents in S3. Also grants iam:PassRole (conditioned to comprehendmedical.amazonaws.com) for the job’s data-access role.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StartSNOMEDCTInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StartSNOMEDCTInferenceJobHttp).

StartSNOMEDCTInferenceJob: Batch SNOMED CT Inference Jobs

// init
const startSNOMEDCTInferenceJob = yield* AWS.ComprehendMedical.StartSNOMEDCTInferenceJob();

// runtime
const job = yield* startSNOMEDCTInferenceJob({
  InputDataConfig: { S3Bucket: "my-input-bucket", S3Key: "notes/" },
  OutputDataConfig: { S3Bucket: "my-output-bucket" },
  DataAccessRoleArn: dataAccessRole.roleArn,
  LanguageCode: "en",
});

StopEntitiesDetectionV2Job

Source: src/AWS/ComprehendMedical/StopEntitiesDetectionV2Job.ts

Runtime binding for comprehendmedical:StopEntitiesDetectionV2Job — stop an in-progress asynchronous medical entity detection job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StopEntitiesDetectionV2Job on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StopEntitiesDetectionV2JobHttp).

StopEntitiesDetectionV2Job: Batch Entity Detection Jobs

// init
const stopEntitiesDetectionV2Job = yield* AWS.ComprehendMedical.StopEntitiesDetectionV2Job();

// runtime
yield* stopEntitiesDetectionV2Job({ JobId: jobId });

StopICD10CMInferenceJob

Source: src/AWS/ComprehendMedical/StopICD10CMInferenceJob.ts

Runtime binding for comprehendmedical:StopICD10CMInferenceJob — stop an in-progress asynchronous ICD-10-CM ontology linking job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StopICD10CMInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StopICD10CMInferenceJobHttp).

StopICD10CMInferenceJob: Batch ICD-10-CM Inference Jobs

// init
const stopICD10CMInferenceJob = yield* AWS.ComprehendMedical.StopICD10CMInferenceJob();

// runtime
yield* stopICD10CMInferenceJob({ JobId: jobId });

StopPHIDetectionJob

Source: src/AWS/ComprehendMedical/StopPHIDetectionJob.ts

Runtime binding for comprehendmedical:StopPHIDetectionJob — stop an in-progress asynchronous protected health information (PHI) detection job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StopPHIDetectionJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StopPHIDetectionJobHttp).

StopPHIDetectionJob: Batch PHI Detection Jobs

// init
const stopPHIDetectionJob = yield* AWS.ComprehendMedical.StopPHIDetectionJob();

// runtime
yield* stopPHIDetectionJob({ JobId: jobId });

StopRxNormInferenceJob

Source: src/AWS/ComprehendMedical/StopRxNormInferenceJob.ts

Runtime binding for comprehendmedical:StopRxNormInferenceJob — stop an in-progress asynchronous RxNorm ontology linking job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StopRxNormInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StopRxNormInferenceJobHttp).

StopRxNormInferenceJob: Batch RxNorm Inference Jobs

// init
const stopRxNormInferenceJob = yield* AWS.ComprehendMedical.StopRxNormInferenceJob();

// runtime
yield* stopRxNormInferenceJob({ JobId: jobId });

StopSNOMEDCTInferenceJob

Source: src/AWS/ComprehendMedical/StopSNOMEDCTInferenceJob.ts

Runtime binding for comprehendmedical:StopSNOMEDCTInferenceJob — stop an in-progress asynchronous SNOMED CT ontology linking job.

Comprehend Medical has no resource-level IAM, so the binding takes no arguments and grants comprehendmedical:StopSNOMEDCTInferenceJob on *. Provide the implementation with Effect.provide(AWS.ComprehendMedical.StopSNOMEDCTInferenceJobHttp).

StopSNOMEDCTInferenceJob: Batch SNOMED CT Inference Jobs

// init
const stopSNOMEDCTInferenceJob = yield* AWS.ComprehendMedical.StopSNOMEDCTInferenceJob();

// runtime
yield* stopSNOMEDCTInferenceJob({ JobId: jobId });