types

package
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

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 *int32

	// The category of attribute.
	Category EntityType

	// 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 *int32

	// The numeric identifier for this attribute. This is a monotonically increasing id
	// unique within this response rather than a global unique identifier.
	Id *int32

	// The level of confidence that Amazon Comprehend Medical has that this attribute
	// is correctly related to this entity.
	RelationshipScore *float32

	// 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

	// The level of confidence that Amazon Comprehend Medical has that the segment of
	// text is correctly recognized as an attribute.
	Score *float32

	// The segment of input text extracted as this attribute.
	Text *string

	// Contextual information for this attribute.
	Traits []Trait

	// The type of attribute.
	Type EntitySubType
}

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.

type AttributeName 

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

Enum values for AttributeName

func (AttributeName) Values added in v0.29.0 

func (AttributeName) Values() []AttributeName

Values returns all known values for AttributeName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ComprehendMedicalAsyncJobFilter 

type ComprehendMedicalAsyncJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// 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

	// 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
}

Provides information for filtering a list of detection jobs.

type ComprehendMedicalAsyncJobProperties 

type ComprehendMedicalAsyncJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access
	// to your input data.
	DataAccessRoleArn *string

	// The time that the detection job completed.
	EndTime *time.Time

	// 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

	// The input data configuration that you supplied when you created the detection
	// job.
	InputDataConfig *InputDataConfig

	// The identifier assigned to the detection job.
	JobId *string

	// The name that you assigned to the detection job.
	JobName *string

	// The current status of the detection job. If the status is FAILED, the Message
	// field shows the reason for the failure.
	JobStatus JobStatus

	// The AWS Key Management Service key, if any, used to encrypt the output files.
	KMSKey *string

	// The language code of the input documents.
	LanguageCode LanguageCode

	// The path to the file that describes the results of a batch job.
	ManifestFilePath *string

	// A description of the status of a job.
	Message *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

	// The output data configuration that you supplied when you created the detection
	// job.
	OutputDataConfig *OutputDataConfig

	// The time that the detection job was submitted for processing.
	SubmitTime *time.Time
}

Provides information about a detection job.

type Entity 

type Entity struct {

	// The extracted attributes that relate to this entity.
	Attributes []Attribute

	// 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 *int32

	// The category of the entity.
	Category EntityType

	// 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 *int32

	// The numeric identifier for the entity. This is a monotonically increasing id
	// unique within this response rather than a global unique identifier.
	Id *int32

	// The level of confidence that Amazon Comprehend Medical has in the accuracy of
	// the detection.
	Score *float32

	// The segment of input text extracted as this entity.
	Text *string

	// Contextual information for the entity.
	Traits []Trait

	// Describes the specific type of entity with category of entities.
	Type EntitySubType
}

Provides information about an extracted medical entity.

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) Values added in v0.29.0 

func (EntitySubType) Values() []EntitySubType

Values returns all known values for EntitySubType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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) Values added in v0.29.0 

func (EntityType) Values() []EntityType

Values returns all known values for EntityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ICD10CMAttribute 

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 *int32

	// 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 *int32

	// The numeric identifier for this attribute. This is a monotonically increasing id
	// unique within this response rather than a global unique identifier.
	Id *int32

	// The level of confidence that Amazon Comprehend Medical has that this attribute
	// is correctly related to this entity.
	RelationshipScore *float32

	// The level of confidence that Amazon Comprehend Medical has that the segment of
	// text is correctly recognized as an attribute.
	Score *float32

	// The segment of input text which contains the detected attribute.
	Text *string

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

	// The type of attribute. InferICD10CM detects entities of the type DX_NAME.
	Type ICD10CMAttributeType
}

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.

type ICD10CMAttributeType 

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) Values added in v0.29.0 

func (ICD10CMAttributeType) Values() []ICD10CMAttributeType

Values returns all known values for ICD10CMAttributeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ICD10CMConcept 

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

	// The long description of the ICD-10-CM code in the ontology.
	Description *string

	// The level of confidence that Amazon Comprehend Medical has that the entity is
	// accurately linked to an ICD-10-CM concept.
	Score *float32
}

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

type ICD10CMEntity 

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

	// 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 *int32

	// The category of the entity. InferICD10CM detects entities in the
	// MEDICAL_CONDITION category.
	Category ICD10CMEntityCategory

	// 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 *int32

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

	// The numeric identifier for the entity. This is a monotonically increasing id
	// unique within this response rather than a global unique identifier.
	Id *int32

	// The level of confidence that Amazon Comprehend Medical has in the accuracy of
	// the detection.
	Score *float32

	// The segment of input text that is matched to the detected entity.
	Text *string

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

	// Describes the specific type of entity with category of entities. InferICD10CM
	// detects entities of the type DX_NAME.
	Type ICD10CMEntityType
}

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.

type ICD10CMEntityCategory 

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

Enum values for ICD10CMEntityCategory

func (ICD10CMEntityCategory) Values added in v0.29.0 

func (ICD10CMEntityCategory) Values() []ICD10CMEntityCategory

Values returns all known values for ICD10CMEntityCategory. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ICD10CMEntityType 

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

Enum values for ICD10CMEntityType

func (ICD10CMEntityType) Values added in v0.29.0 

func (ICD10CMEntityType) Values() []ICD10CMEntityType

Values returns all known values for ICD10CMEntityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ICD10CMTrait 

type ICD10CMTrait struct {

	// Provides a name or contextual description about the trait.
	Name ICD10CMTraitName

	// The level of confidence that Amazon Comprehend Medical has that the segment of
	// text is correctly recognized as a trait.
	Score *float32
}

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

type ICD10CMTraitName 

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

Enum values for ICD10CMTraitName

func (ICD10CMTraitName) Values added in v0.29.0 

func (ICD10CMTraitName) Values() []ICD10CMTraitName

Values returns all known values for ICD10CMTraitName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InputDataConfig 

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.
	//
	// This member is required.
	S3Bucket *string

	// The path to the input data files in the S3 bucket.
	S3Key *string
}

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.

type InternalServerException 

type InternalServerException struct {
	Message *string
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type InvalidEncodingException 

type InvalidEncodingException struct {
	Message *string
}

The input text was not in valid UTF-8 character encoding. Check your text then retry your request.

func (*InvalidEncodingException) Error 

func (e *InvalidEncodingException) Error() string

func (*InvalidEncodingException) ErrorCode 

func (e *InvalidEncodingException) ErrorCode() string

func (*InvalidEncodingException) ErrorFault 

func (e *InvalidEncodingException) ErrorFault() smithy.ErrorFault

func (*InvalidEncodingException) ErrorMessage 

func (e *InvalidEncodingException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string
}

The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

func (*InvalidRequestException) Error 

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode 

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault 

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage 

func (e *InvalidRequestException) ErrorMessage() string

type JobStatus 

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) Values added in v0.29.0 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LanguageCode 

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

Enum values for LanguageCode

func (LanguageCode) Values added in v0.29.0 

func (LanguageCode) Values() []LanguageCode

Values returns all known values for LanguageCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OutputDataConfig 

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.
	//
	// This member is required.
	S3Bucket *string

	// 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
}

The output properties for a detection job.

type RelationshipType 

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) Values added in v0.29.0 

func (RelationshipType) Values() []RelationshipType

Values returns all known values for RelationshipType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
}

The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RxNormAttribute 

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 *int32

	// 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 *int32

	// The numeric identifier for this attribute. This is a monotonically increasing id
	// unique within this response rather than a global unique identifier.
	Id *int32

	// The level of confidence that Amazon Comprehend Medical has that the attribute is
	// accurately linked to an entity.
	RelationshipScore *float32

	// The level of confidence that Comprehend Medical has that the segment of text is
	// correctly recognized as an attribute.
	Score *float32

	// The segment of input text which corresponds to the detected attribute.
	Text *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

	// The type of attribute. The types of attributes recognized by InferRxNorm are
	// BRAND_NAME and GENERIC_NAME.
	Type RxNormAttributeType
}

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

type RxNormAttributeType 

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) Values added in v0.29.0 

func (RxNormAttributeType) Values() []RxNormAttributeType

Values returns all known values for RxNormAttributeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RxNormConcept 

type RxNormConcept struct {

	// RxNorm concept ID, also known as the RxCUI.
	Code *string

	// The description of the RxNorm concept.
	Description *string

	// The level of confidence that Amazon Comprehend Medical has that the entity is
	// accurately linked to the reported RxNorm concept.
	Score *float32
}

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

type RxNormEntity 

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

	// 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 *int32

	// The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
	Category RxNormEntityCategory

	// 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 *int32

	// The numeric identifier for the entity. This is a monotonically increasing id
	// unique within this response rather than a global unique identifier.
	Id *int32

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

	// The level of confidence that Amazon Comprehend Medical has in the accuracy of
	// the detected entity.
	Score *float32

	// The segment of input text extracted from which the entity was detected.
	Text *string

	// Contextual information for the entity.
	Traits []RxNormTrait

	// Describes the specific type of entity. For InferRxNorm, the recognized entity
	// type is MEDICATION.
	Type RxNormEntityType
}

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.

type RxNormEntityCategory 

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

Enum values for RxNormEntityCategory

func (RxNormEntityCategory) Values added in v0.29.0 

func (RxNormEntityCategory) Values() []RxNormEntityCategory

Values returns all known values for RxNormEntityCategory. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RxNormEntityType 

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

Enum values for RxNormEntityType

func (RxNormEntityType) Values added in v0.29.0 

func (RxNormEntityType) Values() []RxNormEntityType

Values returns all known values for RxNormEntityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RxNormTrait 

type RxNormTrait struct {

	// Provides a name or contextual description about the trait.
	Name RxNormTraitName

	// The level of confidence that Amazon Comprehend Medical has in the accuracy of
	// the detected trait.
	Score *float32
}

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

type RxNormTraitName 

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

Enum values for RxNormTraitName

func (RxNormTraitName) Values added in v0.29.0 

func (RxNormTraitName) Values() []RxNormTraitName

Values returns all known values for RxNormTraitName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string
}

The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type TextSizeLimitExceededException 

type TextSizeLimitExceededException struct {
	Message *string
}

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.

func (*TextSizeLimitExceededException) Error 

func (e *TextSizeLimitExceededException) Error() string

func (*TextSizeLimitExceededException) ErrorCode 

func (e *TextSizeLimitExceededException) ErrorCode() string

func (*TextSizeLimitExceededException) ErrorFault 

func (e *TextSizeLimitExceededException) ErrorFault() smithy.ErrorFault

func (*TextSizeLimitExceededException) ErrorMessage 

func (e *TextSizeLimitExceededException) ErrorMessage() string

type TooManyRequestsException 

type TooManyRequestsException struct {
	Message *string
}

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.

func (*TooManyRequestsException) Error 

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode 

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault 

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage 

func (e *TooManyRequestsException) ErrorMessage() string

type Trait 

type Trait struct {

	// Provides a name or contextual description about the trait.
	Name AttributeName

	// The level of confidence that Amazon Comprehend Medical has in the accuracy of
	// this trait.
	Score *float32
}

Provides contextual information about the extracted entity.

type UnmappedAttribute 

type UnmappedAttribute struct {

	// The specific attribute that has been extracted but not mapped to an entity.
	Attribute *Attribute

	// 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
}

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

type ValidationException 

type ValidationException struct {
	Message *string
}

The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

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.