aws-sdk-comprehendmedical 1.11.0 → 1.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: bd9ba05ca4156b7142f3ff7fe9c6356f2695069a
4
- data.tar.gz: 260257468d5de9e2d768751b05ff73fa9d7ee378
3
+ metadata.gz: 5ad32a736f99f23f9b735935e01bdaf6077f22e7
4
+ data.tar.gz: 9aa31e920c9a4b3006897085cf6fefbda27e2a27
5
5
  SHA512:
6
- metadata.gz: 7805c7f3ad09f22a7a151744a4fcaef569b0252c301bd59cfee032a606d6a75cd44e9004120e3b17c11c330370b8e880d906c2050cef7a0a8592395f35b1100a
7
- data.tar.gz: b48901739048585ccca00da4cf311f9b4ea2c5765c4086114ef1f26e6c2cd6bbd64750675cc701dea41ab95e9fae154957c3705743e7c317c274dfe89f4ae86d
6
+ metadata.gz: 9e93dcc536cdc6e56a4dfbbf943693e8186e61544964aec5192a4a859a57ae0d0cc98f048d72a78f7ad0f5a06cdf075d6bbb0791d0167743cef9a3c6fbe7d4ed
7
+ data.tar.gz: c2e1fd7ab8f1670a8aa5a7e520f88faa00c35da7ea704d1667d16cc14c8b21bedefbb68d555f1261e81d3b65d635e07fa4a6d0de4ad22b7366c75f770f529175
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-comprehendmedical/customizations'
42
42
  # @service
43
43
  module Aws::ComprehendMedical
44
44
 
45
- GEM_VERSION = '1.11.0'
45
+ GEM_VERSION = '1.12.0'
46
46
 
47
47
  end
@@ -441,8 +441,7 @@ module Aws::ComprehendMedical
441
441
  # operation in all new applications.
442
442
  #
443
443
  # The `DetectEntitiesV2` operation returns the `Acuity` and `Direction`
444
- # entities as attributes instead of types. It does not return the
445
- # `Quality` or `Quantity` entities.
444
+ # entities as attributes instead of types.
446
445
  #
447
446
  # @option params [required, String] :text
448
447
  # A UTF-8 string containing the clinical content being examined for
@@ -567,6 +566,127 @@ module Aws::ComprehendMedical
567
566
  req.send_request(options)
568
567
  end
569
568
 
569
+ # InferICD10CM detects medical conditions as entities listed in a
570
+ # patient record and links those entities to normalized concept
571
+ # identifiers in the ICD-10-CM knowledge base from the Centers for
572
+ # Disease Control.
573
+ #
574
+ # @option params [required, String] :text
575
+ # The input text used for analysis. The input for InferICD10CM is a
576
+ # string from 1 to 10000 characters.
577
+ #
578
+ # @return [Types::InferICD10CMResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
579
+ #
580
+ # * {Types::InferICD10CMResponse#entities #entities} => Array<Types::ICD10CMEntity>
581
+ # * {Types::InferICD10CMResponse#pagination_token #pagination_token} => String
582
+ # * {Types::InferICD10CMResponse#model_version #model_version} => String
583
+ #
584
+ # @example Request syntax with placeholder values
585
+ #
586
+ # resp = client.infer_icd10cm({
587
+ # text: "OntologyLinkingBoundedLengthString", # required
588
+ # })
589
+ #
590
+ # @example Response structure
591
+ #
592
+ # resp.entities #=> Array
593
+ # resp.entities[0].id #=> Integer
594
+ # resp.entities[0].text #=> String
595
+ # resp.entities[0].category #=> String, one of "MEDICAL_CONDITION"
596
+ # resp.entities[0].type #=> String, one of "DX_NAME"
597
+ # resp.entities[0].score #=> Float
598
+ # resp.entities[0].begin_offset #=> Integer
599
+ # resp.entities[0].end_offset #=> Integer
600
+ # resp.entities[0].attributes #=> Array
601
+ # resp.entities[0].attributes[0].type #=> String, one of "ACUITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "QUALITY", "QUANTITY"
602
+ # resp.entities[0].attributes[0].score #=> Float
603
+ # resp.entities[0].attributes[0].relationship_score #=> Float
604
+ # resp.entities[0].attributes[0].id #=> Integer
605
+ # resp.entities[0].attributes[0].begin_offset #=> Integer
606
+ # resp.entities[0].attributes[0].end_offset #=> Integer
607
+ # resp.entities[0].attributes[0].text #=> String
608
+ # resp.entities[0].attributes[0].traits #=> Array
609
+ # resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
610
+ # resp.entities[0].attributes[0].traits[0].score #=> Float
611
+ # resp.entities[0].traits #=> Array
612
+ # resp.entities[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
613
+ # resp.entities[0].traits[0].score #=> Float
614
+ # resp.entities[0].icd10cm_concepts #=> Array
615
+ # resp.entities[0].icd10cm_concepts[0].description #=> String
616
+ # resp.entities[0].icd10cm_concepts[0].code #=> String
617
+ # resp.entities[0].icd10cm_concepts[0].score #=> Float
618
+ # resp.pagination_token #=> String
619
+ # resp.model_version #=> String
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CM AWS API Documentation
622
+ #
623
+ # @overload infer_icd10cm(params = {})
624
+ # @param [Hash] params ({})
625
+ def infer_icd10cm(params = {}, options = {})
626
+ req = build_request(:infer_icd10cm, params)
627
+ req.send_request(options)
628
+ end
629
+
630
+ # InferRxNorm detects medications as entities listed in a patient record
631
+ # and links to the normalized concept identifiers in the RxNorm database
632
+ # from the National Library of Medicine.
633
+ #
634
+ # @option params [required, String] :text
635
+ # The input text used for analysis. The input for InferRxNorm is a
636
+ # string from 1 to 10000 characters.
637
+ #
638
+ # @return [Types::InferRxNormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
639
+ #
640
+ # * {Types::InferRxNormResponse#entities #entities} => Array<Types::RxNormEntity>
641
+ # * {Types::InferRxNormResponse#pagination_token #pagination_token} => String
642
+ # * {Types::InferRxNormResponse#model_version #model_version} => String
643
+ #
644
+ # @example Request syntax with placeholder values
645
+ #
646
+ # resp = client.infer_rx_norm({
647
+ # text: "OntologyLinkingBoundedLengthString", # required
648
+ # })
649
+ #
650
+ # @example Response structure
651
+ #
652
+ # resp.entities #=> Array
653
+ # resp.entities[0].id #=> Integer
654
+ # resp.entities[0].text #=> String
655
+ # resp.entities[0].category #=> String, one of "MEDICATION"
656
+ # resp.entities[0].type #=> String, one of "BRAND_NAME", "GENERIC_NAME"
657
+ # resp.entities[0].score #=> Float
658
+ # resp.entities[0].begin_offset #=> Integer
659
+ # resp.entities[0].end_offset #=> Integer
660
+ # resp.entities[0].attributes #=> Array
661
+ # resp.entities[0].attributes[0].type #=> String, one of "DOSAGE", "DURATION", "FORM", "FREQUENCY", "RATE", "ROUTE_OR_MODE", "STRENGTH"
662
+ # resp.entities[0].attributes[0].score #=> Float
663
+ # resp.entities[0].attributes[0].relationship_score #=> Float
664
+ # resp.entities[0].attributes[0].id #=> Integer
665
+ # resp.entities[0].attributes[0].begin_offset #=> Integer
666
+ # resp.entities[0].attributes[0].end_offset #=> Integer
667
+ # resp.entities[0].attributes[0].text #=> String
668
+ # resp.entities[0].attributes[0].traits #=> Array
669
+ # resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION"
670
+ # resp.entities[0].attributes[0].traits[0].score #=> Float
671
+ # resp.entities[0].traits #=> Array
672
+ # resp.entities[0].traits[0].name #=> String, one of "NEGATION"
673
+ # resp.entities[0].traits[0].score #=> Float
674
+ # resp.entities[0].rx_norm_concepts #=> Array
675
+ # resp.entities[0].rx_norm_concepts[0].description #=> String
676
+ # resp.entities[0].rx_norm_concepts[0].code #=> String
677
+ # resp.entities[0].rx_norm_concepts[0].score #=> Float
678
+ # resp.pagination_token #=> String
679
+ # resp.model_version #=> String
680
+ #
681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNorm AWS API Documentation
682
+ #
683
+ # @overload infer_rx_norm(params = {})
684
+ # @param [Hash] params ({})
685
+ def infer_rx_norm(params = {}, options = {})
686
+ req = build_request(:infer_rx_norm, params)
687
+ req.send_request(options)
688
+ end
689
+
570
690
  # Gets a list of medical entity detection jobs that you have submitted.
571
691
  #
572
692
  # @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
@@ -907,7 +1027,7 @@ module Aws::ComprehendMedical
907
1027
  params: params,
908
1028
  config: config)
909
1029
  context[:gem_name] = 'aws-sdk-comprehendmedical'
910
- context[:gem_version] = '1.11.0'
1030
+ context[:gem_version] = '1.12.0'
911
1031
  Seahorse::Client::Request.new(handlers, context)
912
1032
  end
913
1033
 
@@ -35,7 +35,23 @@ module Aws::ComprehendMedical
35
35
  EntitySubType = Shapes::StringShape.new(name: 'EntitySubType')
36
36
  EntityType = Shapes::StringShape.new(name: 'EntityType')
37
37
  Float = Shapes::FloatShape.new(name: 'Float')
38
+ ICD10CMAttribute = Shapes::StructureShape.new(name: 'ICD10CMAttribute')
39
+ ICD10CMAttributeList = Shapes::ListShape.new(name: 'ICD10CMAttributeList')
40
+ ICD10CMAttributeType = Shapes::StringShape.new(name: 'ICD10CMAttributeType')
41
+ ICD10CMConcept = Shapes::StructureShape.new(name: 'ICD10CMConcept')
42
+ ICD10CMConceptList = Shapes::ListShape.new(name: 'ICD10CMConceptList')
43
+ ICD10CMEntity = Shapes::StructureShape.new(name: 'ICD10CMEntity')
44
+ ICD10CMEntityCategory = Shapes::StringShape.new(name: 'ICD10CMEntityCategory')
45
+ ICD10CMEntityList = Shapes::ListShape.new(name: 'ICD10CMEntityList')
46
+ ICD10CMEntityType = Shapes::StringShape.new(name: 'ICD10CMEntityType')
47
+ ICD10CMTrait = Shapes::StructureShape.new(name: 'ICD10CMTrait')
48
+ ICD10CMTraitList = Shapes::ListShape.new(name: 'ICD10CMTraitList')
49
+ ICD10CMTraitName = Shapes::StringShape.new(name: 'ICD10CMTraitName')
38
50
  IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
51
+ InferICD10CMRequest = Shapes::StructureShape.new(name: 'InferICD10CMRequest')
52
+ InferICD10CMResponse = Shapes::StructureShape.new(name: 'InferICD10CMResponse')
53
+ InferRxNormRequest = Shapes::StructureShape.new(name: 'InferRxNormRequest')
54
+ InferRxNormResponse = Shapes::StructureShape.new(name: 'InferRxNormResponse')
39
55
  InputDataConfig = Shapes::StructureShape.new(name: 'InputDataConfig')
40
56
  Integer = Shapes::IntegerShape.new(name: 'Integer')
41
57
  InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
@@ -53,8 +69,21 @@ module Aws::ComprehendMedical
53
69
  ManifestFilePath = Shapes::StringShape.new(name: 'ManifestFilePath')
54
70
  MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
55
71
  ModelVersion = Shapes::StringShape.new(name: 'ModelVersion')
72
+ OntologyLinkingBoundedLengthString = Shapes::StringShape.new(name: 'OntologyLinkingBoundedLengthString')
56
73
  OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
57
74
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
75
+ RxNormAttribute = Shapes::StructureShape.new(name: 'RxNormAttribute')
76
+ RxNormAttributeList = Shapes::ListShape.new(name: 'RxNormAttributeList')
77
+ RxNormAttributeType = Shapes::StringShape.new(name: 'RxNormAttributeType')
78
+ RxNormConcept = Shapes::StructureShape.new(name: 'RxNormConcept')
79
+ RxNormConceptList = Shapes::ListShape.new(name: 'RxNormConceptList')
80
+ RxNormEntity = Shapes::StructureShape.new(name: 'RxNormEntity')
81
+ RxNormEntityCategory = Shapes::StringShape.new(name: 'RxNormEntityCategory')
82
+ RxNormEntityList = Shapes::ListShape.new(name: 'RxNormEntityList')
83
+ RxNormEntityType = Shapes::StringShape.new(name: 'RxNormEntityType')
84
+ RxNormTrait = Shapes::StructureShape.new(name: 'RxNormTrait')
85
+ RxNormTraitList = Shapes::ListShape.new(name: 'RxNormTraitList')
86
+ RxNormTraitName = Shapes::StringShape.new(name: 'RxNormTraitName')
58
87
  S3Bucket = Shapes::StringShape.new(name: 'S3Bucket')
59
88
  S3Key = Shapes::StringShape.new(name: 'S3Key')
60
89
  ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
@@ -163,6 +192,61 @@ module Aws::ComprehendMedical
163
192
 
164
193
  EntityList.member = Shapes::ShapeRef.new(shape: Entity)
165
194
 
195
+ ICD10CMAttribute.add_member(:type, Shapes::ShapeRef.new(shape: ICD10CMAttributeType, location_name: "Type"))
196
+ ICD10CMAttribute.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
197
+ ICD10CMAttribute.add_member(:relationship_score, Shapes::ShapeRef.new(shape: Float, location_name: "RelationshipScore"))
198
+ ICD10CMAttribute.add_member(:id, Shapes::ShapeRef.new(shape: Integer, location_name: "Id"))
199
+ ICD10CMAttribute.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
200
+ ICD10CMAttribute.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
201
+ ICD10CMAttribute.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
202
+ ICD10CMAttribute.add_member(:traits, Shapes::ShapeRef.new(shape: ICD10CMTraitList, location_name: "Traits"))
203
+ ICD10CMAttribute.struct_class = Types::ICD10CMAttribute
204
+
205
+ ICD10CMAttributeList.member = Shapes::ShapeRef.new(shape: ICD10CMAttribute)
206
+
207
+ ICD10CMConcept.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "Description"))
208
+ ICD10CMConcept.add_member(:code, Shapes::ShapeRef.new(shape: String, location_name: "Code"))
209
+ ICD10CMConcept.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
210
+ ICD10CMConcept.struct_class = Types::ICD10CMConcept
211
+
212
+ ICD10CMConceptList.member = Shapes::ShapeRef.new(shape: ICD10CMConcept)
213
+
214
+ ICD10CMEntity.add_member(:id, Shapes::ShapeRef.new(shape: Integer, location_name: "Id"))
215
+ ICD10CMEntity.add_member(:text, Shapes::ShapeRef.new(shape: OntologyLinkingBoundedLengthString, location_name: "Text"))
216
+ ICD10CMEntity.add_member(:category, Shapes::ShapeRef.new(shape: ICD10CMEntityCategory, location_name: "Category"))
217
+ ICD10CMEntity.add_member(:type, Shapes::ShapeRef.new(shape: ICD10CMEntityType, location_name: "Type"))
218
+ ICD10CMEntity.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
219
+ ICD10CMEntity.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
220
+ ICD10CMEntity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
221
+ ICD10CMEntity.add_member(:attributes, Shapes::ShapeRef.new(shape: ICD10CMAttributeList, location_name: "Attributes"))
222
+ ICD10CMEntity.add_member(:traits, Shapes::ShapeRef.new(shape: ICD10CMTraitList, location_name: "Traits"))
223
+ ICD10CMEntity.add_member(:icd10cm_concepts, Shapes::ShapeRef.new(shape: ICD10CMConceptList, location_name: "ICD10CMConcepts"))
224
+ ICD10CMEntity.struct_class = Types::ICD10CMEntity
225
+
226
+ ICD10CMEntityList.member = Shapes::ShapeRef.new(shape: ICD10CMEntity)
227
+
228
+ ICD10CMTrait.add_member(:name, Shapes::ShapeRef.new(shape: ICD10CMTraitName, location_name: "Name"))
229
+ ICD10CMTrait.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
230
+ ICD10CMTrait.struct_class = Types::ICD10CMTrait
231
+
232
+ ICD10CMTraitList.member = Shapes::ShapeRef.new(shape: ICD10CMTrait)
233
+
234
+ InferICD10CMRequest.add_member(:text, Shapes::ShapeRef.new(shape: OntologyLinkingBoundedLengthString, required: true, location_name: "Text"))
235
+ InferICD10CMRequest.struct_class = Types::InferICD10CMRequest
236
+
237
+ InferICD10CMResponse.add_member(:entities, Shapes::ShapeRef.new(shape: ICD10CMEntityList, required: true, location_name: "Entities"))
238
+ InferICD10CMResponse.add_member(:pagination_token, Shapes::ShapeRef.new(shape: String, location_name: "PaginationToken"))
239
+ InferICD10CMResponse.add_member(:model_version, Shapes::ShapeRef.new(shape: String, location_name: "ModelVersion"))
240
+ InferICD10CMResponse.struct_class = Types::InferICD10CMResponse
241
+
242
+ InferRxNormRequest.add_member(:text, Shapes::ShapeRef.new(shape: OntologyLinkingBoundedLengthString, required: true, location_name: "Text"))
243
+ InferRxNormRequest.struct_class = Types::InferRxNormRequest
244
+
245
+ InferRxNormResponse.add_member(:entities, Shapes::ShapeRef.new(shape: RxNormEntityList, required: true, location_name: "Entities"))
246
+ InferRxNormResponse.add_member(:pagination_token, Shapes::ShapeRef.new(shape: String, location_name: "PaginationToken"))
247
+ InferRxNormResponse.add_member(:model_version, Shapes::ShapeRef.new(shape: String, location_name: "ModelVersion"))
248
+ InferRxNormResponse.struct_class = Types::InferRxNormResponse
249
+
166
250
  InputDataConfig.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: S3Bucket, required: true, location_name: "S3Bucket"))
167
251
  InputDataConfig.add_member(:s3_key, Shapes::ShapeRef.new(shape: S3Key, location_name: "S3Key"))
168
252
  InputDataConfig.struct_class = Types::InputDataConfig
@@ -201,6 +285,45 @@ module Aws::ComprehendMedical
201
285
  ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
202
286
  ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
203
287
 
288
+ RxNormAttribute.add_member(:type, Shapes::ShapeRef.new(shape: RxNormAttributeType, location_name: "Type"))
289
+ RxNormAttribute.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
290
+ RxNormAttribute.add_member(:relationship_score, Shapes::ShapeRef.new(shape: Float, location_name: "RelationshipScore"))
291
+ RxNormAttribute.add_member(:id, Shapes::ShapeRef.new(shape: Integer, location_name: "Id"))
292
+ RxNormAttribute.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
293
+ RxNormAttribute.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
294
+ RxNormAttribute.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
295
+ RxNormAttribute.add_member(:traits, Shapes::ShapeRef.new(shape: RxNormTraitList, location_name: "Traits"))
296
+ RxNormAttribute.struct_class = Types::RxNormAttribute
297
+
298
+ RxNormAttributeList.member = Shapes::ShapeRef.new(shape: RxNormAttribute)
299
+
300
+ RxNormConcept.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "Description"))
301
+ RxNormConcept.add_member(:code, Shapes::ShapeRef.new(shape: String, location_name: "Code"))
302
+ RxNormConcept.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
303
+ RxNormConcept.struct_class = Types::RxNormConcept
304
+
305
+ RxNormConceptList.member = Shapes::ShapeRef.new(shape: RxNormConcept)
306
+
307
+ RxNormEntity.add_member(:id, Shapes::ShapeRef.new(shape: Integer, location_name: "Id"))
308
+ RxNormEntity.add_member(:text, Shapes::ShapeRef.new(shape: OntologyLinkingBoundedLengthString, location_name: "Text"))
309
+ RxNormEntity.add_member(:category, Shapes::ShapeRef.new(shape: RxNormEntityCategory, location_name: "Category"))
310
+ RxNormEntity.add_member(:type, Shapes::ShapeRef.new(shape: RxNormEntityType, location_name: "Type"))
311
+ RxNormEntity.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
312
+ RxNormEntity.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
313
+ RxNormEntity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
314
+ RxNormEntity.add_member(:attributes, Shapes::ShapeRef.new(shape: RxNormAttributeList, location_name: "Attributes"))
315
+ RxNormEntity.add_member(:traits, Shapes::ShapeRef.new(shape: RxNormTraitList, location_name: "Traits"))
316
+ RxNormEntity.add_member(:rx_norm_concepts, Shapes::ShapeRef.new(shape: RxNormConceptList, location_name: "RxNormConcepts"))
317
+ RxNormEntity.struct_class = Types::RxNormEntity
318
+
319
+ RxNormEntityList.member = Shapes::ShapeRef.new(shape: RxNormEntity)
320
+
321
+ RxNormTrait.add_member(:name, Shapes::ShapeRef.new(shape: RxNormTraitName, location_name: "Name"))
322
+ RxNormTrait.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
323
+ RxNormTrait.struct_class = Types::RxNormTrait
324
+
325
+ RxNormTraitList.member = Shapes::ShapeRef.new(shape: RxNormTrait)
326
+
204
327
  ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
205
328
  ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
206
329
 
@@ -348,6 +471,34 @@ module Aws::ComprehendMedical
348
471
  o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
349
472
  end)
350
473
 
474
+ api.add_operation(:infer_icd10cm, Seahorse::Model::Operation.new.tap do |o|
475
+ o.name = "InferICD10CM"
476
+ o.http_method = "POST"
477
+ o.http_request_uri = "/"
478
+ o.input = Shapes::ShapeRef.new(shape: InferICD10CMRequest)
479
+ o.output = Shapes::ShapeRef.new(shape: InferICD10CMResponse)
480
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
481
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
482
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
483
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
484
+ o.errors << Shapes::ShapeRef.new(shape: InvalidEncodingException)
485
+ o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
486
+ end)
487
+
488
+ api.add_operation(:infer_rx_norm, Seahorse::Model::Operation.new.tap do |o|
489
+ o.name = "InferRxNorm"
490
+ o.http_method = "POST"
491
+ o.http_request_uri = "/"
492
+ o.input = Shapes::ShapeRef.new(shape: InferRxNormRequest)
493
+ o.output = Shapes::ShapeRef.new(shape: InferRxNormResponse)
494
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
495
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
496
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
497
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
498
+ o.errors << Shapes::ShapeRef.new(shape: InvalidEncodingException)
499
+ o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
500
+ end)
501
+
351
502
  api.add_operation(:list_entities_detection_v2_jobs, Seahorse::Model::Operation.new.tap do |o|
352
503
  o.name = "ListEntitiesDetectionV2Jobs"
353
504
  o.http_method = "POST"
@@ -462,7 +462,7 @@ module Aws::ComprehendMedical
462
462
  # @return [String]
463
463
  #
464
464
  # @!attribute [rw] traits
465
- # Contextual information for the entity
465
+ # Contextual information for the entity.
466
466
  # @return [Array<Types::Trait>]
467
467
  #
468
468
  # @!attribute [rw] attributes
@@ -484,6 +484,281 @@ module Aws::ComprehendMedical
484
484
  include Aws::Structure
485
485
  end
486
486
 
487
+ # The detected attributes that relate to an entity. This includes an
488
+ # extracted segment of the text that is an attribute of an entity, or
489
+ # otherwise related to an entity. InferICD10CM detects the following
490
+ # attributes: `Direction`, `System, Organ or Site`, and `Acuity`.
491
+ #
492
+ # @!attribute [rw] type
493
+ # The type of attribute. InferICD10CM detects entities of the type
494
+ # `DX_NAME`.
495
+ # @return [String]
496
+ #
497
+ # @!attribute [rw] score
498
+ # The level of confidence that Amazon Comprehend Medical has that the
499
+ # segment of text is correctly recognized as an attribute.
500
+ # @return [Float]
501
+ #
502
+ # @!attribute [rw] relationship_score
503
+ # The level of confidence that Amazon Comprehend Medical has that this
504
+ # attribute is correctly related to this entity.
505
+ # @return [Float]
506
+ #
507
+ # @!attribute [rw] id
508
+ # The numeric identifier for this attribute. This is a monotonically
509
+ # increasing id unique within this response rather than a global
510
+ # unique identifier.
511
+ # @return [Integer]
512
+ #
513
+ # @!attribute [rw] begin_offset
514
+ # The 0-based character offset in the input text that shows where the
515
+ # attribute begins. The offset returns the UTF-8 code point in the
516
+ # string.
517
+ # @return [Integer]
518
+ #
519
+ # @!attribute [rw] end_offset
520
+ # The 0-based character offset in the input text that shows where the
521
+ # attribute ends. The offset returns the UTF-8 code point in the
522
+ # string.
523
+ # @return [Integer]
524
+ #
525
+ # @!attribute [rw] text
526
+ # The segment of input text which contains the detected attribute.
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] traits
530
+ # The contextual information for the attribute. The traits recognized
531
+ # by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION`.
532
+ # @return [Array<Types::ICD10CMTrait>]
533
+ #
534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMAttribute AWS API Documentation
535
+ #
536
+ class ICD10CMAttribute < Struct.new(
537
+ :type,
538
+ :score,
539
+ :relationship_score,
540
+ :id,
541
+ :begin_offset,
542
+ :end_offset,
543
+ :text,
544
+ :traits)
545
+ include Aws::Structure
546
+ end
547
+
548
+ # The ICD-10-CM concepts that the entity could refer to, along with a
549
+ # score indicating the likelihood of the match.
550
+ #
551
+ # @!attribute [rw] description
552
+ # The long description of the ICD-10-CM code in the ontology.
553
+ # @return [String]
554
+ #
555
+ # @!attribute [rw] code
556
+ # The ICD-10-CM code that identifies the concept found in the
557
+ # knowledge base from the Centers for Disease Control.
558
+ # @return [String]
559
+ #
560
+ # @!attribute [rw] score
561
+ # The level of confidence that Amazon Comprehend Medical has that the
562
+ # entity is accurately linked to an ICD-10-CM concept.
563
+ # @return [Float]
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMConcept AWS API Documentation
566
+ #
567
+ class ICD10CMConcept < Struct.new(
568
+ :description,
569
+ :code,
570
+ :score)
571
+ include Aws::Structure
572
+ end
573
+
574
+ # The collection of medical entities extracted from the input text and
575
+ # their associated information. For each entity, the response provides
576
+ # the entity text, the entity category, where the entity text begins and
577
+ # ends, and the level of confidence that Amazon Comprehend Medical has
578
+ # in the detection and analysis. Attributes and traits of the entity are
579
+ # also returned.
580
+ #
581
+ # @!attribute [rw] id
582
+ # The numeric identifier for the entity. This is a monotonically
583
+ # increasing id unique within this response rather than a global
584
+ # unique identifier.
585
+ # @return [Integer]
586
+ #
587
+ # @!attribute [rw] text
588
+ # The segment of input text that is matched to the detected entity.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] category
592
+ # The category of the entity. InferICD10CM detects entities in the
593
+ # `MEDICAL_CONDITION` category.
594
+ # @return [String]
595
+ #
596
+ # @!attribute [rw] type
597
+ # Describes the specific type of entity with category of entities.
598
+ # InferICD10CM detects entities of the type `DX_NAME`.
599
+ # @return [String]
600
+ #
601
+ # @!attribute [rw] score
602
+ # The level of confidence that Amazon Comprehend Medical has in the
603
+ # accuracy of the detection.
604
+ # @return [Float]
605
+ #
606
+ # @!attribute [rw] begin_offset
607
+ # The 0-based character offset in the input text that shows where the
608
+ # entity begins. The offset returns the UTF-8 code point in the
609
+ # string.
610
+ # @return [Integer]
611
+ #
612
+ # @!attribute [rw] end_offset
613
+ # The 0-based character offset in the input text that shows where the
614
+ # entity ends. The offset returns the UTF-8 code point in the string.
615
+ # @return [Integer]
616
+ #
617
+ # @!attribute [rw] attributes
618
+ # The detected attributes that relate to the entity. An extracted
619
+ # segment of the text that is an attribute of an entity, or otherwise
620
+ # related to an entity, such as the nature of a medical condition.
621
+ # @return [Array<Types::ICD10CMAttribute>]
622
+ #
623
+ # @!attribute [rw] traits
624
+ # Provides Contextual information for the entity. The traits
625
+ # recognized by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and
626
+ # `NEGATION.`
627
+ # @return [Array<Types::ICD10CMTrait>]
628
+ #
629
+ # @!attribute [rw] icd10cm_concepts
630
+ # The ICD-10-CM concepts that the entity could refer to, along with a
631
+ # score indicating the likelihood of the match.
632
+ # @return [Array<Types::ICD10CMConcept>]
633
+ #
634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMEntity AWS API Documentation
635
+ #
636
+ class ICD10CMEntity < Struct.new(
637
+ :id,
638
+ :text,
639
+ :category,
640
+ :type,
641
+ :score,
642
+ :begin_offset,
643
+ :end_offset,
644
+ :attributes,
645
+ :traits,
646
+ :icd10cm_concepts)
647
+ include Aws::Structure
648
+ end
649
+
650
+ # Contextual information for the entity. The traits recognized by
651
+ # InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION`.
652
+ #
653
+ # @!attribute [rw] name
654
+ # Provides a name or contextual description about the trait.
655
+ # @return [String]
656
+ #
657
+ # @!attribute [rw] score
658
+ # The level of confidence that Amazon Comprehend Medical has that the
659
+ # segment of text is correctly recognized as a trait.
660
+ # @return [Float]
661
+ #
662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMTrait AWS API Documentation
663
+ #
664
+ class ICD10CMTrait < Struct.new(
665
+ :name,
666
+ :score)
667
+ include Aws::Structure
668
+ end
669
+
670
+ # @note When making an API call, you may pass InferICD10CMRequest
671
+ # data as a hash:
672
+ #
673
+ # {
674
+ # text: "OntologyLinkingBoundedLengthString", # required
675
+ # }
676
+ #
677
+ # @!attribute [rw] text
678
+ # The input text used for analysis. The input for InferICD10CM is a
679
+ # string from 1 to 10000 characters.
680
+ # @return [String]
681
+ #
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CMRequest AWS API Documentation
683
+ #
684
+ class InferICD10CMRequest < Struct.new(
685
+ :text)
686
+ include Aws::Structure
687
+ end
688
+
689
+ # @!attribute [rw] entities
690
+ # The medical conditions detected in the text linked to ICD-10-CM
691
+ # concepts. If the action is successful, the service sends back an
692
+ # HTTP 200 response, as well as the entities detected.
693
+ # @return [Array<Types::ICD10CMEntity>]
694
+ #
695
+ # @!attribute [rw] pagination_token
696
+ # If the result of the previous request to `InferICD10CM` was
697
+ # truncated, include the `PaginationToken` to fetch the next page of
698
+ # medical condition entities.
699
+ # @return [String]
700
+ #
701
+ # @!attribute [rw] model_version
702
+ # The version of the model used to analyze the documents, in the
703
+ # format *n*.*n*.*n* You can use this information to track the model
704
+ # used for a particular batch of documents.
705
+ # @return [String]
706
+ #
707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CMResponse AWS API Documentation
708
+ #
709
+ class InferICD10CMResponse < Struct.new(
710
+ :entities,
711
+ :pagination_token,
712
+ :model_version)
713
+ include Aws::Structure
714
+ end
715
+
716
+ # @note When making an API call, you may pass InferRxNormRequest
717
+ # data as a hash:
718
+ #
719
+ # {
720
+ # text: "OntologyLinkingBoundedLengthString", # required
721
+ # }
722
+ #
723
+ # @!attribute [rw] text
724
+ # The input text used for analysis. The input for InferRxNorm is a
725
+ # string from 1 to 10000 characters.
726
+ # @return [String]
727
+ #
728
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNormRequest AWS API Documentation
729
+ #
730
+ class InferRxNormRequest < Struct.new(
731
+ :text)
732
+ include Aws::Structure
733
+ end
734
+
735
+ # @!attribute [rw] entities
736
+ # The medication entities detected in the text linked to RxNorm
737
+ # concepts. If the action is successful, the service sends back an
738
+ # HTTP 200 response, as well as the entities detected.
739
+ # @return [Array<Types::RxNormEntity>]
740
+ #
741
+ # @!attribute [rw] pagination_token
742
+ # If the result of the previous request to `InferRxNorm` was
743
+ # truncated, include the `PaginationToken` to fetch the next page of
744
+ # medication entities.
745
+ # @return [String]
746
+ #
747
+ # @!attribute [rw] model_version
748
+ # The version of the model used to analyze the documents, in the
749
+ # format *n*.*n*.*n* You can use this information to track the model
750
+ # used for a particular batch of documents.
751
+ # @return [String]
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNormResponse AWS API Documentation
754
+ #
755
+ class InferRxNormResponse < Struct.new(
756
+ :entities,
757
+ :pagination_token,
758
+ :model_version)
759
+ include Aws::Structure
760
+ end
761
+
487
762
  # The input properties for an entities detection job
488
763
  #
489
764
  # @note When making an API call, you may pass InputDataConfig
@@ -706,6 +981,189 @@ module Aws::ComprehendMedical
706
981
  include Aws::Structure
707
982
  end
708
983
 
984
+ # The extracted attributes that relate to this entity. The attributes
985
+ # recognized by InferRxNorm are `DOSAGE`, `DURATION`, `FORM`,
986
+ # `FREQUENCY`, `RATE`, `ROUTE_OR_MODE`.
987
+ #
988
+ # @!attribute [rw] type
989
+ # The type of attribute. The types of attributes recognized by
990
+ # InferRxNorm are `BRAND_NAME` and `GENERIC_NAME`.
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] score
994
+ # The level of confidence that Comprehend Medical has that the segment
995
+ # of text is correctly recognized as an attribute.
996
+ # @return [Float]
997
+ #
998
+ # @!attribute [rw] relationship_score
999
+ # The level of confidence that Amazon Comprehend Medical has that the
1000
+ # attribute is accurately linked to an entity.
1001
+ # @return [Float]
1002
+ #
1003
+ # @!attribute [rw] id
1004
+ # The numeric identifier for this attribute. This is a monotonically
1005
+ # increasing id unique within this response rather than a global
1006
+ # unique identifier.
1007
+ # @return [Integer]
1008
+ #
1009
+ # @!attribute [rw] begin_offset
1010
+ # The 0-based character offset in the input text that shows where the
1011
+ # attribute begins. The offset returns the UTF-8 code point in the
1012
+ # string.
1013
+ # @return [Integer]
1014
+ #
1015
+ # @!attribute [rw] end_offset
1016
+ # The 0-based character offset in the input text that shows where the
1017
+ # attribute ends. The offset returns the UTF-8 code point in the
1018
+ # string.
1019
+ # @return [Integer]
1020
+ #
1021
+ # @!attribute [rw] text
1022
+ # The segment of input text which corresponds to the detected
1023
+ # attribute.
1024
+ # @return [String]
1025
+ #
1026
+ # @!attribute [rw] traits
1027
+ # Contextual information for the attribute. InferRxNorm recognizes the
1028
+ # trait `NEGATION` for attributes, i.e. that the patient is not taking
1029
+ # a specific dose or form of a medication.
1030
+ # @return [Array<Types::RxNormTrait>]
1031
+ #
1032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormAttribute AWS API Documentation
1033
+ #
1034
+ class RxNormAttribute < Struct.new(
1035
+ :type,
1036
+ :score,
1037
+ :relationship_score,
1038
+ :id,
1039
+ :begin_offset,
1040
+ :end_offset,
1041
+ :text,
1042
+ :traits)
1043
+ include Aws::Structure
1044
+ end
1045
+
1046
+ # The RxNorm concept that the entity could refer to, along with a score
1047
+ # indicating the likelihood of the match.
1048
+ #
1049
+ # @!attribute [rw] description
1050
+ # The description of the RxNorm concept.
1051
+ # @return [String]
1052
+ #
1053
+ # @!attribute [rw] code
1054
+ # RxNorm concept ID, also known as the RxCUI.
1055
+ # @return [String]
1056
+ #
1057
+ # @!attribute [rw] score
1058
+ # The level of confidence that Amazon Comprehend Medical has that the
1059
+ # entity is accurately linked to the reported RxNorm concept.
1060
+ # @return [Float]
1061
+ #
1062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormConcept AWS API Documentation
1063
+ #
1064
+ class RxNormConcept < Struct.new(
1065
+ :description,
1066
+ :code,
1067
+ :score)
1068
+ include Aws::Structure
1069
+ end
1070
+
1071
+ # The collection of medical entities extracted from the input text and
1072
+ # their associated information. For each entity, the response provides
1073
+ # the entity text, the entity category, where the entity text begins and
1074
+ # ends, and the level of confidence that Amazon Comprehend Medical has
1075
+ # in the detection and analysis. Attributes and traits of the entity are
1076
+ # also returned.
1077
+ #
1078
+ # @!attribute [rw] id
1079
+ # The numeric identifier for the entity. This is a monotonically
1080
+ # increasing id unique within this response rather than a global
1081
+ # unique identifier.
1082
+ # @return [Integer]
1083
+ #
1084
+ # @!attribute [rw] text
1085
+ # The segment of input text extracted from which the entity was
1086
+ # detected.
1087
+ # @return [String]
1088
+ #
1089
+ # @!attribute [rw] category
1090
+ # The category of the entity. The recognized categories are `GENERIC`
1091
+ # or `BRAND_NAME`.
1092
+ # @return [String]
1093
+ #
1094
+ # @!attribute [rw] type
1095
+ # Describes the specific type of entity. For InferRxNorm, the
1096
+ # recognized entity type is `MEDICATION`.
1097
+ # @return [String]
1098
+ #
1099
+ # @!attribute [rw] score
1100
+ # The level of confidence that Amazon Comprehend Medical has in the
1101
+ # accuracy of the detected entity.
1102
+ # @return [Float]
1103
+ #
1104
+ # @!attribute [rw] begin_offset
1105
+ # The 0-based character offset in the input text that shows where the
1106
+ # entity begins. The offset returns the UTF-8 code point in the
1107
+ # string.
1108
+ # @return [Integer]
1109
+ #
1110
+ # @!attribute [rw] end_offset
1111
+ # The 0-based character offset in the input text that shows where the
1112
+ # entity ends. The offset returns the UTF-8 code point in the string.
1113
+ # @return [Integer]
1114
+ #
1115
+ # @!attribute [rw] attributes
1116
+ # The extracted attributes that relate to the entity. The attributes
1117
+ # recognized by InferRxNorm are `DOSAGE`, `DURATION`, `FORM`,
1118
+ # `FREQUENCY`, `RATE`, `ROUTE_OR_MODE`, and `STRENGTH`.
1119
+ # @return [Array<Types::RxNormAttribute>]
1120
+ #
1121
+ # @!attribute [rw] traits
1122
+ # Contextual information for the entity.
1123
+ # @return [Array<Types::RxNormTrait>]
1124
+ #
1125
+ # @!attribute [rw] rx_norm_concepts
1126
+ # The RxNorm concepts that the entity could refer to, along with a
1127
+ # score indicating the likelihood of the match.
1128
+ # @return [Array<Types::RxNormConcept>]
1129
+ #
1130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormEntity AWS API Documentation
1131
+ #
1132
+ class RxNormEntity < Struct.new(
1133
+ :id,
1134
+ :text,
1135
+ :category,
1136
+ :type,
1137
+ :score,
1138
+ :begin_offset,
1139
+ :end_offset,
1140
+ :attributes,
1141
+ :traits,
1142
+ :rx_norm_concepts)
1143
+ include Aws::Structure
1144
+ end
1145
+
1146
+ # The contextual information for the entity. InferRxNorm recognizes the
1147
+ # trait `NEGATION`, which is any indication that the patient is not
1148
+ # taking a medication.
1149
+ #
1150
+ # @!attribute [rw] name
1151
+ # Provides a name or contextual description about the trait.
1152
+ # @return [String]
1153
+ #
1154
+ # @!attribute [rw] score
1155
+ # The level of confidence that Amazon Comprehend Medical has in the
1156
+ # accuracy of the detected trait.
1157
+ # @return [Float]
1158
+ #
1159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormTrait AWS API Documentation
1160
+ #
1161
+ class RxNormTrait < Struct.new(
1162
+ :name,
1163
+ :score)
1164
+ include Aws::Structure
1165
+ end
1166
+
709
1167
  # The Amazon Comprehend Medical service is temporarily unavailable.
710
1168
  # Please wait and then retry your request.
711
1169
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-comprehendmedical
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.11.0
4
+ version: 1.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-11-05 00:00:00.000000000 Z
11
+ date: 2019-12-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core