View on GitHub
ComprehendMedical Structure Reference
ComprehendMedical
public struct ComprehendMedicalClient object for interacting with AWS ComprehendMedical service.
Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the ComprehendMedical client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
Declaration
Swift
public func describeEntitiesDetectionV2Job(_ input: DescribeEntitiesDetectionV2JobRequest) -> EventLoopFuture<DescribeEntitiesDetectionV2JobResponse> -
Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
Declaration
Swift
public func describeICD10CMInferenceJob(_ input: DescribeICD10CMInferenceJobRequest) -> EventLoopFuture<DescribeICD10CMInferenceJobResponse> -
Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
Declaration
Swift
public func describePHIDetectionJob(_ input: DescribePHIDetectionJobRequest) -> EventLoopFuture<DescribePHIDetectionJobResponse> -
Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
Declaration
Swift
public func describeRxNormInferenceJob(_ input: DescribeRxNormInferenceJobRequest) -> EventLoopFuture<DescribeRxNormInferenceJobResponse> -
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 .
Declaration
Swift
@available(*, deprecated, message: "This operation is deprecated, use DetectEntitiesV2 instead.") public func detectEntities(_ input: DetectEntitiesRequest) -> EventLoopFuture<DetectEntitiesResponse> -
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.
Declaration
Swift
public func detectEntitiesV2(_ input: DetectEntitiesV2Request) -> EventLoopFuture<DetectEntitiesV2Response> -
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.
Declaration
Swift
public func detectPHI(_ input: DetectPHIRequest) -> EventLoopFuture<DetectPHIResponse> -
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.
Declaration
Swift
public func inferICD10CM(_ input: InferICD10CMRequest) -> EventLoopFuture<InferICD10CMResponse> -
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.
Declaration
Swift
public func inferRxNorm(_ input: InferRxNormRequest) -> EventLoopFuture<InferRxNormResponse> -
Gets a list of medical entity detection jobs that you have submitted.
Declaration
Swift
public func listEntitiesDetectionV2Jobs(_ input: ListEntitiesDetectionV2JobsRequest) -> EventLoopFuture<ListEntitiesDetectionV2JobsResponse> -
Gets a list of InferICD10CM jobs that you have submitted.
Declaration
Swift
public func listICD10CMInferenceJobs(_ input: ListICD10CMInferenceJobsRequest) -> EventLoopFuture<ListICD10CMInferenceJobsResponse> -
Gets a list of protected health information (PHI) detection jobs that you have submitted.
Declaration
Swift
public func listPHIDetectionJobs(_ input: ListPHIDetectionJobsRequest) -> EventLoopFuture<ListPHIDetectionJobsResponse> -
Gets a list of InferRxNorm jobs that you have submitted.
Declaration
Swift
public func listRxNormInferenceJobs(_ input: ListRxNormInferenceJobsRequest) -> EventLoopFuture<ListRxNormInferenceJobsResponse> -
Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.
Declaration
Swift
public func startEntitiesDetectionV2Job(_ input: StartEntitiesDetectionV2JobRequest) -> EventLoopFuture<StartEntitiesDetectionV2JobResponse> -
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.
Declaration
Swift
public func startICD10CMInferenceJob(_ input: StartICD10CMInferenceJobRequest) -> EventLoopFuture<StartICD10CMInferenceJobResponse> -
Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.
Declaration
Swift
public func startPHIDetectionJob(_ input: StartPHIDetectionJobRequest) -> EventLoopFuture<StartPHIDetectionJobResponse> -
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.
Declaration
Swift
public func startRxNormInferenceJob(_ input: StartRxNormInferenceJobRequest) -> EventLoopFuture<StartRxNormInferenceJobResponse> -
Stops a medical entities detection job in progress.
Declaration
Swift
public func stopEntitiesDetectionV2Job(_ input: StopEntitiesDetectionV2JobRequest) -> EventLoopFuture<StopEntitiesDetectionV2JobResponse> -
Stops an InferICD10CM inference job in progress.
Declaration
Swift
public func stopICD10CMInferenceJob(_ input: StopICD10CMInferenceJobRequest) -> EventLoopFuture<StopICD10CMInferenceJobResponse> -
Stops a protected health information (PHI) detection job in progress.
Declaration
Swift
public func stopPHIDetectionJob(_ input: StopPHIDetectionJobRequest) -> EventLoopFuture<StopPHIDetectionJobResponse> -
Stops an InferRxNorm inference job in progress.
Declaration
Swift
public func stopRxNormInferenceJob(_ input: StopRxNormInferenceJobRequest) -> EventLoopFuture<StopRxNormInferenceJobResponse>
-
Undocumented
See moreDeclaration
Swift
public enum AttributeName : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum EntitySubType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum EntityType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ICD10CMAttributeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ICD10CMEntityCategory : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ICD10CMEntityType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ICD10CMTraitName : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum JobStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum LanguageCode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RelationshipType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RxNormAttributeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RxNormEntityCategory : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RxNormEntityType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RxNormTraitName : String, CustomStringConvertible, Codable