comprehendmedical

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 7 Imported by: 3

Documentation

Overview

Package comprehendmedical provides the client and types for making API requests to ComprehendMedical.

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

See https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30 for more information on this service.

See comprehendmedical package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/comprehendmedical/

Using the Client

To use ComprehendMedical with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the ComprehendMedical client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/comprehendmedical/#New

Index

Constants

View Source 
const (
	ServiceName = "ComprehendMedical" // Service's name
	ServiceID   = "ComprehendMedical" // Service's identifier
	EndpointsID = "comprehendmedical" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal server error occurred. Retry your request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidEncodingException for service response error code
	// "InvalidEncodingException".
	//
	// The input text was not in valid UTF-8 character encoding. Check your text
	// then retry your request.
	ErrCodeInvalidEncodingException = "InvalidEncodingException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request that you made is invalid. Check your request to determine why
	// it's invalid and then retry the request.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource identified by the specified Amazon Resource Name (ARN) was not
	// found. Check the ARN and try your request again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The Amazon Comprehend Medical service is temporarily unavailable. Please
	// wait and then retry your request.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTextSizeLimitExceededException for service response error code
	// "TextSizeLimitExceededException".
	//
	// The size of the text you submitted exceeds the size limit. Reduce the size
	// of the text or use a smaller document and then retry your request.
	ErrCodeTextSizeLimitExceededException = "TextSizeLimitExceededException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// You have made too many requests within a short period of time. Wait for a
	// short time and then try your request again. Contact customer support for
	// more information about a service limit increase.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The filter that you specified for the operation is invalid. Check the filter
	// values that you entered and try your request again.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Attribute 

type Attribute struct {

	// 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.
	BeginOffset *int64 `type:"integer"`

	// The category of attribute.
	Category EntityType `type:"string" enum:"true"`

	// 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.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for this attribute. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has that this attribute
	// is correctly related to this entity.
	RelationshipScore *float64 `type:"float"`

	// The type of relationship between the entity and attribute. Type for the relationship
	// is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.
	RelationshipType RelationshipType `type:"string" enum:"true"`

	// The level of confidence that Amazon Comprehend Medical has that the segment
	// of text is correctly recognized as an attribute.
	Score *float64 `type:"float"`

	// The segment of input text extracted as this attribute.
	Text *string `min:"1" type:"string"`

	// Contextual information for this attribute.
	Traits []Trait `type:"list"`

	// The type of attribute.
	Type EntitySubType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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.

func (Attribute) String 

func (s Attribute) String() string

String returns the string representation

type AttributeName 

type AttributeName string
const (
	AttributeNameSign      AttributeName = "SIGN"
	AttributeNameSymptom   AttributeName = "SYMPTOM"
	AttributeNameDiagnosis AttributeName = "DIAGNOSIS"
	AttributeNameNegation  AttributeName = "NEGATION"
)

Enum values for AttributeName

func (AttributeName) MarshalValue 

func (enum AttributeName) MarshalValue() (string, error)

func (AttributeName) MarshalValueBuf 

func (enum AttributeName) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to ComprehendMedical. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := comprehendmedical.New(myConfig)

func (*Client) DescribeEntitiesDetectionV2JobRequest added in v0.13.0 

func (c *Client) DescribeEntitiesDetectionV2JobRequest(input *DescribeEntitiesDetectionV2JobInput) DescribeEntitiesDetectionV2JobRequest

DescribeEntitiesDetectionV2JobRequest returns a request value for making API operation for AWS Comprehend Medical.

Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job. 

// Example sending a request using DescribeEntitiesDetectionV2JobRequest.
req := client.DescribeEntitiesDetectionV2JobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2Job

func (*Client) DescribeICD10CMInferenceJobRequest added in v0.23.0 

func (c *Client) DescribeICD10CMInferenceJobRequest(input *DescribeICD10CMInferenceJobInput) DescribeICD10CMInferenceJobRequest

DescribeICD10CMInferenceJobRequest returns a request value for making API operation for AWS Comprehend Medical.

Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job. 

// Example sending a request using DescribeICD10CMInferenceJobRequest.
req := client.DescribeICD10CMInferenceJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJob

func (*Client) DescribePHIDetectionJobRequest added in v0.13.0 

func (c *Client) DescribePHIDetectionJobRequest(input *DescribePHIDetectionJobInput) DescribePHIDetectionJobRequest

DescribePHIDetectionJobRequest returns a request value for making API operation for AWS Comprehend Medical.

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job. 

// Example sending a request using DescribePHIDetectionJobRequest.
req := client.DescribePHIDetectionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJob

func (*Client) DescribeRxNormInferenceJobRequest added in v0.23.0 

func (c *Client) DescribeRxNormInferenceJobRequest(input *DescribeRxNormInferenceJobInput) DescribeRxNormInferenceJobRequest

DescribeRxNormInferenceJobRequest returns a request value for making API operation for AWS Comprehend Medical.

Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job. 

// Example sending a request using DescribeRxNormInferenceJobRequest.
req := client.DescribeRxNormInferenceJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJob

func (*Client) DetectEntitiesRequest added in v0.9.0 

func (c *Client) DetectEntitiesRequest(input *DetectEntitiesInput) DetectEntitiesRequest

DetectEntitiesRequest returns a request value for making API operation for AWS Comprehend Medical.

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 . 

// Example sending a request using DetectEntitiesRequest.
req := client.DetectEntitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntities

func (*Client) DetectEntitiesV2Request added in v0.13.0 

func (c *Client) DetectEntitiesV2Request(input *DetectEntitiesV2Input) DetectEntitiesV2Request

DetectEntitiesV2Request returns a request value for making API operation for AWS Comprehend Medical.

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. 

// Example sending a request using DetectEntitiesV2Request.
req := client.DetectEntitiesV2Request(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2

func (*Client) DetectPHIRequest added in v0.9.0 

func (c *Client) DetectPHIRequest(input *DetectPHIInput) DetectPHIRequest

DetectPHIRequest returns a request value for making API operation for AWS Comprehend Medical.

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. 

// Example sending a request using DetectPHIRequest.
req := client.DetectPHIRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHI

func (*Client) InferICD10CMRequest added in v0.19.0 

func (c *Client) InferICD10CMRequest(input *InferICD10CMInput) InferICD10CMRequest

InferICD10CMRequest returns a request value for making API operation for AWS Comprehend Medical.

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. 

// Example sending a request using InferICD10CMRequest.
req := client.InferICD10CMRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CM

func (*Client) InferRxNormRequest added in v0.19.0 

func (c *Client) InferRxNormRequest(input *InferRxNormInput) InferRxNormRequest

InferRxNormRequest returns a request value for making API operation for AWS Comprehend Medical.

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. 

// Example sending a request using InferRxNormRequest.
req := client.InferRxNormRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNorm

func (*Client) ListEntitiesDetectionV2JobsRequest added in v0.13.0 

func (c *Client) ListEntitiesDetectionV2JobsRequest(input *ListEntitiesDetectionV2JobsInput) ListEntitiesDetectionV2JobsRequest

ListEntitiesDetectionV2JobsRequest returns a request value for making API operation for AWS Comprehend Medical.

Gets a list of medical entity detection jobs that you have submitted. 

// Example sending a request using ListEntitiesDetectionV2JobsRequest.
req := client.ListEntitiesDetectionV2JobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2Jobs

func (*Client) ListICD10CMInferenceJobsRequest added in v0.23.0 

func (c *Client) ListICD10CMInferenceJobsRequest(input *ListICD10CMInferenceJobsInput) ListICD10CMInferenceJobsRequest

ListICD10CMInferenceJobsRequest returns a request value for making API operation for AWS Comprehend Medical.

Gets a list of InferICD10CM jobs that you have submitted. 

// Example sending a request using ListICD10CMInferenceJobsRequest.
req := client.ListICD10CMInferenceJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobs

func (*Client) ListPHIDetectionJobsRequest added in v0.13.0 

func (c *Client) ListPHIDetectionJobsRequest(input *ListPHIDetectionJobsInput) ListPHIDetectionJobsRequest

ListPHIDetectionJobsRequest returns a request value for making API operation for AWS Comprehend Medical.

Gets a list of protected health information (PHI) detection jobs that you have submitted. 

// Example sending a request using ListPHIDetectionJobsRequest.
req := client.ListPHIDetectionJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobs

func (*Client) ListRxNormInferenceJobsRequest added in v0.23.0 

func (c *Client) ListRxNormInferenceJobsRequest(input *ListRxNormInferenceJobsInput) ListRxNormInferenceJobsRequest

ListRxNormInferenceJobsRequest returns a request value for making API operation for AWS Comprehend Medical.

Gets a list of InferRxNorm jobs that you have submitted. 

// Example sending a request using ListRxNormInferenceJobsRequest.
req := client.ListRxNormInferenceJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobs

func (*Client) StartEntitiesDetectionV2JobRequest added in v0.13.0 

func (c *Client) StartEntitiesDetectionV2JobRequest(input *StartEntitiesDetectionV2JobInput) StartEntitiesDetectionV2JobRequest

StartEntitiesDetectionV2JobRequest returns a request value for making API operation for AWS Comprehend Medical.

Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job. 

// Example sending a request using StartEntitiesDetectionV2JobRequest.
req := client.StartEntitiesDetectionV2JobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2Job

func (*Client) StartICD10CMInferenceJobRequest added in v0.23.0 

func (c *Client) StartICD10CMInferenceJobRequest(input *StartICD10CMInferenceJobInput) StartICD10CMInferenceJobRequest

StartICD10CMInferenceJobRequest returns a request value for making API operation for AWS Comprehend Medical.

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. 

// Example sending a request using StartICD10CMInferenceJobRequest.
req := client.StartICD10CMInferenceJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJob

func (*Client) StartPHIDetectionJobRequest added in v0.13.0 

func (c *Client) StartPHIDetectionJobRequest(input *StartPHIDetectionJobInput) StartPHIDetectionJobRequest

StartPHIDetectionJobRequest returns a request value for making API operation for AWS Comprehend Medical.

Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job. 

// Example sending a request using StartPHIDetectionJobRequest.
req := client.StartPHIDetectionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJob

func (*Client) StartRxNormInferenceJobRequest added in v0.23.0 

func (c *Client) StartRxNormInferenceJobRequest(input *StartRxNormInferenceJobInput) StartRxNormInferenceJobRequest

StartRxNormInferenceJobRequest returns a request value for making API operation for AWS Comprehend Medical.

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. 

// Example sending a request using StartRxNormInferenceJobRequest.
req := client.StartRxNormInferenceJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJob

func (*Client) StopEntitiesDetectionV2JobRequest added in v0.13.0 

func (c *Client) StopEntitiesDetectionV2JobRequest(input *StopEntitiesDetectionV2JobInput) StopEntitiesDetectionV2JobRequest

StopEntitiesDetectionV2JobRequest returns a request value for making API operation for AWS Comprehend Medical.

Stops a medical entities detection job in progress. 

// Example sending a request using StopEntitiesDetectionV2JobRequest.
req := client.StopEntitiesDetectionV2JobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2Job

func (*Client) StopICD10CMInferenceJobRequest added in v0.23.0 

func (c *Client) StopICD10CMInferenceJobRequest(input *StopICD10CMInferenceJobInput) StopICD10CMInferenceJobRequest

StopICD10CMInferenceJobRequest returns a request value for making API operation for AWS Comprehend Medical.

Stops an InferICD10CM inference job in progress. 

// Example sending a request using StopICD10CMInferenceJobRequest.
req := client.StopICD10CMInferenceJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJob

func (*Client) StopPHIDetectionJobRequest added in v0.13.0 

func (c *Client) StopPHIDetectionJobRequest(input *StopPHIDetectionJobInput) StopPHIDetectionJobRequest

StopPHIDetectionJobRequest returns a request value for making API operation for AWS Comprehend Medical.

Stops a protected health information (PHI) detection job in progress. 

// Example sending a request using StopPHIDetectionJobRequest.
req := client.StopPHIDetectionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJob

func (*Client) StopRxNormInferenceJobRequest added in v0.23.0 

func (c *Client) StopRxNormInferenceJobRequest(input *StopRxNormInferenceJobInput) StopRxNormInferenceJobRequest

StopRxNormInferenceJobRequest returns a request value for making API operation for AWS Comprehend Medical.

Stops an InferRxNorm inference job in progress. 

// Example sending a request using StopRxNormInferenceJobRequest.
req := client.StopRxNormInferenceJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJob

type ComprehendMedicalAsyncJobFilter added in v0.13.0 

type ComprehendMedicalAsyncJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus `type:"string" enum:"true"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of detection jobs.

func (ComprehendMedicalAsyncJobFilter) String added in v0.13.0 

func (s ComprehendMedicalAsyncJobFilter) String() string

String returns the string representation

func (*ComprehendMedicalAsyncJobFilter) Validate added in v0.13.0 

func (s *ComprehendMedicalAsyncJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComprehendMedicalAsyncJobProperties added in v0.13.0 

type ComprehendMedicalAsyncJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read
	// access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the detection job completed.
	EndTime *time.Time `type:"timestamp"`

	// The date and time that job metadata is deleted from the server. Output files
	// in your S3 bucket will not be deleted. After the metadata is deleted, the
	// job will no longer appear in the results of the ListEntitiesDetectionV2Job
	// or the ListPHIDetectionJobs operation.
	ExpirationTime *time.Time `type:"timestamp"`

	// The input data configuration that you supplied when you created the detection
	// job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The identifier assigned to the detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned to the detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the detection job. If the status is FAILED, the Message
	// field shows the reason for the failure.
	JobStatus JobStatus `type:"string" enum:"true"`

	// The AWS Key Management Service key, if any, used to encrypt the output files.
	KMSKey *string `min:"1" type:"string"`

	// The language code of the input documents.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The path to the file that describes the results of a batch job.
	ManifestFilePath *string `min:"1" type:"string"`

	// A description of the status of a job.
	Message *string `type:"string"`

	// The version of the model used to analyze the documents. The version number
	// looks like X.X.X. You can use this information to track the model used for
	// a particular batch of documents.
	ModelVersion *string `type:"string"`

	// The output data configuration that you supplied when you created the detection
	// job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information about a detection job.

func (ComprehendMedicalAsyncJobProperties) String added in v0.13.0 

func (s ComprehendMedicalAsyncJobProperties) String() string

String returns the string representation

type DescribeEntitiesDetectionV2JobInput added in v0.13.0 

type DescribeEntitiesDetectionV2JobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartEntitiesDetectionV2Job operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEntitiesDetectionV2JobInput) String added in v0.13.0 

func (s DescribeEntitiesDetectionV2JobInput) String() string

String returns the string representation

func (*DescribeEntitiesDetectionV2JobInput) Validate added in v0.13.0 

func (s *DescribeEntitiesDetectionV2JobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEntitiesDetectionV2JobOutput added in v0.13.0 

type DescribeEntitiesDetectionV2JobOutput struct {

	// An object that contains the properties associated with a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEntitiesDetectionV2JobOutput) String added in v0.13.0 

func (s DescribeEntitiesDetectionV2JobOutput) String() string

String returns the string representation

type DescribeEntitiesDetectionV2JobRequest added in v0.13.0 

type DescribeEntitiesDetectionV2JobRequest struct {
	*aws.Request
	Input *DescribeEntitiesDetectionV2JobInput
	Copy  func(*DescribeEntitiesDetectionV2JobInput) DescribeEntitiesDetectionV2JobRequest
}

DescribeEntitiesDetectionV2JobRequest is the request type for the DescribeEntitiesDetectionV2Job API operation.

func (DescribeEntitiesDetectionV2JobRequest) Send added in v0.13.0 

func (r DescribeEntitiesDetectionV2JobRequest) Send(ctx context.Context) (*DescribeEntitiesDetectionV2JobResponse, error)

Send marshals and sends the DescribeEntitiesDetectionV2Job API request.

type DescribeEntitiesDetectionV2JobResponse added in v0.13.0 

type DescribeEntitiesDetectionV2JobResponse struct {
	*DescribeEntitiesDetectionV2JobOutput
	// contains filtered or unexported fields
}

DescribeEntitiesDetectionV2JobResponse is the response type for the DescribeEntitiesDetectionV2Job API operation.

func (*DescribeEntitiesDetectionV2JobResponse) SDKResponseMetdata added in v0.13.0 

func (r *DescribeEntitiesDetectionV2JobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEntitiesDetectionV2Job request.

type DescribeICD10CMInferenceJobInput added in v0.23.0 

type DescribeICD10CMInferenceJobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartICD10CMInferenceJob operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeICD10CMInferenceJobInput) String added in v0.23.0 

func (s DescribeICD10CMInferenceJobInput) String() string

String returns the string representation

func (*DescribeICD10CMInferenceJobInput) Validate added in v0.23.0 

func (s *DescribeICD10CMInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeICD10CMInferenceJobOutput added in v0.23.0 

type DescribeICD10CMInferenceJobOutput struct {

	// An object that contains the properties associated with a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeICD10CMInferenceJobOutput) String added in v0.23.0 

func (s DescribeICD10CMInferenceJobOutput) String() string

String returns the string representation

type DescribeICD10CMInferenceJobRequest added in v0.23.0 

type DescribeICD10CMInferenceJobRequest struct {
	*aws.Request
	Input *DescribeICD10CMInferenceJobInput
	Copy  func(*DescribeICD10CMInferenceJobInput) DescribeICD10CMInferenceJobRequest
}

DescribeICD10CMInferenceJobRequest is the request type for the DescribeICD10CMInferenceJob API operation.

func (DescribeICD10CMInferenceJobRequest) Send added in v0.23.0 

func (r DescribeICD10CMInferenceJobRequest) Send(ctx context.Context) (*DescribeICD10CMInferenceJobResponse, error)

Send marshals and sends the DescribeICD10CMInferenceJob API request.

type DescribeICD10CMInferenceJobResponse added in v0.23.0 

type DescribeICD10CMInferenceJobResponse struct {
	*DescribeICD10CMInferenceJobOutput
	// contains filtered or unexported fields
}

DescribeICD10CMInferenceJobResponse is the response type for the DescribeICD10CMInferenceJob API operation.

func (*DescribeICD10CMInferenceJobResponse) SDKResponseMetdata added in v0.23.0 

func (r *DescribeICD10CMInferenceJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeICD10CMInferenceJob request.

type DescribePHIDetectionJobInput added in v0.13.0 

type DescribePHIDetectionJobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartPHIDetectionJob operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePHIDetectionJobInput) String added in v0.13.0 

func (s DescribePHIDetectionJobInput) String() string

String returns the string representation

func (*DescribePHIDetectionJobInput) Validate added in v0.13.0 

func (s *DescribePHIDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePHIDetectionJobOutput added in v0.13.0 

type DescribePHIDetectionJobOutput struct {

	// An object that contains the properties associated with a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribePHIDetectionJobOutput) String added in v0.13.0 

func (s DescribePHIDetectionJobOutput) String() string

String returns the string representation

type DescribePHIDetectionJobRequest added in v0.13.0 

type DescribePHIDetectionJobRequest struct {
	*aws.Request
	Input *DescribePHIDetectionJobInput
	Copy  func(*DescribePHIDetectionJobInput) DescribePHIDetectionJobRequest
}

DescribePHIDetectionJobRequest is the request type for the DescribePHIDetectionJob API operation.

func (DescribePHIDetectionJobRequest) Send added in v0.13.0 

func (r DescribePHIDetectionJobRequest) Send(ctx context.Context) (*DescribePHIDetectionJobResponse, error)

Send marshals and sends the DescribePHIDetectionJob API request.

type DescribePHIDetectionJobResponse added in v0.13.0 

type DescribePHIDetectionJobResponse struct {
	*DescribePHIDetectionJobOutput
	// contains filtered or unexported fields
}

DescribePHIDetectionJobResponse is the response type for the DescribePHIDetectionJob API operation.

func (*DescribePHIDetectionJobResponse) SDKResponseMetdata added in v0.13.0 

func (r *DescribePHIDetectionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribePHIDetectionJob request.

type DescribeRxNormInferenceJobInput added in v0.23.0 

type DescribeRxNormInferenceJobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartRxNormInferenceJob operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRxNormInferenceJobInput) String added in v0.23.0 

func (s DescribeRxNormInferenceJobInput) String() string

String returns the string representation

func (*DescribeRxNormInferenceJobInput) Validate added in v0.23.0 

func (s *DescribeRxNormInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRxNormInferenceJobOutput added in v0.23.0 

type DescribeRxNormInferenceJobOutput struct {

	// An object that contains the properties associated with a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeRxNormInferenceJobOutput) String added in v0.23.0 

func (s DescribeRxNormInferenceJobOutput) String() string

String returns the string representation

type DescribeRxNormInferenceJobRequest added in v0.23.0 

type DescribeRxNormInferenceJobRequest struct {
	*aws.Request
	Input *DescribeRxNormInferenceJobInput
	Copy  func(*DescribeRxNormInferenceJobInput) DescribeRxNormInferenceJobRequest
}

DescribeRxNormInferenceJobRequest is the request type for the DescribeRxNormInferenceJob API operation.

func (DescribeRxNormInferenceJobRequest) Send added in v0.23.0 

func (r DescribeRxNormInferenceJobRequest) Send(ctx context.Context) (*DescribeRxNormInferenceJobResponse, error)

Send marshals and sends the DescribeRxNormInferenceJob API request.

type DescribeRxNormInferenceJobResponse added in v0.23.0 

type DescribeRxNormInferenceJobResponse struct {
	*DescribeRxNormInferenceJobOutput
	// contains filtered or unexported fields
}

DescribeRxNormInferenceJobResponse is the response type for the DescribeRxNormInferenceJob API operation.

func (*DescribeRxNormInferenceJobResponse) SDKResponseMetdata added in v0.23.0 

func (r *DescribeRxNormInferenceJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeRxNormInferenceJob request.

type DetectEntitiesInput 

type DetectEntitiesInput struct {

	// A UTF-8 text string containing the clinical content being examined for entities.
	// Each string must contain fewer than 20,000 bytes of characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectEntitiesInput) String 

func (s DetectEntitiesInput) String() string

String returns the string representation

func (*DetectEntitiesInput) Validate 

func (s *DetectEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectEntitiesOutput 

type DetectEntitiesOutput struct {

	// 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.
	//
	// Entities is a required field
	Entities []Entity `type:"list" required:"true"`

	// The version of the model used to analyze the documents. The version number
	// looks like X.X.X. You can use this information to track the model used for
	// a particular batch of documents.
	//
	// ModelVersion is a required field
	ModelVersion *string `min:"1" type:"string" required:"true"`

	// If the result of the previous request to DetectEntities was truncated, include
	// the PaginationToken to fetch the next page of entities.
	PaginationToken *string `min:"1" type:"string"`

	// Attributes extracted from the input text that we were unable to relate to
	// an entity.
	UnmappedAttributes []UnmappedAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (DetectEntitiesOutput) String 

func (s DetectEntitiesOutput) String() string

String returns the string representation

type DetectEntitiesRequest 

type DetectEntitiesRequest struct {
	*aws.Request
	Input *DetectEntitiesInput
	Copy  func(*DetectEntitiesInput) DetectEntitiesRequest
}

DetectEntitiesRequest is the request type for the DetectEntities API operation.

func (DetectEntitiesRequest) Send 

func (r DetectEntitiesRequest) Send(ctx context.Context) (*DetectEntitiesResponse, error)

Send marshals and sends the DetectEntities API request.

type DetectEntitiesResponse added in v0.9.0 

type DetectEntitiesResponse struct {
	*DetectEntitiesOutput
	// contains filtered or unexported fields
}

DetectEntitiesResponse is the response type for the DetectEntities API operation.

func (*DetectEntitiesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DetectEntitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DetectEntities request.

type DetectEntitiesV2Input added in v0.13.0 

type DetectEntitiesV2Input struct {

	// A UTF-8 string containing the clinical content being examined for entities.
	// Each string must contain fewer than 20,000 bytes of characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectEntitiesV2Input) String added in v0.13.0 

func (s DetectEntitiesV2Input) String() string

String returns the string representation

func (*DetectEntitiesV2Input) Validate added in v0.13.0 

func (s *DetectEntitiesV2Input) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectEntitiesV2Output added in v0.13.0 

type DetectEntitiesV2Output struct {

	// 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 in the detection and analysis. Attributes and traits
	// of the entity are also returned.
	//
	// Entities is a required field
	Entities []Entity `type:"list" required:"true"`

	// The version of the model used to analyze the documents. The version number
	// looks like X.X.X. You can use this information to track the model used for
	// a particular batch of documents.
	//
	// ModelVersion is a required field
	ModelVersion *string `min:"1" type:"string" required:"true"`

	// If the result to the DetectEntitiesV2 operation was truncated, include the
	// PaginationToken to fetch the next page of entities.
	PaginationToken *string `min:"1" type:"string"`

	// Attributes extracted from the input text that couldn't be related to an entity.
	UnmappedAttributes []UnmappedAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (DetectEntitiesV2Output) String added in v0.13.0 

func (s DetectEntitiesV2Output) String() string

String returns the string representation

type DetectEntitiesV2Request added in v0.13.0 

type DetectEntitiesV2Request struct {
	*aws.Request
	Input *DetectEntitiesV2Input
	Copy  func(*DetectEntitiesV2Input) DetectEntitiesV2Request
}

DetectEntitiesV2Request is the request type for the DetectEntitiesV2 API operation.

func (DetectEntitiesV2Request) Send added in v0.13.0 

func (r DetectEntitiesV2Request) Send(ctx context.Context) (*DetectEntitiesV2Response, error)

Send marshals and sends the DetectEntitiesV2 API request.

type DetectEntitiesV2Response added in v0.13.0 

type DetectEntitiesV2Response struct {
	*DetectEntitiesV2Output
	// contains filtered or unexported fields
}

DetectEntitiesV2Response is the response type for the DetectEntitiesV2 API operation.

func (*DetectEntitiesV2Response) SDKResponseMetdata added in v0.13.0 

func (r *DetectEntitiesV2Response) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DetectEntitiesV2 request.

type DetectPHIInput 

type DetectPHIInput struct {

	// A UTF-8 text string containing the clinical content being examined for PHI
	// entities. Each string must contain fewer than 20,000 bytes of characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectPHIInput) String 

func (s DetectPHIInput) String() string

String returns the string representation

func (*DetectPHIInput) Validate 

func (s *DetectPHIInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectPHIOutput 

type DetectPHIOutput struct {

	// The collection of PHI 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 its detection.
	//
	// Entities is a required field
	Entities []Entity `type:"list" required:"true"`

	// The version of the model used to analyze the documents. The version number
	// looks like X.X.X. You can use this information to track the model used for
	// a particular batch of documents.
	//
	// ModelVersion is a required field
	ModelVersion *string `min:"1" type:"string" required:"true"`

	// If the result of the previous request to DetectPHI was truncated, include
	// the PaginationToken to fetch the next page of PHI entities.
	PaginationToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DetectPHIOutput) String 

func (s DetectPHIOutput) String() string

String returns the string representation

type DetectPHIRequest 

type DetectPHIRequest struct {
	*aws.Request
	Input *DetectPHIInput
	Copy  func(*DetectPHIInput) DetectPHIRequest
}

DetectPHIRequest is the request type for the DetectPHI API operation.

func (DetectPHIRequest) Send 

func (r DetectPHIRequest) Send(ctx context.Context) (*DetectPHIResponse, error)

Send marshals and sends the DetectPHI API request.

type DetectPHIResponse added in v0.9.0 

type DetectPHIResponse struct {
	*DetectPHIOutput
	// contains filtered or unexported fields
}

DetectPHIResponse is the response type for the DetectPHI API operation.

func (*DetectPHIResponse) SDKResponseMetdata added in v0.9.0 

func (r *DetectPHIResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DetectPHI request.

type Entity 

type Entity struct {

	// The extracted attributes that relate to this entity.
	Attributes []Attribute `type:"list"`

	// 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.
	BeginOffset *int64 `type:"integer"`

	// The category of the entity.
	Category EntityType `type:"string" enum:"true"`

	// 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.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for the entity. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of the detection.
	Score *float64 `type:"float"`

	// The segment of input text extracted as this entity.
	Text *string `min:"1" type:"string"`

	// Contextual information for the entity.
	Traits []Trait `type:"list"`

	// Describes the specific type of entity with category of entities.
	Type EntitySubType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Provides information about an extracted medical entity.

func (Entity) String 

func (s Entity) String() string

String returns the string representation

type EntitySubType 

type EntitySubType string
const (
	EntitySubTypeName                 EntitySubType = "NAME"
	EntitySubTypeDosage               EntitySubType = "DOSAGE"
	EntitySubTypeRouteOrMode          EntitySubType = "ROUTE_OR_MODE"
	EntitySubTypeForm                 EntitySubType = "FORM"
	EntitySubTypeFrequency            EntitySubType = "FREQUENCY"
	EntitySubTypeDuration             EntitySubType = "DURATION"
	EntitySubTypeGenericName          EntitySubType = "GENERIC_NAME"
	EntitySubTypeBrandName            EntitySubType = "BRAND_NAME"
	EntitySubTypeStrength             EntitySubType = "STRENGTH"
	EntitySubTypeRate                 EntitySubType = "RATE"
	EntitySubTypeAcuity               EntitySubType = "ACUITY"
	EntitySubTypeTestName             EntitySubType = "TEST_NAME"
	EntitySubTypeTestValue            EntitySubType = "TEST_VALUE"
	EntitySubTypeTestUnits            EntitySubType = "TEST_UNITS"
	EntitySubTypeProcedureName        EntitySubType = "PROCEDURE_NAME"
	EntitySubTypeTreatmentName        EntitySubType = "TREATMENT_NAME"
	EntitySubTypeDate                 EntitySubType = "DATE"
	EntitySubTypeAge                  EntitySubType = "AGE"
	EntitySubTypeContactPoint         EntitySubType = "CONTACT_POINT"
	EntitySubTypeEmail                EntitySubType = "EMAIL"
	EntitySubTypeIdentifier           EntitySubType = "IDENTIFIER"
	EntitySubTypeUrl                  EntitySubType = "URL"
	EntitySubTypeAddress              EntitySubType = "ADDRESS"
	EntitySubTypeProfession           EntitySubType = "PROFESSION"
	EntitySubTypeSystemOrganSite      EntitySubType = "SYSTEM_ORGAN_SITE"
	EntitySubTypeDirection            EntitySubType = "DIRECTION"
	EntitySubTypeQuality              EntitySubType = "QUALITY"
	EntitySubTypeQuantity             EntitySubType = "QUANTITY"
	EntitySubTypeTimeExpression       EntitySubType = "TIME_EXPRESSION"
	EntitySubTypeTimeToMedicationName EntitySubType = "TIME_TO_MEDICATION_NAME"
	EntitySubTypeTimeToDxName         EntitySubType = "TIME_TO_DX_NAME"
	EntitySubTypeTimeToTestName       EntitySubType = "TIME_TO_TEST_NAME"
	EntitySubTypeTimeToProcedureName  EntitySubType = "TIME_TO_PROCEDURE_NAME"
	EntitySubTypeTimeToTreatmentName  EntitySubType = "TIME_TO_TREATMENT_NAME"
)

Enum values for EntitySubType

func (EntitySubType) MarshalValue 

func (enum EntitySubType) MarshalValue() (string, error)

func (EntitySubType) MarshalValueBuf 

func (enum EntitySubType) MarshalValueBuf(b []byte) ([]byte, error)

type EntityType 

type EntityType string
const (
	EntityTypeMedication                 EntityType = "MEDICATION"
	EntityTypeMedicalCondition           EntityType = "MEDICAL_CONDITION"
	EntityTypeProtectedHealthInformation EntityType = "PROTECTED_HEALTH_INFORMATION"
	EntityTypeTestTreatmentProcedure     EntityType = "TEST_TREATMENT_PROCEDURE"
	EntityTypeAnatomy                    EntityType = "ANATOMY"
	EntityTypeTimeExpression             EntityType = "TIME_EXPRESSION"
)

Enum values for EntityType

func (EntityType) MarshalValue 

func (enum EntityType) MarshalValue() (string, error)

func (EntityType) MarshalValueBuf 

func (enum EntityType) MarshalValueBuf(b []byte) ([]byte, error)

type ICD10CMAttribute added in v0.19.0 

type ICD10CMAttribute struct {

	// 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.
	BeginOffset *int64 `type:"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.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for this attribute. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has that this attribute
	// is correctly related to this entity.
	RelationshipScore *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend Medical has that the segment
	// of text is correctly recognized as an attribute.
	Score *float64 `type:"float"`

	// The segment of input text which contains the detected attribute.
	Text *string `min:"1" type:"string"`

	// The contextual information for the attribute. The traits recognized by InferICD10CM
	// are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.
	Traits []ICD10CMTrait `type:"list"`

	// The type of attribute. InferICD10CM detects entities of the type DX_NAME.
	Type ICD10CMAttributeType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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.

func (ICD10CMAttribute) String added in v0.19.0 

func (s ICD10CMAttribute) String() string

String returns the string representation

type ICD10CMAttributeType added in v0.19.0 

type ICD10CMAttributeType string
const (
	ICD10CMAttributeTypeAcuity          ICD10CMAttributeType = "ACUITY"
	ICD10CMAttributeTypeDirection       ICD10CMAttributeType = "DIRECTION"
	ICD10CMAttributeTypeSystemOrganSite ICD10CMAttributeType = "SYSTEM_ORGAN_SITE"
	ICD10CMAttributeTypeQuality         ICD10CMAttributeType = "QUALITY"
	ICD10CMAttributeTypeQuantity        ICD10CMAttributeType = "QUANTITY"
)

Enum values for ICD10CMAttributeType

func (ICD10CMAttributeType) MarshalValue added in v0.19.0 

func (enum ICD10CMAttributeType) MarshalValue() (string, error)

func (ICD10CMAttributeType) MarshalValueBuf added in v0.19.0 

func (enum ICD10CMAttributeType) MarshalValueBuf(b []byte) ([]byte, error)

type ICD10CMConcept added in v0.19.0 

type ICD10CMConcept struct {

	// The ICD-10-CM code that identifies the concept found in the knowledge base
	// from the Centers for Disease Control.
	Code *string `min:"1" type:"string"`

	// The long description of the ICD-10-CM code in the ontology.
	Description *string `min:"1" type:"string"`

	// The level of confidence that Amazon Comprehend Medical has that the entity
	// is accurately linked to an ICD-10-CM concept.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

func (ICD10CMConcept) String added in v0.19.0 

func (s ICD10CMConcept) String() string

String returns the string representation

type ICD10CMEntity added in v0.19.0 

type ICD10CMEntity struct {

	// The detected attributes that relate to the entity. An extracted segment of
	// the text that is an attribute of an entity, or otherwise related to an entity,
	// such as the nature of a medical condition.
	Attributes []ICD10CMAttribute `type:"list"`

	// 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.
	BeginOffset *int64 `type:"integer"`

	// The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION
	// category.
	Category ICD10CMEntityCategory `type:"string" enum:"true"`

	// 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.
	EndOffset *int64 `type:"integer"`

	// The ICD-10-CM concepts that the entity could refer to, along with a score
	// indicating the likelihood of the match.
	ICD10CMConcepts []ICD10CMConcept `type:"list"`

	// The numeric identifier for the entity. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of the detection.
	Score *float64 `type:"float"`

	// The segment of input text that is matched to the detected entity.
	Text *string `min:"1" type:"string"`

	// Provides Contextual information for the entity. The traits recognized by
	// InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.
	Traits []ICD10CMTrait `type:"list"`

	// Describes the specific type of entity with category of entities. InferICD10CM
	// detects entities of the type DX_NAME.
	Type ICD10CMEntityType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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.

func (ICD10CMEntity) String added in v0.19.0 

func (s ICD10CMEntity) String() string

String returns the string representation

type ICD10CMEntityCategory added in v0.19.0 

type ICD10CMEntityCategory string
const (
	ICD10CMEntityCategoryMedicalCondition ICD10CMEntityCategory = "MEDICAL_CONDITION"
)

Enum values for ICD10CMEntityCategory

func (ICD10CMEntityCategory) MarshalValue added in v0.19.0 

func (enum ICD10CMEntityCategory) MarshalValue() (string, error)

func (ICD10CMEntityCategory) MarshalValueBuf added in v0.19.0 

func (enum ICD10CMEntityCategory) MarshalValueBuf(b []byte) ([]byte, error)

type ICD10CMEntityType added in v0.19.0 

type ICD10CMEntityType string
const (
	ICD10CMEntityTypeDxName ICD10CMEntityType = "DX_NAME"
)

Enum values for ICD10CMEntityType

func (ICD10CMEntityType) MarshalValue added in v0.19.0 

func (enum ICD10CMEntityType) MarshalValue() (string, error)

func (ICD10CMEntityType) MarshalValueBuf added in v0.19.0 

func (enum ICD10CMEntityType) MarshalValueBuf(b []byte) ([]byte, error)

type ICD10CMTrait added in v0.19.0 

type ICD10CMTrait struct {

	// Provides a name or contextual description about the trait.
	Name ICD10CMTraitName `type:"string" enum:"true"`

	// The level of confidence that Amazon Comprehend Medical has that the segment
	// of text is correctly recognized as a trait.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

func (ICD10CMTrait) String added in v0.19.0 

func (s ICD10CMTrait) String() string

String returns the string representation

type ICD10CMTraitName added in v0.19.0 

type ICD10CMTraitName string
const (
	ICD10CMTraitNameNegation  ICD10CMTraitName = "NEGATION"
	ICD10CMTraitNameDiagnosis ICD10CMTraitName = "DIAGNOSIS"
	ICD10CMTraitNameSign      ICD10CMTraitName = "SIGN"
	ICD10CMTraitNameSymptom   ICD10CMTraitName = "SYMPTOM"
)

Enum values for ICD10CMTraitName

func (ICD10CMTraitName) MarshalValue added in v0.19.0 

func (enum ICD10CMTraitName) MarshalValue() (string, error)

func (ICD10CMTraitName) MarshalValueBuf added in v0.19.0 

func (enum ICD10CMTraitName) MarshalValueBuf(b []byte) ([]byte, error)

type InferICD10CMInput added in v0.19.0 

type InferICD10CMInput struct {

	// The input text used for analysis. The input for InferICD10CM is a string
	// from 1 to 10000 characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (InferICD10CMInput) String added in v0.19.0 

func (s InferICD10CMInput) String() string

String returns the string representation

func (*InferICD10CMInput) Validate added in v0.19.0 

func (s *InferICD10CMInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InferICD10CMOutput added in v0.19.0 

type InferICD10CMOutput struct {

	// The medical conditions detected in the text linked to ICD-10-CM concepts.
	// If the action is successful, the service sends back an HTTP 200 response,
	// as well as the entities detected.
	//
	// Entities is a required field
	Entities []ICD10CMEntity `type:"list" required:"true"`

	// 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.
	ModelVersion *string `min:"1" type:"string"`

	// If the result of the previous request to InferICD10CM was truncated, include
	// the PaginationToken to fetch the next page of medical condition entities.
	PaginationToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (InferICD10CMOutput) String added in v0.19.0 

func (s InferICD10CMOutput) String() string

String returns the string representation

type InferICD10CMRequest added in v0.19.0 

type InferICD10CMRequest struct {
	*aws.Request
	Input *InferICD10CMInput
	Copy  func(*InferICD10CMInput) InferICD10CMRequest
}

InferICD10CMRequest is the request type for the InferICD10CM API operation.

func (InferICD10CMRequest) Send added in v0.19.0 

func (r InferICD10CMRequest) Send(ctx context.Context) (*InferICD10CMResponse, error)

Send marshals and sends the InferICD10CM API request.

type InferICD10CMResponse added in v0.19.0 

type InferICD10CMResponse struct {
	*InferICD10CMOutput
	// contains filtered or unexported fields
}

InferICD10CMResponse is the response type for the InferICD10CM API operation.

func (*InferICD10CMResponse) SDKResponseMetdata added in v0.19.0 

func (r *InferICD10CMResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the InferICD10CM request.

type InferRxNormInput added in v0.19.0 

type InferRxNormInput struct {

	// The input text used for analysis. The input for InferRxNorm is a string from
	// 1 to 10000 characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (InferRxNormInput) String added in v0.19.0 

func (s InferRxNormInput) String() string

String returns the string representation

func (*InferRxNormInput) Validate added in v0.19.0 

func (s *InferRxNormInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InferRxNormOutput added in v0.19.0 

type InferRxNormOutput struct {

	// 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.
	//
	// Entities is a required field
	Entities []RxNormEntity `type:"list" required:"true"`

	// 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.
	ModelVersion *string `min:"1" type:"string"`

	// If the result of the previous request to InferRxNorm was truncated, include
	// the PaginationToken to fetch the next page of medication entities.
	PaginationToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (InferRxNormOutput) String added in v0.19.0 

func (s InferRxNormOutput) String() string

String returns the string representation

type InferRxNormRequest added in v0.19.0 

type InferRxNormRequest struct {
	*aws.Request
	Input *InferRxNormInput
	Copy  func(*InferRxNormInput) InferRxNormRequest
}

InferRxNormRequest is the request type for the InferRxNorm API operation.

func (InferRxNormRequest) Send added in v0.19.0 

func (r InferRxNormRequest) Send(ctx context.Context) (*InferRxNormResponse, error)

Send marshals and sends the InferRxNorm API request.

type InferRxNormResponse added in v0.19.0 

type InferRxNormResponse struct {
	*InferRxNormOutput
	// contains filtered or unexported fields
}

InferRxNormResponse is the response type for the InferRxNorm API operation.

func (*InferRxNormResponse) SDKResponseMetdata added in v0.19.0 

func (r *InferRxNormResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the InferRxNorm request.

type InputDataConfig added in v0.13.0 

type InputDataConfig struct {

	// The URI of the S3 bucket that contains the input data. The bucket must be
	// in the same region as the API endpoint that you are calling.
	//
	// Each file in the document collection must be less than 40 KB. You can store
	// a maximum of 30 GB in the bucket.
	//
	// S3Bucket is a required field
	S3Bucket *string `min:"3" type:"string" required:"true"`

	// The path to the input data files in the S3 bucket.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

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.

func (InputDataConfig) String added in v0.13.0 

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate added in v0.13.0 

func (s *InputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JobStatus added in v0.13.0 

type JobStatus string
const (
	JobStatusSubmitted      JobStatus = "SUBMITTED"
	JobStatusInProgress     JobStatus = "IN_PROGRESS"
	JobStatusCompleted      JobStatus = "COMPLETED"
	JobStatusPartialSuccess JobStatus = "PARTIAL_SUCCESS"
	JobStatusFailed         JobStatus = "FAILED"
	JobStatusStopRequested  JobStatus = "STOP_REQUESTED"
	JobStatusStopped        JobStatus = "STOPPED"
)

Enum values for JobStatus

func (JobStatus) MarshalValue added in v0.13.0 

func (enum JobStatus) MarshalValue() (string, error)

func (JobStatus) MarshalValueBuf added in v0.13.0 

func (enum JobStatus) MarshalValueBuf(b []byte) ([]byte, error)

type LanguageCode added in v0.13.0 

type LanguageCode string
const (
	LanguageCodeEn LanguageCode = "en"
)

Enum values for LanguageCode

func (LanguageCode) MarshalValue added in v0.13.0 

func (enum LanguageCode) MarshalValue() (string, error)

func (LanguageCode) MarshalValueBuf added in v0.13.0 

func (enum LanguageCode) MarshalValueBuf(b []byte) ([]byte, error)

type ListEntitiesDetectionV2JobsInput added in v0.13.0 

type ListEntitiesDetectionV2JobsInput struct {

	// Filters the jobs that are returned. You can filter jobs based on their names,
	// status, or the date and time that they were submitted. You can only set one
	// filter at a time.
	Filter *ComprehendMedicalAsyncJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesDetectionV2JobsInput) String added in v0.13.0 

func (s ListEntitiesDetectionV2JobsInput) String() string

String returns the string representation

func (*ListEntitiesDetectionV2JobsInput) Validate added in v0.13.0 

func (s *ListEntitiesDetectionV2JobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEntitiesDetectionV2JobsOutput added in v0.13.0 

type ListEntitiesDetectionV2JobsOutput struct {

	// A list containing the properties of each job returned.
	ComprehendMedicalAsyncJobPropertiesList []ComprehendMedicalAsyncJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesDetectionV2JobsOutput) String added in v0.13.0 

func (s ListEntitiesDetectionV2JobsOutput) String() string

String returns the string representation

type ListEntitiesDetectionV2JobsRequest added in v0.13.0 

type ListEntitiesDetectionV2JobsRequest struct {
	*aws.Request
	Input *ListEntitiesDetectionV2JobsInput
	Copy  func(*ListEntitiesDetectionV2JobsInput) ListEntitiesDetectionV2JobsRequest
}

ListEntitiesDetectionV2JobsRequest is the request type for the ListEntitiesDetectionV2Jobs API operation.

func (ListEntitiesDetectionV2JobsRequest) Send added in v0.13.0 

func (r ListEntitiesDetectionV2JobsRequest) Send(ctx context.Context) (*ListEntitiesDetectionV2JobsResponse, error)

Send marshals and sends the ListEntitiesDetectionV2Jobs API request.

type ListEntitiesDetectionV2JobsResponse added in v0.13.0 

type ListEntitiesDetectionV2JobsResponse struct {
	*ListEntitiesDetectionV2JobsOutput
	// contains filtered or unexported fields
}

ListEntitiesDetectionV2JobsResponse is the response type for the ListEntitiesDetectionV2Jobs API operation.

func (*ListEntitiesDetectionV2JobsResponse) SDKResponseMetdata added in v0.13.0 

func (r *ListEntitiesDetectionV2JobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListEntitiesDetectionV2Jobs request.

type ListICD10CMInferenceJobsInput added in v0.23.0 

type ListICD10CMInferenceJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs based on their names,
	// status, or the date and time that they were submitted. You can only set one
	// filter at a time.
	Filter *ComprehendMedicalAsyncJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListICD10CMInferenceJobsInput) String added in v0.23.0 

func (s ListICD10CMInferenceJobsInput) String() string

String returns the string representation

func (*ListICD10CMInferenceJobsInput) Validate added in v0.23.0 

func (s *ListICD10CMInferenceJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListICD10CMInferenceJobsOutput added in v0.23.0 

type ListICD10CMInferenceJobsOutput struct {

	// A list containing the properties of each job that is returned.
	ComprehendMedicalAsyncJobPropertiesList []ComprehendMedicalAsyncJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListICD10CMInferenceJobsOutput) String added in v0.23.0 

func (s ListICD10CMInferenceJobsOutput) String() string

String returns the string representation

type ListICD10CMInferenceJobsRequest added in v0.23.0 

type ListICD10CMInferenceJobsRequest struct {
	*aws.Request
	Input *ListICD10CMInferenceJobsInput
	Copy  func(*ListICD10CMInferenceJobsInput) ListICD10CMInferenceJobsRequest
}

ListICD10CMInferenceJobsRequest is the request type for the ListICD10CMInferenceJobs API operation.

func (ListICD10CMInferenceJobsRequest) Send added in v0.23.0 

func (r ListICD10CMInferenceJobsRequest) Send(ctx context.Context) (*ListICD10CMInferenceJobsResponse, error)

Send marshals and sends the ListICD10CMInferenceJobs API request.

type ListICD10CMInferenceJobsResponse added in v0.23.0 

type ListICD10CMInferenceJobsResponse struct {
	*ListICD10CMInferenceJobsOutput
	// contains filtered or unexported fields
}

ListICD10CMInferenceJobsResponse is the response type for the ListICD10CMInferenceJobs API operation.

func (*ListICD10CMInferenceJobsResponse) SDKResponseMetdata added in v0.23.0 

func (r *ListICD10CMInferenceJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListICD10CMInferenceJobs request.

type ListPHIDetectionJobsInput added in v0.13.0 

type ListPHIDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs based on their names,
	// status, or the date and time that they were submitted. You can only set one
	// filter at a time.
	Filter *ComprehendMedicalAsyncJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPHIDetectionJobsInput) String added in v0.13.0 

func (s ListPHIDetectionJobsInput) String() string

String returns the string representation

func (*ListPHIDetectionJobsInput) Validate added in v0.13.0 

func (s *ListPHIDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPHIDetectionJobsOutput added in v0.13.0 

type ListPHIDetectionJobsOutput struct {

	// A list containing the properties of each job returned.
	ComprehendMedicalAsyncJobPropertiesList []ComprehendMedicalAsyncJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPHIDetectionJobsOutput) String added in v0.13.0 

func (s ListPHIDetectionJobsOutput) String() string

String returns the string representation

type ListPHIDetectionJobsRequest added in v0.13.0 

type ListPHIDetectionJobsRequest struct {
	*aws.Request
	Input *ListPHIDetectionJobsInput
	Copy  func(*ListPHIDetectionJobsInput) ListPHIDetectionJobsRequest
}

ListPHIDetectionJobsRequest is the request type for the ListPHIDetectionJobs API operation.

func (ListPHIDetectionJobsRequest) Send added in v0.13.0 

func (r ListPHIDetectionJobsRequest) Send(ctx context.Context) (*ListPHIDetectionJobsResponse, error)

Send marshals and sends the ListPHIDetectionJobs API request.

type ListPHIDetectionJobsResponse added in v0.13.0 

type ListPHIDetectionJobsResponse struct {
	*ListPHIDetectionJobsOutput
	// contains filtered or unexported fields
}

ListPHIDetectionJobsResponse is the response type for the ListPHIDetectionJobs API operation.

func (*ListPHIDetectionJobsResponse) SDKResponseMetdata added in v0.13.0 

func (r *ListPHIDetectionJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPHIDetectionJobs request.

type ListRxNormInferenceJobsInput added in v0.23.0 

type ListRxNormInferenceJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs based on their names,
	// status, or the date and time that they were submitted. You can only set one
	// filter at a time.
	Filter *ComprehendMedicalAsyncJobFilter `type:"structure"`

	// Identifies the next page of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRxNormInferenceJobsInput) String added in v0.23.0 

func (s ListRxNormInferenceJobsInput) String() string

String returns the string representation

func (*ListRxNormInferenceJobsInput) Validate added in v0.23.0 

func (s *ListRxNormInferenceJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRxNormInferenceJobsOutput added in v0.23.0 

type ListRxNormInferenceJobsOutput struct {

	// The maximum number of results to return in each page. The default is 100.
	ComprehendMedicalAsyncJobPropertiesList []ComprehendMedicalAsyncJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRxNormInferenceJobsOutput) String added in v0.23.0 

func (s ListRxNormInferenceJobsOutput) String() string

String returns the string representation

type ListRxNormInferenceJobsRequest added in v0.23.0 

type ListRxNormInferenceJobsRequest struct {
	*aws.Request
	Input *ListRxNormInferenceJobsInput
	Copy  func(*ListRxNormInferenceJobsInput) ListRxNormInferenceJobsRequest
}

ListRxNormInferenceJobsRequest is the request type for the ListRxNormInferenceJobs API operation.

func (ListRxNormInferenceJobsRequest) Send added in v0.23.0 

func (r ListRxNormInferenceJobsRequest) Send(ctx context.Context) (*ListRxNormInferenceJobsResponse, error)

Send marshals and sends the ListRxNormInferenceJobs API request.

type ListRxNormInferenceJobsResponse added in v0.23.0 

type ListRxNormInferenceJobsResponse struct {
	*ListRxNormInferenceJobsOutput
	// contains filtered or unexported fields
}

ListRxNormInferenceJobsResponse is the response type for the ListRxNormInferenceJobs API operation.

func (*ListRxNormInferenceJobsResponse) SDKResponseMetdata added in v0.23.0 

func (r *ListRxNormInferenceJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListRxNormInferenceJobs request.

type OutputDataConfig added in v0.13.0 

type OutputDataConfig struct {

	// When you use the OutputDataConfig object with asynchronous operations, you
	// specify the Amazon S3 location where you want to write the output data. The
	// URI must be in the same region as the API endpoint that you are calling.
	// The location is used as the prefix for the actual location of the output.
	//
	// S3Bucket is a required field
	S3Bucket *string `min:"3" type:"string" required:"true"`

	// The path to the output data files in the S3 bucket. Amazon Comprehend Medical
	// creates an output directory using the job ID so that the output from one
	// job does not overwrite the output of another.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

The output properties for a detection job.

func (OutputDataConfig) String added in v0.13.0 

func (s OutputDataConfig) String() string

String returns the string representation

func (*OutputDataConfig) Validate added in v0.13.0 

func (s *OutputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RelationshipType added in v0.20.0 

type RelationshipType string
const (
	RelationshipTypeEvery           RelationshipType = "EVERY"
	RelationshipTypeWithDosage      RelationshipType = "WITH_DOSAGE"
	RelationshipTypeAdministeredVia RelationshipType = "ADMINISTERED_VIA"
	RelationshipTypeFor             RelationshipType = "FOR"
	RelationshipTypeNegative        RelationshipType = "NEGATIVE"
	RelationshipTypeOverlap         RelationshipType = "OVERLAP"
	RelationshipTypeDosage          RelationshipType = "DOSAGE"
	RelationshipTypeRouteOrMode     RelationshipType = "ROUTE_OR_MODE"
	RelationshipTypeForm            RelationshipType = "FORM"
	RelationshipTypeFrequency       RelationshipType = "FREQUENCY"
	RelationshipTypeDuration        RelationshipType = "DURATION"
	RelationshipTypeStrength        RelationshipType = "STRENGTH"
	RelationshipTypeRate            RelationshipType = "RATE"
	RelationshipTypeAcuity          RelationshipType = "ACUITY"
	RelationshipTypeTestValue       RelationshipType = "TEST_VALUE"
	RelationshipTypeTestUnits       RelationshipType = "TEST_UNITS"
	RelationshipTypeDirection       RelationshipType = "DIRECTION"
	RelationshipTypeSystemOrganSite RelationshipType = "SYSTEM_ORGAN_SITE"
)

Enum values for RelationshipType

func (RelationshipType) MarshalValue added in v0.20.0 

func (enum RelationshipType) MarshalValue() (string, error)

func (RelationshipType) MarshalValueBuf added in v0.20.0 

func (enum RelationshipType) MarshalValueBuf(b []byte) ([]byte, error)

type RxNormAttribute added in v0.19.0 

type RxNormAttribute struct {

	// 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.
	BeginOffset *int64 `type:"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.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for this attribute. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has that the attribute
	// is accurately linked to an entity.
	RelationshipScore *float64 `type:"float"`

	// The level of confidence that Comprehend Medical has that the segment of text
	// is correctly recognized as an attribute.
	Score *float64 `type:"float"`

	// The segment of input text which corresponds to the detected attribute.
	Text *string `min:"1" type:"string"`

	// Contextual information for the attribute. InferRxNorm recognizes the trait
	// NEGATION for attributes, i.e. that the patient is not taking a specific dose
	// or form of a medication.
	Traits []RxNormTrait `type:"list"`

	// The type of attribute. The types of attributes recognized by InferRxNorm
	// are BRAND_NAME and GENERIC_NAME.
	Type RxNormAttributeType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The extracted attributes that relate to this entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE.

func (RxNormAttribute) String added in v0.19.0 

func (s RxNormAttribute) String() string

String returns the string representation

type RxNormAttributeType added in v0.19.0 

type RxNormAttributeType string
const (
	RxNormAttributeTypeDosage      RxNormAttributeType = "DOSAGE"
	RxNormAttributeTypeDuration    RxNormAttributeType = "DURATION"
	RxNormAttributeTypeForm        RxNormAttributeType = "FORM"
	RxNormAttributeTypeFrequency   RxNormAttributeType = "FREQUENCY"
	RxNormAttributeTypeRate        RxNormAttributeType = "RATE"
	RxNormAttributeTypeRouteOrMode RxNormAttributeType = "ROUTE_OR_MODE"
	RxNormAttributeTypeStrength    RxNormAttributeType = "STRENGTH"
)

Enum values for RxNormAttributeType

func (RxNormAttributeType) MarshalValue added in v0.19.0 

func (enum RxNormAttributeType) MarshalValue() (string, error)

func (RxNormAttributeType) MarshalValueBuf added in v0.19.0 

func (enum RxNormAttributeType) MarshalValueBuf(b []byte) ([]byte, error)

type RxNormConcept added in v0.19.0 

type RxNormConcept struct {

	// RxNorm concept ID, also known as the RxCUI.
	Code *string `min:"1" type:"string"`

	// The description of the RxNorm concept.
	Description *string `min:"1" type:"string"`

	// The level of confidence that Amazon Comprehend Medical has that the entity
	// is accurately linked to the reported RxNorm concept.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

The RxNorm concept that the entity could refer to, along with a score indicating the likelihood of the match.

func (RxNormConcept) String added in v0.19.0 

func (s RxNormConcept) String() string

String returns the string representation

type RxNormEntity added in v0.19.0 

type RxNormEntity struct {

	// The extracted attributes that relate to the entity. The attributes recognized
	// by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE,
	// and STRENGTH.
	Attributes []RxNormAttribute `type:"list"`

	// 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.
	BeginOffset *int64 `type:"integer"`

	// The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
	Category RxNormEntityCategory `type:"string" enum:"true"`

	// 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.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for the entity. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The RxNorm concepts that the entity could refer to, along with a score indicating
	// the likelihood of the match.
	RxNormConcepts []RxNormConcept `type:"list"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of the detected entity.
	Score *float64 `type:"float"`

	// The segment of input text extracted from which the entity was detected.
	Text *string `min:"1" type:"string"`

	// Contextual information for the entity.
	Traits []RxNormTrait `type:"list"`

	// Describes the specific type of entity. For InferRxNorm, the recognized entity
	// type is MEDICATION.
	Type RxNormEntityType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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.

func (RxNormEntity) String added in v0.19.0 

func (s RxNormEntity) String() string

String returns the string representation

type RxNormEntityCategory added in v0.19.0 

type RxNormEntityCategory string
const (
	RxNormEntityCategoryMedication RxNormEntityCategory = "MEDICATION"
)

Enum values for RxNormEntityCategory

func (RxNormEntityCategory) MarshalValue added in v0.19.0 

func (enum RxNormEntityCategory) MarshalValue() (string, error)

func (RxNormEntityCategory) MarshalValueBuf added in v0.19.0 

func (enum RxNormEntityCategory) MarshalValueBuf(b []byte) ([]byte, error)

type RxNormEntityType added in v0.19.0 

type RxNormEntityType string
const (
	RxNormEntityTypeBrandName   RxNormEntityType = "BRAND_NAME"
	RxNormEntityTypeGenericName RxNormEntityType = "GENERIC_NAME"
)

Enum values for RxNormEntityType

func (RxNormEntityType) MarshalValue added in v0.19.0 

func (enum RxNormEntityType) MarshalValue() (string, error)

func (RxNormEntityType) MarshalValueBuf added in v0.19.0 

func (enum RxNormEntityType) MarshalValueBuf(b []byte) ([]byte, error)

type RxNormTrait added in v0.19.0 

type RxNormTrait struct {

	// Provides a name or contextual description about the trait.
	Name RxNormTraitName `type:"string" enum:"true"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of the detected trait.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

The contextual information for the entity. InferRxNorm recognizes the trait NEGATION, which is any indication that the patient is not taking a medication.

func (RxNormTrait) String added in v0.19.0 

func (s RxNormTrait) String() string

String returns the string representation

type RxNormTraitName added in v0.19.0 

type RxNormTraitName string
const (
	RxNormTraitNameNegation RxNormTraitName = "NEGATION"
)

Enum values for RxNormTraitName

func (RxNormTraitName) MarshalValue added in v0.19.0 

func (enum RxNormTraitName) MarshalValue() (string, error)

func (RxNormTraitName) MarshalValueBuf added in v0.19.0 

func (enum RxNormTraitName) MarshalValueBuf(b []byte) ([]byte, error)

type StartEntitiesDetectionV2JobInput added in v0.13.0 

type StartEntitiesDetectionV2JobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that grants Amazon Comprehend Medical read access to your input
	// data. For more information, see Role-Based Permissions Required for Asynchronous
	// Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// An AWS Key Management Service key to encrypt your output files. If you do
	// not specify a key, the files are written in plain text.
	KMSKey *string `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionV2JobInput) String added in v0.13.0 

func (s StartEntitiesDetectionV2JobInput) String() string

String returns the string representation

func (*StartEntitiesDetectionV2JobInput) Validate added in v0.13.0 

func (s *StartEntitiesDetectionV2JobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartEntitiesDetectionV2JobOutput added in v0.13.0 

type StartEntitiesDetectionV2JobOutput struct {

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the DescribeEntitiesDetectionV2Job operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionV2JobOutput) String added in v0.13.0 

func (s StartEntitiesDetectionV2JobOutput) String() string

String returns the string representation

type StartEntitiesDetectionV2JobRequest added in v0.13.0 

type StartEntitiesDetectionV2JobRequest struct {
	*aws.Request
	Input *StartEntitiesDetectionV2JobInput
	Copy  func(*StartEntitiesDetectionV2JobInput) StartEntitiesDetectionV2JobRequest
}

StartEntitiesDetectionV2JobRequest is the request type for the StartEntitiesDetectionV2Job API operation.

func (StartEntitiesDetectionV2JobRequest) Send added in v0.13.0 

func (r StartEntitiesDetectionV2JobRequest) Send(ctx context.Context) (*StartEntitiesDetectionV2JobResponse, error)

Send marshals and sends the StartEntitiesDetectionV2Job API request.

type StartEntitiesDetectionV2JobResponse added in v0.13.0 

type StartEntitiesDetectionV2JobResponse struct {
	*StartEntitiesDetectionV2JobOutput
	// contains filtered or unexported fields
}

StartEntitiesDetectionV2JobResponse is the response type for the StartEntitiesDetectionV2Job API operation.

func (*StartEntitiesDetectionV2JobResponse) SDKResponseMetdata added in v0.13.0 

func (r *StartEntitiesDetectionV2JobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartEntitiesDetectionV2Job request.

type StartICD10CMInferenceJobInput added in v0.23.0 

type StartICD10CMInferenceJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that grants Amazon Comprehend Medical read access to your input
	// data. For more information, see Role-Based Permissions Required for Asynchronous
	// Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// An AWS Key Management Service key to encrypt your output files. If you do
	// not specify a key, the files are written in plain text.
	KMSKey *string `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartICD10CMInferenceJobInput) String added in v0.23.0 

func (s StartICD10CMInferenceJobInput) String() string

String returns the string representation

func (*StartICD10CMInferenceJobInput) Validate added in v0.23.0 

func (s *StartICD10CMInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartICD10CMInferenceJobOutput added in v0.23.0 

type StartICD10CMInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the StartICD10CMInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartICD10CMInferenceJobOutput) String added in v0.23.0 

func (s StartICD10CMInferenceJobOutput) String() string

String returns the string representation

type StartICD10CMInferenceJobRequest added in v0.23.0 

type StartICD10CMInferenceJobRequest struct {
	*aws.Request
	Input *StartICD10CMInferenceJobInput
	Copy  func(*StartICD10CMInferenceJobInput) StartICD10CMInferenceJobRequest
}

StartICD10CMInferenceJobRequest is the request type for the StartICD10CMInferenceJob API operation.

func (StartICD10CMInferenceJobRequest) Send added in v0.23.0 

func (r StartICD10CMInferenceJobRequest) Send(ctx context.Context) (*StartICD10CMInferenceJobResponse, error)

Send marshals and sends the StartICD10CMInferenceJob API request.

type StartICD10CMInferenceJobResponse added in v0.23.0 

type StartICD10CMInferenceJobResponse struct {
	*StartICD10CMInferenceJobOutput
	// contains filtered or unexported fields
}

StartICD10CMInferenceJobResponse is the response type for the StartICD10CMInferenceJob API operation.

func (*StartICD10CMInferenceJobResponse) SDKResponseMetdata added in v0.23.0 

func (r *StartICD10CMInferenceJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartICD10CMInferenceJob request.

type StartPHIDetectionJobInput added in v0.13.0 

type StartPHIDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that grants Amazon Comprehend Medical read access to your input
	// data. For more information, see Role-Based Permissions Required for Asynchronous
	// Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// An AWS Key Management Service key to encrypt your output files. If you do
	// not specify a key, the files are written in plain text.
	KMSKey *string `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartPHIDetectionJobInput) String added in v0.13.0 

func (s StartPHIDetectionJobInput) String() string

String returns the string representation

func (*StartPHIDetectionJobInput) Validate added in v0.13.0 

func (s *StartPHIDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartPHIDetectionJobOutput added in v0.13.0 

type StartPHIDetectionJobOutput struct {

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the DescribePHIDetectionJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartPHIDetectionJobOutput) String added in v0.13.0 

func (s StartPHIDetectionJobOutput) String() string

String returns the string representation

type StartPHIDetectionJobRequest added in v0.13.0 

type StartPHIDetectionJobRequest struct {
	*aws.Request
	Input *StartPHIDetectionJobInput
	Copy  func(*StartPHIDetectionJobInput) StartPHIDetectionJobRequest
}

StartPHIDetectionJobRequest is the request type for the StartPHIDetectionJob API operation.

func (StartPHIDetectionJobRequest) Send added in v0.13.0 

func (r StartPHIDetectionJobRequest) Send(ctx context.Context) (*StartPHIDetectionJobResponse, error)

Send marshals and sends the StartPHIDetectionJob API request.

type StartPHIDetectionJobResponse added in v0.13.0 

type StartPHIDetectionJobResponse struct {
	*StartPHIDetectionJobOutput
	// contains filtered or unexported fields
}

StartPHIDetectionJobResponse is the response type for the StartPHIDetectionJob API operation.

func (*StartPHIDetectionJobResponse) SDKResponseMetdata added in v0.13.0 

func (r *StartPHIDetectionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartPHIDetectionJob request.

type StartRxNormInferenceJobInput added in v0.23.0 

type StartRxNormInferenceJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that grants Amazon Comprehend Medical read access to your input
	// data. For more information, see Role-Based Permissions Required for Asynchronous
	// Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// An AWS Key Management Service key to encrypt your output files. If you do
	// not specify a key, the files are written in plain text.
	KMSKey *string `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartRxNormInferenceJobInput) String added in v0.23.0 

func (s StartRxNormInferenceJobInput) String() string

String returns the string representation

func (*StartRxNormInferenceJobInput) Validate added in v0.23.0 

func (s *StartRxNormInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartRxNormInferenceJobOutput added in v0.23.0 

type StartRxNormInferenceJobOutput struct {

	// The identifier of the job.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartRxNormInferenceJobOutput) String added in v0.23.0 

func (s StartRxNormInferenceJobOutput) String() string

String returns the string representation

type StartRxNormInferenceJobRequest added in v0.23.0 

type StartRxNormInferenceJobRequest struct {
	*aws.Request
	Input *StartRxNormInferenceJobInput
	Copy  func(*StartRxNormInferenceJobInput) StartRxNormInferenceJobRequest
}

StartRxNormInferenceJobRequest is the request type for the StartRxNormInferenceJob API operation.

func (StartRxNormInferenceJobRequest) Send added in v0.23.0 

func (r StartRxNormInferenceJobRequest) Send(ctx context.Context) (*StartRxNormInferenceJobResponse, error)

Send marshals and sends the StartRxNormInferenceJob API request.

type StartRxNormInferenceJobResponse added in v0.23.0 

type StartRxNormInferenceJobResponse struct {
	*StartRxNormInferenceJobOutput
	// contains filtered or unexported fields
}

StartRxNormInferenceJobResponse is the response type for the StartRxNormInferenceJob API operation.

func (*StartRxNormInferenceJobResponse) SDKResponseMetdata added in v0.23.0 

func (r *StartRxNormInferenceJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartRxNormInferenceJob request.

type StopEntitiesDetectionV2JobInput added in v0.13.0 

type StopEntitiesDetectionV2JobInput struct {

	// The identifier of the medical entities job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopEntitiesDetectionV2JobInput) String added in v0.13.0 

func (s StopEntitiesDetectionV2JobInput) String() string

String returns the string representation

func (*StopEntitiesDetectionV2JobInput) Validate added in v0.13.0 

func (s *StopEntitiesDetectionV2JobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopEntitiesDetectionV2JobOutput added in v0.13.0 

type StopEntitiesDetectionV2JobOutput struct {

	// The identifier of the medical entities detection job that was stopped.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopEntitiesDetectionV2JobOutput) String added in v0.13.0 

func (s StopEntitiesDetectionV2JobOutput) String() string

String returns the string representation

type StopEntitiesDetectionV2JobRequest added in v0.13.0 

type StopEntitiesDetectionV2JobRequest struct {
	*aws.Request
	Input *StopEntitiesDetectionV2JobInput
	Copy  func(*StopEntitiesDetectionV2JobInput) StopEntitiesDetectionV2JobRequest
}

StopEntitiesDetectionV2JobRequest is the request type for the StopEntitiesDetectionV2Job API operation.

func (StopEntitiesDetectionV2JobRequest) Send added in v0.13.0 

func (r StopEntitiesDetectionV2JobRequest) Send(ctx context.Context) (*StopEntitiesDetectionV2JobResponse, error)

Send marshals and sends the StopEntitiesDetectionV2Job API request.

type StopEntitiesDetectionV2JobResponse added in v0.13.0 

type StopEntitiesDetectionV2JobResponse struct {
	*StopEntitiesDetectionV2JobOutput
	// contains filtered or unexported fields
}

StopEntitiesDetectionV2JobResponse is the response type for the StopEntitiesDetectionV2Job API operation.

func (*StopEntitiesDetectionV2JobResponse) SDKResponseMetdata added in v0.13.0 

func (r *StopEntitiesDetectionV2JobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopEntitiesDetectionV2Job request.

type StopICD10CMInferenceJobInput added in v0.23.0 

type StopICD10CMInferenceJobInput struct {

	// The identifier of the job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopICD10CMInferenceJobInput) String added in v0.23.0 

func (s StopICD10CMInferenceJobInput) String() string

String returns the string representation

func (*StopICD10CMInferenceJobInput) Validate added in v0.23.0 

func (s *StopICD10CMInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopICD10CMInferenceJobOutput added in v0.23.0 

type StopICD10CMInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of job, use this
	// identifier with the DescribeICD10CMInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopICD10CMInferenceJobOutput) String added in v0.23.0 

func (s StopICD10CMInferenceJobOutput) String() string

String returns the string representation

type StopICD10CMInferenceJobRequest added in v0.23.0 

type StopICD10CMInferenceJobRequest struct {
	*aws.Request
	Input *StopICD10CMInferenceJobInput
	Copy  func(*StopICD10CMInferenceJobInput) StopICD10CMInferenceJobRequest
}

StopICD10CMInferenceJobRequest is the request type for the StopICD10CMInferenceJob API operation.

func (StopICD10CMInferenceJobRequest) Send added in v0.23.0 

func (r StopICD10CMInferenceJobRequest) Send(ctx context.Context) (*StopICD10CMInferenceJobResponse, error)

Send marshals and sends the StopICD10CMInferenceJob API request.

type StopICD10CMInferenceJobResponse added in v0.23.0 

type StopICD10CMInferenceJobResponse struct {
	*StopICD10CMInferenceJobOutput
	// contains filtered or unexported fields
}

StopICD10CMInferenceJobResponse is the response type for the StopICD10CMInferenceJob API operation.

func (*StopICD10CMInferenceJobResponse) SDKResponseMetdata added in v0.23.0 

func (r *StopICD10CMInferenceJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopICD10CMInferenceJob request.

type StopPHIDetectionJobInput added in v0.13.0 

type StopPHIDetectionJobInput struct {

	// The identifier of the PHI detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopPHIDetectionJobInput) String added in v0.13.0 

func (s StopPHIDetectionJobInput) String() string

String returns the string representation

func (*StopPHIDetectionJobInput) Validate added in v0.13.0 

func (s *StopPHIDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopPHIDetectionJobOutput added in v0.13.0 

type StopPHIDetectionJobOutput struct {

	// The identifier of the PHI detection job that was stopped.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopPHIDetectionJobOutput) String added in v0.13.0 

func (s StopPHIDetectionJobOutput) String() string

String returns the string representation

type StopPHIDetectionJobRequest added in v0.13.0 

type StopPHIDetectionJobRequest struct {
	*aws.Request
	Input *StopPHIDetectionJobInput
	Copy  func(*StopPHIDetectionJobInput) StopPHIDetectionJobRequest
}

StopPHIDetectionJobRequest is the request type for the StopPHIDetectionJob API operation.

func (StopPHIDetectionJobRequest) Send added in v0.13.0 

func (r StopPHIDetectionJobRequest) Send(ctx context.Context) (*StopPHIDetectionJobResponse, error)

Send marshals and sends the StopPHIDetectionJob API request.

type StopPHIDetectionJobResponse added in v0.13.0 

type StopPHIDetectionJobResponse struct {
	*StopPHIDetectionJobOutput
	// contains filtered or unexported fields
}

StopPHIDetectionJobResponse is the response type for the StopPHIDetectionJob API operation.

func (*StopPHIDetectionJobResponse) SDKResponseMetdata added in v0.13.0 

func (r *StopPHIDetectionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopPHIDetectionJob request.

type StopRxNormInferenceJobInput added in v0.23.0 

type StopRxNormInferenceJobInput struct {

	// The identifier of the job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopRxNormInferenceJobInput) String added in v0.23.0 

func (s StopRxNormInferenceJobInput) String() string

String returns the string representation

func (*StopRxNormInferenceJobInput) Validate added in v0.23.0 

func (s *StopRxNormInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopRxNormInferenceJobOutput added in v0.23.0 

type StopRxNormInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of job, use this
	// identifier with the DescribeRxNormInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopRxNormInferenceJobOutput) String added in v0.23.0 

func (s StopRxNormInferenceJobOutput) String() string

String returns the string representation

type StopRxNormInferenceJobRequest added in v0.23.0 

type StopRxNormInferenceJobRequest struct {
	*aws.Request
	Input *StopRxNormInferenceJobInput
	Copy  func(*StopRxNormInferenceJobInput) StopRxNormInferenceJobRequest
}

StopRxNormInferenceJobRequest is the request type for the StopRxNormInferenceJob API operation.

func (StopRxNormInferenceJobRequest) Send added in v0.23.0 

func (r StopRxNormInferenceJobRequest) Send(ctx context.Context) (*StopRxNormInferenceJobResponse, error)

Send marshals and sends the StopRxNormInferenceJob API request.

type StopRxNormInferenceJobResponse added in v0.23.0 

type StopRxNormInferenceJobResponse struct {
	*StopRxNormInferenceJobOutput
	// contains filtered or unexported fields
}

StopRxNormInferenceJobResponse is the response type for the StopRxNormInferenceJob API operation.

func (*StopRxNormInferenceJobResponse) SDKResponseMetdata added in v0.23.0 

func (r *StopRxNormInferenceJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopRxNormInferenceJob request.

type Trait 

type Trait struct {

	// Provides a name or contextual description about the trait.
	Name AttributeName `type:"string" enum:"true"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of this trait.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Provides contextual information about the extracted entity.

func (Trait) String 

func (s Trait) String() string

String returns the string representation

type UnmappedAttribute 

type UnmappedAttribute struct {

	// The specific attribute that has been extracted but not mapped to an entity.
	Attribute *Attribute `type:"structure"`

	// The type of the attribute, could be one of the following values: "MEDICATION",
	// "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".
	Type EntityType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

An attribute that we extracted, but were unable to relate to an entity.

func (UnmappedAttribute) String 

func (s UnmappedAttribute) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package comprehendmedicaliface provides an interface to enable mocking the AWS Comprehend Medical service client for testing your code.
 Package comprehendmedicaliface provides an interface to enable mocking the AWS Comprehend Medical service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.