mypydantic.models.comprehendmedical

View Source

  1# Model Generated: Thu Mar  2 21:56:17 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Dict, List, Literal, Optional, Union
  7
  8from pydantic import Field
  9
 10from mypydantic.models.base_model import BaseModel
 11
 12
 13class TraitModel(BaseModel):
 14    name: Optional[
 15        Literal[
 16            "DIAGNOSIS",
 17            "FUTURE",
 18            "HYPOTHETICAL",
 19            "LOW_CONFIDENCE",
 20            "NEGATION",
 21            "PAST_HISTORY",
 22            "PERTAINS_TO_FAMILY",
 23            "SIGN",
 24            "SYMPTOM",
 25        ]
 26    ] = Field(default=None, alias="Name")
 27    score: Optional[float] = Field(default=None, alias="Score")
 28
 29
 30class CharactersModel(BaseModel):
 31    original_text_characters: Optional[int] = Field(
 32        default=None, alias="OriginalTextCharacters"
 33    )
 34
 35
 36class ComprehendMedicalAsyncJobFilterModel(BaseModel):
 37    job_name: Optional[str] = Field(default=None, alias="JobName")
 38    job_status: Optional[
 39        Literal[
 40            "COMPLETED",
 41            "FAILED",
 42            "IN_PROGRESS",
 43            "PARTIAL_SUCCESS",
 44            "STOPPED",
 45            "STOP_REQUESTED",
 46            "SUBMITTED",
 47        ]
 48    ] = Field(default=None, alias="JobStatus")
 49    submit_time_before: Optional[Union[datetime, str]] = Field(
 50        default=None, alias="SubmitTimeBefore"
 51    )
 52    submit_time_after: Optional[Union[datetime, str]] = Field(
 53        default=None, alias="SubmitTimeAfter"
 54    )
 55
 56
 57class InputDataConfigModel(BaseModel):
 58    s3_bucket: str = Field(alias="S3Bucket")
 59    s3_key: Optional[str] = Field(default=None, alias="S3Key")
 60
 61
 62class OutputDataConfigModel(BaseModel):
 63    s3_bucket: str = Field(alias="S3Bucket")
 64    s3_key: Optional[str] = Field(default=None, alias="S3Key")
 65
 66
 67class DescribeEntitiesDetectionV2JobRequestModel(BaseModel):
 68    job_id: str = Field(alias="JobId")
 69
 70
 71class ResponseMetadataModel(BaseModel):
 72    request_id: str = Field(alias="RequestId")
 73    host_id: str = Field(alias="HostId")
 74    http_status_code: int = Field(alias="HTTPStatusCode")
 75    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 76    retry_attempts: int = Field(alias="RetryAttempts")
 77
 78
 79class DescribeICD10CMInferenceJobRequestModel(BaseModel):
 80    job_id: str = Field(alias="JobId")
 81
 82
 83class DescribePHIDetectionJobRequestModel(BaseModel):
 84    job_id: str = Field(alias="JobId")
 85
 86
 87class DescribeRxNormInferenceJobRequestModel(BaseModel):
 88    job_id: str = Field(alias="JobId")
 89
 90
 91class DescribeSNOMEDCTInferenceJobRequestModel(BaseModel):
 92    job_id: str = Field(alias="JobId")
 93
 94
 95class DetectEntitiesRequestModel(BaseModel):
 96    text: str = Field(alias="Text")
 97
 98
 99class DetectEntitiesV2RequestModel(BaseModel):
100    text: str = Field(alias="Text")
101
102
103class DetectPHIRequestModel(BaseModel):
104    text: str = Field(alias="Text")
105
106
107class ICD10CMTraitModel(BaseModel):
108    name: Optional[
109        Literal[
110            "DIAGNOSIS",
111            "HYPOTHETICAL",
112            "LOW_CONFIDENCE",
113            "NEGATION",
114            "PERTAINS_TO_FAMILY",
115            "SIGN",
116            "SYMPTOM",
117        ]
118    ] = Field(default=None, alias="Name")
119    score: Optional[float] = Field(default=None, alias="Score")
120
121
122class ICD10CMConceptModel(BaseModel):
123    description: Optional[str] = Field(default=None, alias="Description")
124    code: Optional[str] = Field(default=None, alias="Code")
125    score: Optional[float] = Field(default=None, alias="Score")
126
127
128class InferICD10CMRequestModel(BaseModel):
129    text: str = Field(alias="Text")
130
131
132class InferRxNormRequestModel(BaseModel):
133    text: str = Field(alias="Text")
134
135
136class InferSNOMEDCTRequestModel(BaseModel):
137    text: str = Field(alias="Text")
138
139
140class SNOMEDCTDetailsModel(BaseModel):
141    edition: Optional[str] = Field(default=None, alias="Edition")
142    language: Optional[str] = Field(default=None, alias="Language")
143    version_date: Optional[str] = Field(default=None, alias="VersionDate")
144
145
146class RxNormTraitModel(BaseModel):
147    name: Optional[Literal["NEGATION"]] = Field(default=None, alias="Name")
148    score: Optional[float] = Field(default=None, alias="Score")
149
150
151class RxNormConceptModel(BaseModel):
152    description: Optional[str] = Field(default=None, alias="Description")
153    code: Optional[str] = Field(default=None, alias="Code")
154    score: Optional[float] = Field(default=None, alias="Score")
155
156
157class SNOMEDCTConceptModel(BaseModel):
158    description: Optional[str] = Field(default=None, alias="Description")
159    code: Optional[str] = Field(default=None, alias="Code")
160    score: Optional[float] = Field(default=None, alias="Score")
161
162
163class SNOMEDCTTraitModel(BaseModel):
164    name: Optional[
165        Literal[
166            "DIAGNOSIS",
167            "FUTURE",
168            "HYPOTHETICAL",
169            "LOW_CONFIDENCE",
170            "NEGATION",
171            "PAST_HISTORY",
172            "PERTAINS_TO_FAMILY",
173            "SIGN",
174            "SYMPTOM",
175        ]
176    ] = Field(default=None, alias="Name")
177    score: Optional[float] = Field(default=None, alias="Score")
178
179
180class StopEntitiesDetectionV2JobRequestModel(BaseModel):
181    job_id: str = Field(alias="JobId")
182
183
184class StopICD10CMInferenceJobRequestModel(BaseModel):
185    job_id: str = Field(alias="JobId")
186
187
188class StopPHIDetectionJobRequestModel(BaseModel):
189    job_id: str = Field(alias="JobId")
190
191
192class StopRxNormInferenceJobRequestModel(BaseModel):
193    job_id: str = Field(alias="JobId")
194
195
196class StopSNOMEDCTInferenceJobRequestModel(BaseModel):
197    job_id: str = Field(alias="JobId")
198
199
200class AttributeModel(BaseModel):
201    type: Optional[
202        Literal[
203            "ACUITY",
204            "ADDRESS",
205            "AGE",
206            "ALCOHOL_CONSUMPTION",
207            "ALLERGIES",
208            "AMOUNT",
209            "BRAND_NAME",
210            "CONTACT_POINT",
211            "DATE",
212            "DIRECTION",
213            "DOSAGE",
214            "DURATION",
215            "DX_NAME",
216            "EMAIL",
217            "FORM",
218            "FREQUENCY",
219            "GENDER",
220            "GENERIC_NAME",
221            "ID",
222            "IDENTIFIER",
223            "NAME",
224            "PHONE_OR_FAX",
225            "PROCEDURE_NAME",
226            "PROFESSION",
227            "QUALITY",
228            "QUANTITY",
229            "RACE_ETHNICITY",
230            "RATE",
231            "REC_DRUG_USE",
232            "ROUTE_OR_MODE",
233            "STRENGTH",
234            "SYSTEM_ORGAN_SITE",
235            "TEST_NAME",
236            "TEST_UNIT",
237            "TEST_UNITS",
238            "TEST_VALUE",
239            "TIME_EXPRESSION",
240            "TIME_TO_DX_NAME",
241            "TIME_TO_MEDICATION_NAME",
242            "TIME_TO_PROCEDURE_NAME",
243            "TIME_TO_TEST_NAME",
244            "TIME_TO_TREATMENT_NAME",
245            "TOBACCO_USE",
246            "TREATMENT_NAME",
247            "URL",
248        ]
249    ] = Field(default=None, alias="Type")
250    score: Optional[float] = Field(default=None, alias="Score")
251    relationship_score: Optional[float] = Field(default=None, alias="RelationshipScore")
252    relationship_type: Optional[
253        Literal[
254            "ACUITY",
255            "ADMINISTERED_VIA",
256            "AMOUNT",
257            "DIRECTION",
258            "DOSAGE",
259            "DURATION",
260            "EVERY",
261            "FOR",
262            "FORM",
263            "FREQUENCY",
264            "NEGATIVE",
265            "OVERLAP",
266            "RATE",
267            "ROUTE_OR_MODE",
268            "STRENGTH",
269            "SYSTEM_ORGAN_SITE",
270            "TEST_UNIT",
271            "TEST_UNITS",
272            "TEST_VALUE",
273            "WITH_DOSAGE",
274        ]
275    ] = Field(default=None, alias="RelationshipType")
276    id: Optional[int] = Field(default=None, alias="Id")
277    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
278    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
279    text: Optional[str] = Field(default=None, alias="Text")
280    category: Optional[
281        Literal[
282            "ANATOMY",
283            "BEHAVIORAL_ENVIRONMENTAL_SOCIAL",
284            "MEDICAL_CONDITION",
285            "MEDICATION",
286            "PROTECTED_HEALTH_INFORMATION",
287            "TEST_TREATMENT_PROCEDURE",
288            "TIME_EXPRESSION",
289        ]
290    ] = Field(default=None, alias="Category")
291    traits: Optional[List[TraitModel]] = Field(default=None, alias="Traits")
292
293
294class ListEntitiesDetectionV2JobsRequestModel(BaseModel):
295    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
296        default=None, alias="Filter"
297    )
298    next_token: Optional[str] = Field(default=None, alias="NextToken")
299    max_results: Optional[int] = Field(default=None, alias="MaxResults")
300
301
302class ListICD10CMInferenceJobsRequestModel(BaseModel):
303    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
304        default=None, alias="Filter"
305    )
306    next_token: Optional[str] = Field(default=None, alias="NextToken")
307    max_results: Optional[int] = Field(default=None, alias="MaxResults")
308
309
310class ListPHIDetectionJobsRequestModel(BaseModel):
311    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
312        default=None, alias="Filter"
313    )
314    next_token: Optional[str] = Field(default=None, alias="NextToken")
315    max_results: Optional[int] = Field(default=None, alias="MaxResults")
316
317
318class ListRxNormInferenceJobsRequestModel(BaseModel):
319    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
320        default=None, alias="Filter"
321    )
322    next_token: Optional[str] = Field(default=None, alias="NextToken")
323    max_results: Optional[int] = Field(default=None, alias="MaxResults")
324
325
326class ListSNOMEDCTInferenceJobsRequestModel(BaseModel):
327    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
328        default=None, alias="Filter"
329    )
330    next_token: Optional[str] = Field(default=None, alias="NextToken")
331    max_results: Optional[int] = Field(default=None, alias="MaxResults")
332
333
334class ComprehendMedicalAsyncJobPropertiesModel(BaseModel):
335    job_id: Optional[str] = Field(default=None, alias="JobId")
336    job_name: Optional[str] = Field(default=None, alias="JobName")
337    job_status: Optional[
338        Literal[
339            "COMPLETED",
340            "FAILED",
341            "IN_PROGRESS",
342            "PARTIAL_SUCCESS",
343            "STOPPED",
344            "STOP_REQUESTED",
345            "SUBMITTED",
346        ]
347    ] = Field(default=None, alias="JobStatus")
348    message: Optional[str] = Field(default=None, alias="Message")
349    submit_time: Optional[datetime] = Field(default=None, alias="SubmitTime")
350    end_time: Optional[datetime] = Field(default=None, alias="EndTime")
351    expiration_time: Optional[datetime] = Field(default=None, alias="ExpirationTime")
352    input_data_config: Optional[InputDataConfigModel] = Field(
353        default=None, alias="InputDataConfig"
354    )
355    output_data_config: Optional[OutputDataConfigModel] = Field(
356        default=None, alias="OutputDataConfig"
357    )
358    language_code: Optional[Literal["en"]] = Field(default=None, alias="LanguageCode")
359    data_access_role_arn: Optional[str] = Field(default=None, alias="DataAccessRoleArn")
360    manifest_file_path: Optional[str] = Field(default=None, alias="ManifestFilePath")
361    kms_key: Optional[str] = Field(default=None, alias="KMSKey")
362    model_version: Optional[str] = Field(default=None, alias="ModelVersion")
363
364
365class StartEntitiesDetectionV2JobRequestModel(BaseModel):
366    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
367    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
368    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
369    language_code: Literal["en"] = Field(alias="LanguageCode")
370    job_name: Optional[str] = Field(default=None, alias="JobName")
371    client_request_token: Optional[str] = Field(
372        default=None, alias="ClientRequestToken"
373    )
374    kms_key: Optional[str] = Field(default=None, alias="KMSKey")
375
376
377class StartICD10CMInferenceJobRequestModel(BaseModel):
378    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
379    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
380    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
381    language_code: Literal["en"] = Field(alias="LanguageCode")
382    job_name: Optional[str] = Field(default=None, alias="JobName")
383    client_request_token: Optional[str] = Field(
384        default=None, alias="ClientRequestToken"
385    )
386    kms_key: Optional[str] = Field(default=None, alias="KMSKey")
387
388
389class StartPHIDetectionJobRequestModel(BaseModel):
390    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
391    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
392    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
393    language_code: Literal["en"] = Field(alias="LanguageCode")
394    job_name: Optional[str] = Field(default=None, alias="JobName")
395    client_request_token: Optional[str] = Field(
396        default=None, alias="ClientRequestToken"
397    )
398    kms_key: Optional[str] = Field(default=None, alias="KMSKey")
399
400
401class StartRxNormInferenceJobRequestModel(BaseModel):
402    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
403    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
404    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
405    language_code: Literal["en"] = Field(alias="LanguageCode")
406    job_name: Optional[str] = Field(default=None, alias="JobName")
407    client_request_token: Optional[str] = Field(
408        default=None, alias="ClientRequestToken"
409    )
410    kms_key: Optional[str] = Field(default=None, alias="KMSKey")
411
412
413class StartSNOMEDCTInferenceJobRequestModel(BaseModel):
414    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
415    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
416    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
417    language_code: Literal["en"] = Field(alias="LanguageCode")
418    job_name: Optional[str] = Field(default=None, alias="JobName")
419    client_request_token: Optional[str] = Field(
420        default=None, alias="ClientRequestToken"
421    )
422    kms_key: Optional[str] = Field(default=None, alias="KMSKey")
423
424
425class StartEntitiesDetectionV2JobResponseModel(BaseModel):
426    job_id: str = Field(alias="JobId")
427    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
428
429
430class StartICD10CMInferenceJobResponseModel(BaseModel):
431    job_id: str = Field(alias="JobId")
432    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
433
434
435class StartPHIDetectionJobResponseModel(BaseModel):
436    job_id: str = Field(alias="JobId")
437    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
438
439
440class StartRxNormInferenceJobResponseModel(BaseModel):
441    job_id: str = Field(alias="JobId")
442    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
443
444
445class StartSNOMEDCTInferenceJobResponseModel(BaseModel):
446    job_id: str = Field(alias="JobId")
447    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
448
449
450class StopEntitiesDetectionV2JobResponseModel(BaseModel):
451    job_id: str = Field(alias="JobId")
452    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
453
454
455class StopICD10CMInferenceJobResponseModel(BaseModel):
456    job_id: str = Field(alias="JobId")
457    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
458
459
460class StopPHIDetectionJobResponseModel(BaseModel):
461    job_id: str = Field(alias="JobId")
462    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
463
464
465class StopRxNormInferenceJobResponseModel(BaseModel):
466    job_id: str = Field(alias="JobId")
467    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
468
469
470class StopSNOMEDCTInferenceJobResponseModel(BaseModel):
471    job_id: str = Field(alias="JobId")
472    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
473
474
475class ICD10CMAttributeModel(BaseModel):
476    type: Optional[
477        Literal[
478            "ACUITY",
479            "DIRECTION",
480            "QUALITY",
481            "QUANTITY",
482            "SYSTEM_ORGAN_SITE",
483            "TIME_EXPRESSION",
484            "TIME_TO_DX_NAME",
485        ]
486    ] = Field(default=None, alias="Type")
487    score: Optional[float] = Field(default=None, alias="Score")
488    relationship_score: Optional[float] = Field(default=None, alias="RelationshipScore")
489    id: Optional[int] = Field(default=None, alias="Id")
490    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
491    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
492    text: Optional[str] = Field(default=None, alias="Text")
493    traits: Optional[List[ICD10CMTraitModel]] = Field(default=None, alias="Traits")
494    category: Optional[Literal["DX_NAME", "TIME_EXPRESSION"]] = Field(
495        default=None, alias="Category"
496    )
497    relationship_type: Optional[Literal["OVERLAP", "SYSTEM_ORGAN_SITE"]] = Field(
498        default=None, alias="RelationshipType"
499    )
500
501
502class RxNormAttributeModel(BaseModel):
503    type: Optional[
504        Literal[
505            "DOSAGE",
506            "DURATION",
507            "FORM",
508            "FREQUENCY",
509            "RATE",
510            "ROUTE_OR_MODE",
511            "STRENGTH",
512        ]
513    ] = Field(default=None, alias="Type")
514    score: Optional[float] = Field(default=None, alias="Score")
515    relationship_score: Optional[float] = Field(default=None, alias="RelationshipScore")
516    id: Optional[int] = Field(default=None, alias="Id")
517    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
518    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
519    text: Optional[str] = Field(default=None, alias="Text")
520    traits: Optional[List[RxNormTraitModel]] = Field(default=None, alias="Traits")
521
522
523class SNOMEDCTAttributeModel(BaseModel):
524    category: Optional[
525        Literal["ANATOMY", "MEDICAL_CONDITION", "TEST_TREATMENT_PROCEDURE"]
526    ] = Field(default=None, alias="Category")
527    type: Optional[
528        Literal[
529            "ACUITY",
530            "DIRECTION",
531            "QUALITY",
532            "SYSTEM_ORGAN_SITE",
533            "TEST_UNIT",
534            "TEST_VALUE",
535        ]
536    ] = Field(default=None, alias="Type")
537    score: Optional[float] = Field(default=None, alias="Score")
538    relationship_score: Optional[float] = Field(default=None, alias="RelationshipScore")
539    relationship_type: Optional[
540        Literal[
541            "ACUITY",
542            "DIRECTION",
543            "QUALITY",
544            "SYSTEM_ORGAN_SITE",
545            "TEST_UNITS",
546            "TEST_VALUE",
547        ]
548    ] = Field(default=None, alias="RelationshipType")
549    id: Optional[int] = Field(default=None, alias="Id")
550    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
551    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
552    text: Optional[str] = Field(default=None, alias="Text")
553    traits: Optional[List[SNOMEDCTTraitModel]] = Field(default=None, alias="Traits")
554    s_nomedctconcepts: Optional[List[SNOMEDCTConceptModel]] = Field(
555        default=None, alias="SNOMEDCTConcepts"
556    )
557
558
559class EntityModel(BaseModel):
560    id: Optional[int] = Field(default=None, alias="Id")
561    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
562    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
563    score: Optional[float] = Field(default=None, alias="Score")
564    text: Optional[str] = Field(default=None, alias="Text")
565    category: Optional[
566        Literal[
567            "ANATOMY",
568            "BEHAVIORAL_ENVIRONMENTAL_SOCIAL",
569            "MEDICAL_CONDITION",
570            "MEDICATION",
571            "PROTECTED_HEALTH_INFORMATION",
572            "TEST_TREATMENT_PROCEDURE",
573            "TIME_EXPRESSION",
574        ]
575    ] = Field(default=None, alias="Category")
576    type: Optional[
577        Literal[
578            "ACUITY",
579            "ADDRESS",
580            "AGE",
581            "ALCOHOL_CONSUMPTION",
582            "ALLERGIES",
583            "AMOUNT",
584            "BRAND_NAME",
585            "CONTACT_POINT",
586            "DATE",
587            "DIRECTION",
588            "DOSAGE",
589            "DURATION",
590            "DX_NAME",
591            "EMAIL",
592            "FORM",
593            "FREQUENCY",
594            "GENDER",
595            "GENERIC_NAME",
596            "ID",
597            "IDENTIFIER",
598            "NAME",
599            "PHONE_OR_FAX",
600            "PROCEDURE_NAME",
601            "PROFESSION",
602            "QUALITY",
603            "QUANTITY",
604            "RACE_ETHNICITY",
605            "RATE",
606            "REC_DRUG_USE",
607            "ROUTE_OR_MODE",
608            "STRENGTH",
609            "SYSTEM_ORGAN_SITE",
610            "TEST_NAME",
611            "TEST_UNIT",
612            "TEST_UNITS",
613            "TEST_VALUE",
614            "TIME_EXPRESSION",
615            "TIME_TO_DX_NAME",
616            "TIME_TO_MEDICATION_NAME",
617            "TIME_TO_PROCEDURE_NAME",
618            "TIME_TO_TEST_NAME",
619            "TIME_TO_TREATMENT_NAME",
620            "TOBACCO_USE",
621            "TREATMENT_NAME",
622            "URL",
623        ]
624    ] = Field(default=None, alias="Type")
625    traits: Optional[List[TraitModel]] = Field(default=None, alias="Traits")
626    attributes: Optional[List[AttributeModel]] = Field(default=None, alias="Attributes")
627
628
629class UnmappedAttributeModel(BaseModel):
630    type: Optional[
631        Literal[
632            "ANATOMY",
633            "BEHAVIORAL_ENVIRONMENTAL_SOCIAL",
634            "MEDICAL_CONDITION",
635            "MEDICATION",
636            "PROTECTED_HEALTH_INFORMATION",
637            "TEST_TREATMENT_PROCEDURE",
638            "TIME_EXPRESSION",
639        ]
640    ] = Field(default=None, alias="Type")
641    attribute: Optional[AttributeModel] = Field(default=None, alias="Attribute")
642
643
644class DescribeEntitiesDetectionV2JobResponseModel(BaseModel):
645    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
646        alias="ComprehendMedicalAsyncJobProperties"
647    )
648    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
649
650
651class DescribeICD10CMInferenceJobResponseModel(BaseModel):
652    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
653        alias="ComprehendMedicalAsyncJobProperties"
654    )
655    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
656
657
658class DescribePHIDetectionJobResponseModel(BaseModel):
659    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
660        alias="ComprehendMedicalAsyncJobProperties"
661    )
662    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
663
664
665class DescribeRxNormInferenceJobResponseModel(BaseModel):
666    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
667        alias="ComprehendMedicalAsyncJobProperties"
668    )
669    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
670
671
672class DescribeSNOMEDCTInferenceJobResponseModel(BaseModel):
673    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
674        alias="ComprehendMedicalAsyncJobProperties"
675    )
676    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
677
678
679class ListEntitiesDetectionV2JobsResponseModel(BaseModel):
680    comprehend_medical_async_job_properties_list: List[
681        ComprehendMedicalAsyncJobPropertiesModel
682    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
683    next_token: str = Field(alias="NextToken")
684    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
685
686
687class ListICD10CMInferenceJobsResponseModel(BaseModel):
688    comprehend_medical_async_job_properties_list: List[
689        ComprehendMedicalAsyncJobPropertiesModel
690    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
691    next_token: str = Field(alias="NextToken")
692    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
693
694
695class ListPHIDetectionJobsResponseModel(BaseModel):
696    comprehend_medical_async_job_properties_list: List[
697        ComprehendMedicalAsyncJobPropertiesModel
698    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
699    next_token: str = Field(alias="NextToken")
700    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
701
702
703class ListRxNormInferenceJobsResponseModel(BaseModel):
704    comprehend_medical_async_job_properties_list: List[
705        ComprehendMedicalAsyncJobPropertiesModel
706    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
707    next_token: str = Field(alias="NextToken")
708    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
709
710
711class ListSNOMEDCTInferenceJobsResponseModel(BaseModel):
712    comprehend_medical_async_job_properties_list: List[
713        ComprehendMedicalAsyncJobPropertiesModel
714    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
715    next_token: str = Field(alias="NextToken")
716    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
717
718
719class ICD10CMEntityModel(BaseModel):
720    id: Optional[int] = Field(default=None, alias="Id")
721    text: Optional[str] = Field(default=None, alias="Text")
722    category: Optional[Literal["MEDICAL_CONDITION"]] = Field(
723        default=None, alias="Category"
724    )
725    type: Optional[Literal["DX_NAME", "TIME_EXPRESSION"]] = Field(
726        default=None, alias="Type"
727    )
728    score: Optional[float] = Field(default=None, alias="Score")
729    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
730    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
731    attributes: Optional[List[ICD10CMAttributeModel]] = Field(
732        default=None, alias="Attributes"
733    )
734    traits: Optional[List[ICD10CMTraitModel]] = Field(default=None, alias="Traits")
735    icd10_cmconcepts: Optional[List[ICD10CMConceptModel]] = Field(
736        default=None, alias="ICD10CMConcepts"
737    )
738
739
740class RxNormEntityModel(BaseModel):
741    id: Optional[int] = Field(default=None, alias="Id")
742    text: Optional[str] = Field(default=None, alias="Text")
743    category: Optional[Literal["MEDICATION"]] = Field(default=None, alias="Category")
744    type: Optional[Literal["BRAND_NAME", "GENERIC_NAME"]] = Field(
745        default=None, alias="Type"
746    )
747    score: Optional[float] = Field(default=None, alias="Score")
748    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
749    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
750    attributes: Optional[List[RxNormAttributeModel]] = Field(
751        default=None, alias="Attributes"
752    )
753    traits: Optional[List[RxNormTraitModel]] = Field(default=None, alias="Traits")
754    rx_norm_concepts: Optional[List[RxNormConceptModel]] = Field(
755        default=None, alias="RxNormConcepts"
756    )
757
758
759class SNOMEDCTEntityModel(BaseModel):
760    id: Optional[int] = Field(default=None, alias="Id")
761    text: Optional[str] = Field(default=None, alias="Text")
762    category: Optional[
763        Literal["ANATOMY", "MEDICAL_CONDITION", "TEST_TREATMENT_PROCEDURE"]
764    ] = Field(default=None, alias="Category")
765    type: Optional[
766        Literal["DX_NAME", "PROCEDURE_NAME", "TEST_NAME", "TREATMENT_NAME"]
767    ] = Field(default=None, alias="Type")
768    score: Optional[float] = Field(default=None, alias="Score")
769    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
770    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
771    attributes: Optional[List[SNOMEDCTAttributeModel]] = Field(
772        default=None, alias="Attributes"
773    )
774    traits: Optional[List[SNOMEDCTTraitModel]] = Field(default=None, alias="Traits")
775    s_nomedctconcepts: Optional[List[SNOMEDCTConceptModel]] = Field(
776        default=None, alias="SNOMEDCTConcepts"
777    )
778
779
780class DetectPHIResponseModel(BaseModel):
781    entities: List[EntityModel] = Field(alias="Entities")
782    pagination_token: str = Field(alias="PaginationToken")
783    model_version: str = Field(alias="ModelVersion")
784    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
785
786
787class DetectEntitiesResponseModel(BaseModel):
788    entities: List[EntityModel] = Field(alias="Entities")
789    unmapped_attributes: List[UnmappedAttributeModel] = Field(
790        alias="UnmappedAttributes"
791    )
792    pagination_token: str = Field(alias="PaginationToken")
793    model_version: str = Field(alias="ModelVersion")
794    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
795
796
797class DetectEntitiesV2ResponseModel(BaseModel):
798    entities: List[EntityModel] = Field(alias="Entities")
799    unmapped_attributes: List[UnmappedAttributeModel] = Field(
800        alias="UnmappedAttributes"
801    )
802    pagination_token: str = Field(alias="PaginationToken")
803    model_version: str = Field(alias="ModelVersion")
804    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
805
806
807class InferICD10CMResponseModel(BaseModel):
808    entities: List[ICD10CMEntityModel] = Field(alias="Entities")
809    pagination_token: str = Field(alias="PaginationToken")
810    model_version: str = Field(alias="ModelVersion")
811    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
812
813
814class InferRxNormResponseModel(BaseModel):
815    entities: List[RxNormEntityModel] = Field(alias="Entities")
816    pagination_token: str = Field(alias="PaginationToken")
817    model_version: str = Field(alias="ModelVersion")
818    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
819
820
821class InferSNOMEDCTResponseModel(BaseModel):
822    entities: List[SNOMEDCTEntityModel] = Field(alias="Entities")
823    pagination_token: str = Field(alias="PaginationToken")
824    model_version: str = Field(alias="ModelVersion")
825    s_nomedctdetails: SNOMEDCTDetailsModel = Field(alias="SNOMEDCTDetails")
826    characters: CharactersModel = Field(alias="Characters")
827    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

class TraitModel(mypydantic.models.base_model.BaseModel): View Source

14class TraitModel(BaseModel):
15    name: Optional[
16        Literal[
17            "DIAGNOSIS",
18            "FUTURE",
19            "HYPOTHETICAL",
20            "LOW_CONFIDENCE",
21            "NEGATION",
22            "PAST_HISTORY",
23            "PERTAINS_TO_FAMILY",
24            "SIGN",
25            "SYMPTOM",
26        ]
27    ] = Field(default=None, alias="Name")
28    score: Optional[float] = Field(default=None, alias="Score")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class CharactersModel(mypydantic.models.base_model.BaseModel): View Source

31class CharactersModel(BaseModel):
32    original_text_characters: Optional[int] = Field(
33        default=None, alias="OriginalTextCharacters"
34    )

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ComprehendMedicalAsyncJobFilterModel(mypydantic.models.base_model.BaseModel): View Source

37class ComprehendMedicalAsyncJobFilterModel(BaseModel):
38    job_name: Optional[str] = Field(default=None, alias="JobName")
39    job_status: Optional[
40        Literal[
41            "COMPLETED",
42            "FAILED",
43            "IN_PROGRESS",
44            "PARTIAL_SUCCESS",
45            "STOPPED",
46            "STOP_REQUESTED",
47            "SUBMITTED",
48        ]
49    ] = Field(default=None, alias="JobStatus")
50    submit_time_before: Optional[Union[datetime, str]] = Field(
51        default=None, alias="SubmitTimeBefore"
52    )
53    submit_time_after: Optional[Union[datetime, str]] = Field(
54        default=None, alias="SubmitTimeAfter"
55    )

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class InputDataConfigModel(mypydantic.models.base_model.BaseModel): View Source

58class InputDataConfigModel(BaseModel):
59    s3_bucket: str = Field(alias="S3Bucket")
60    s3_key: Optional[str] = Field(default=None, alias="S3Key")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class OutputDataConfigModel(mypydantic.models.base_model.BaseModel): View Source

63class OutputDataConfigModel(BaseModel):
64    s3_bucket: str = Field(alias="S3Bucket")
65    s3_key: Optional[str] = Field(default=None, alias="S3Key")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribeEntitiesDetectionV2JobRequestModel(mypydantic.models.base_model.BaseModel): View Source

68class DescribeEntitiesDetectionV2JobRequestModel(BaseModel):
69    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ResponseMetadataModel(mypydantic.models.base_model.BaseModel): View Source

72class ResponseMetadataModel(BaseModel):
73    request_id: str = Field(alias="RequestId")
74    host_id: str = Field(alias="HostId")
75    http_status_code: int = Field(alias="HTTPStatusCode")
76    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
77    retry_attempts: int = Field(alias="RetryAttempts")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribeICD10CMInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

80class DescribeICD10CMInferenceJobRequestModel(BaseModel):
81    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribePHIDetectionJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

84class DescribePHIDetectionJobRequestModel(BaseModel):
85    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribeRxNormInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

88class DescribeRxNormInferenceJobRequestModel(BaseModel):
89    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribeSNOMEDCTInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

92class DescribeSNOMEDCTInferenceJobRequestModel(BaseModel):
93    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DetectEntitiesRequestModel(mypydantic.models.base_model.BaseModel): View Source

96class DetectEntitiesRequestModel(BaseModel):
97    text: str = Field(alias="Text")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DetectEntitiesV2RequestModel(mypydantic.models.base_model.BaseModel): View Source

100class DetectEntitiesV2RequestModel(BaseModel):
101    text: str = Field(alias="Text")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DetectPHIRequestModel(mypydantic.models.base_model.BaseModel): View Source

104class DetectPHIRequestModel(BaseModel):
105    text: str = Field(alias="Text")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ICD10CMTraitModel(mypydantic.models.base_model.BaseModel): View Source

108class ICD10CMTraitModel(BaseModel):
109    name: Optional[
110        Literal[
111            "DIAGNOSIS",
112            "HYPOTHETICAL",
113            "LOW_CONFIDENCE",
114            "NEGATION",
115            "PERTAINS_TO_FAMILY",
116            "SIGN",
117            "SYMPTOM",
118        ]
119    ] = Field(default=None, alias="Name")
120    score: Optional[float] = Field(default=None, alias="Score")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ICD10CMConceptModel(mypydantic.models.base_model.BaseModel): View Source

123class ICD10CMConceptModel(BaseModel):
124    description: Optional[str] = Field(default=None, alias="Description")
125    code: Optional[str] = Field(default=None, alias="Code")
126    score: Optional[float] = Field(default=None, alias="Score")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class InferICD10CMRequestModel(mypydantic.models.base_model.BaseModel): View Source

129class InferICD10CMRequestModel(BaseModel):
130    text: str = Field(alias="Text")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class InferRxNormRequestModel(mypydantic.models.base_model.BaseModel): View Source

133class InferRxNormRequestModel(BaseModel):
134    text: str = Field(alias="Text")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class InferSNOMEDCTRequestModel(mypydantic.models.base_model.BaseModel): View Source

137class InferSNOMEDCTRequestModel(BaseModel):
138    text: str = Field(alias="Text")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class SNOMEDCTDetailsModel(mypydantic.models.base_model.BaseModel): View Source

141class SNOMEDCTDetailsModel(BaseModel):
142    edition: Optional[str] = Field(default=None, alias="Edition")
143    language: Optional[str] = Field(default=None, alias="Language")
144    version_date: Optional[str] = Field(default=None, alias="VersionDate")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class RxNormTraitModel(mypydantic.models.base_model.BaseModel): View Source

147class RxNormTraitModel(BaseModel):
148    name: Optional[Literal["NEGATION"]] = Field(default=None, alias="Name")
149    score: Optional[float] = Field(default=None, alias="Score")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class RxNormConceptModel(mypydantic.models.base_model.BaseModel): View Source

152class RxNormConceptModel(BaseModel):
153    description: Optional[str] = Field(default=None, alias="Description")
154    code: Optional[str] = Field(default=None, alias="Code")
155    score: Optional[float] = Field(default=None, alias="Score")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class SNOMEDCTConceptModel(mypydantic.models.base_model.BaseModel): View Source

158class SNOMEDCTConceptModel(BaseModel):
159    description: Optional[str] = Field(default=None, alias="Description")
160    code: Optional[str] = Field(default=None, alias="Code")
161    score: Optional[float] = Field(default=None, alias="Score")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class SNOMEDCTTraitModel(mypydantic.models.base_model.BaseModel): View Source

164class SNOMEDCTTraitModel(BaseModel):
165    name: Optional[
166        Literal[
167            "DIAGNOSIS",
168            "FUTURE",
169            "HYPOTHETICAL",
170            "LOW_CONFIDENCE",
171            "NEGATION",
172            "PAST_HISTORY",
173            "PERTAINS_TO_FAMILY",
174            "SIGN",
175            "SYMPTOM",
176        ]
177    ] = Field(default=None, alias="Name")
178    score: Optional[float] = Field(default=None, alias="Score")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopEntitiesDetectionV2JobRequestModel(mypydantic.models.base_model.BaseModel): View Source

181class StopEntitiesDetectionV2JobRequestModel(BaseModel):
182    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopICD10CMInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

185class StopICD10CMInferenceJobRequestModel(BaseModel):
186    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopPHIDetectionJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

189class StopPHIDetectionJobRequestModel(BaseModel):
190    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopRxNormInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

193class StopRxNormInferenceJobRequestModel(BaseModel):
194    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopSNOMEDCTInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

197class StopSNOMEDCTInferenceJobRequestModel(BaseModel):
198    job_id: str = Field(alias="JobId")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class AttributeModel(mypydantic.models.base_model.BaseModel): View Source

201class AttributeModel(BaseModel):
202    type: Optional[
203        Literal[
204            "ACUITY",
205            "ADDRESS",
206            "AGE",
207            "ALCOHOL_CONSUMPTION",
208            "ALLERGIES",
209            "AMOUNT",
210            "BRAND_NAME",
211            "CONTACT_POINT",
212            "DATE",
213            "DIRECTION",
214            "DOSAGE",
215            "DURATION",
216            "DX_NAME",
217            "EMAIL",
218            "FORM",
219            "FREQUENCY",
220            "GENDER",
221            "GENERIC_NAME",
222            "ID",
223            "IDENTIFIER",
224            "NAME",
225            "PHONE_OR_FAX",
226            "PROCEDURE_NAME",
227            "PROFESSION",
228            "QUALITY",
229            "QUANTITY",
230            "RACE_ETHNICITY",
231            "RATE",
232            "REC_DRUG_USE",
233            "ROUTE_OR_MODE",
234            "STRENGTH",
235            "SYSTEM_ORGAN_SITE",
236            "TEST_NAME",
237            "TEST_UNIT",
238            "TEST_UNITS",
239            "TEST_VALUE",
240            "TIME_EXPRESSION",
241            "TIME_TO_DX_NAME",
242            "TIME_TO_MEDICATION_NAME",
243            "TIME_TO_PROCEDURE_NAME",
244            "TIME_TO_TEST_NAME",
245            "TIME_TO_TREATMENT_NAME",
246            "TOBACCO_USE",
247            "TREATMENT_NAME",
248            "URL",
249        ]
250    ] = Field(default=None, alias="Type")
251    score: Optional[float] = Field(default=None, alias="Score")
252    relationship_score: Optional[float] = Field(default=None, alias="RelationshipScore")
253    relationship_type: Optional[
254        Literal[
255            "ACUITY",
256            "ADMINISTERED_VIA",
257            "AMOUNT",
258            "DIRECTION",
259            "DOSAGE",
260            "DURATION",
261            "EVERY",
262            "FOR",
263            "FORM",
264            "FREQUENCY",
265            "NEGATIVE",
266            "OVERLAP",
267            "RATE",
268            "ROUTE_OR_MODE",
269            "STRENGTH",
270            "SYSTEM_ORGAN_SITE",
271            "TEST_UNIT",
272            "TEST_UNITS",
273            "TEST_VALUE",
274            "WITH_DOSAGE",
275        ]
276    ] = Field(default=None, alias="RelationshipType")
277    id: Optional[int] = Field(default=None, alias="Id")
278    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
279    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
280    text: Optional[str] = Field(default=None, alias="Text")
281    category: Optional[
282        Literal[
283            "ANATOMY",
284            "BEHAVIORAL_ENVIRONMENTAL_SOCIAL",
285            "MEDICAL_CONDITION",
286            "MEDICATION",
287            "PROTECTED_HEALTH_INFORMATION",
288            "TEST_TREATMENT_PROCEDURE",
289            "TIME_EXPRESSION",
290        ]
291    ] = Field(default=None, alias="Category")
292    traits: Optional[List[TraitModel]] = Field(default=None, alias="Traits")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListEntitiesDetectionV2JobsRequestModel(mypydantic.models.base_model.BaseModel): View Source

295class ListEntitiesDetectionV2JobsRequestModel(BaseModel):
296    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
297        default=None, alias="Filter"
298    )
299    next_token: Optional[str] = Field(default=None, alias="NextToken")
300    max_results: Optional[int] = Field(default=None, alias="MaxResults")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListICD10CMInferenceJobsRequestModel(mypydantic.models.base_model.BaseModel): View Source

303class ListICD10CMInferenceJobsRequestModel(BaseModel):
304    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
305        default=None, alias="Filter"
306    )
307    next_token: Optional[str] = Field(default=None, alias="NextToken")
308    max_results: Optional[int] = Field(default=None, alias="MaxResults")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListPHIDetectionJobsRequestModel(mypydantic.models.base_model.BaseModel): View Source

311class ListPHIDetectionJobsRequestModel(BaseModel):
312    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
313        default=None, alias="Filter"
314    )
315    next_token: Optional[str] = Field(default=None, alias="NextToken")
316    max_results: Optional[int] = Field(default=None, alias="MaxResults")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListRxNormInferenceJobsRequestModel(mypydantic.models.base_model.BaseModel): View Source

319class ListRxNormInferenceJobsRequestModel(BaseModel):
320    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
321        default=None, alias="Filter"
322    )
323    next_token: Optional[str] = Field(default=None, alias="NextToken")
324    max_results: Optional[int] = Field(default=None, alias="MaxResults")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListSNOMEDCTInferenceJobsRequestModel(mypydantic.models.base_model.BaseModel): View Source

327class ListSNOMEDCTInferenceJobsRequestModel(BaseModel):
328    filter: Optional[ComprehendMedicalAsyncJobFilterModel] = Field(
329        default=None, alias="Filter"
330    )
331    next_token: Optional[str] = Field(default=None, alias="NextToken")
332    max_results: Optional[int] = Field(default=None, alias="MaxResults")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ComprehendMedicalAsyncJobPropertiesModel(mypydantic.models.base_model.BaseModel): View Source

335class ComprehendMedicalAsyncJobPropertiesModel(BaseModel):
336    job_id: Optional[str] = Field(default=None, alias="JobId")
337    job_name: Optional[str] = Field(default=None, alias="JobName")
338    job_status: Optional[
339        Literal[
340            "COMPLETED",
341            "FAILED",
342            "IN_PROGRESS",
343            "PARTIAL_SUCCESS",
344            "STOPPED",
345            "STOP_REQUESTED",
346            "SUBMITTED",
347        ]
348    ] = Field(default=None, alias="JobStatus")
349    message: Optional[str] = Field(default=None, alias="Message")
350    submit_time: Optional[datetime] = Field(default=None, alias="SubmitTime")
351    end_time: Optional[datetime] = Field(default=None, alias="EndTime")
352    expiration_time: Optional[datetime] = Field(default=None, alias="ExpirationTime")
353    input_data_config: Optional[InputDataConfigModel] = Field(
354        default=None, alias="InputDataConfig"
355    )
356    output_data_config: Optional[OutputDataConfigModel] = Field(
357        default=None, alias="OutputDataConfig"
358    )
359    language_code: Optional[Literal["en"]] = Field(default=None, alias="LanguageCode")
360    data_access_role_arn: Optional[str] = Field(default=None, alias="DataAccessRoleArn")
361    manifest_file_path: Optional[str] = Field(default=None, alias="ManifestFilePath")
362    kms_key: Optional[str] = Field(default=None, alias="KMSKey")
363    model_version: Optional[str] = Field(default=None, alias="ModelVersion")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartEntitiesDetectionV2JobRequestModel(mypydantic.models.base_model.BaseModel): View Source

366class StartEntitiesDetectionV2JobRequestModel(BaseModel):
367    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
368    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
369    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
370    language_code: Literal["en"] = Field(alias="LanguageCode")
371    job_name: Optional[str] = Field(default=None, alias="JobName")
372    client_request_token: Optional[str] = Field(
373        default=None, alias="ClientRequestToken"
374    )
375    kms_key: Optional[str] = Field(default=None, alias="KMSKey")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartICD10CMInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

378class StartICD10CMInferenceJobRequestModel(BaseModel):
379    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
380    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
381    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
382    language_code: Literal["en"] = Field(alias="LanguageCode")
383    job_name: Optional[str] = Field(default=None, alias="JobName")
384    client_request_token: Optional[str] = Field(
385        default=None, alias="ClientRequestToken"
386    )
387    kms_key: Optional[str] = Field(default=None, alias="KMSKey")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartPHIDetectionJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

390class StartPHIDetectionJobRequestModel(BaseModel):
391    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
392    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
393    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
394    language_code: Literal["en"] = Field(alias="LanguageCode")
395    job_name: Optional[str] = Field(default=None, alias="JobName")
396    client_request_token: Optional[str] = Field(
397        default=None, alias="ClientRequestToken"
398    )
399    kms_key: Optional[str] = Field(default=None, alias="KMSKey")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartRxNormInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

402class StartRxNormInferenceJobRequestModel(BaseModel):
403    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
404    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
405    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
406    language_code: Literal["en"] = Field(alias="LanguageCode")
407    job_name: Optional[str] = Field(default=None, alias="JobName")
408    client_request_token: Optional[str] = Field(
409        default=None, alias="ClientRequestToken"
410    )
411    kms_key: Optional[str] = Field(default=None, alias="KMSKey")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartSNOMEDCTInferenceJobRequestModel(mypydantic.models.base_model.BaseModel): View Source

414class StartSNOMEDCTInferenceJobRequestModel(BaseModel):
415    input_data_config: InputDataConfigModel = Field(alias="InputDataConfig")
416    output_data_config: OutputDataConfigModel = Field(alias="OutputDataConfig")
417    data_access_role_arn: str = Field(alias="DataAccessRoleArn")
418    language_code: Literal["en"] = Field(alias="LanguageCode")
419    job_name: Optional[str] = Field(default=None, alias="JobName")
420    client_request_token: Optional[str] = Field(
421        default=None, alias="ClientRequestToken"
422    )
423    kms_key: Optional[str] = Field(default=None, alias="KMSKey")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartEntitiesDetectionV2JobResponseModel(mypydantic.models.base_model.BaseModel): View Source

426class StartEntitiesDetectionV2JobResponseModel(BaseModel):
427    job_id: str = Field(alias="JobId")
428    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartICD10CMInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

431class StartICD10CMInferenceJobResponseModel(BaseModel):
432    job_id: str = Field(alias="JobId")
433    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartPHIDetectionJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

436class StartPHIDetectionJobResponseModel(BaseModel):
437    job_id: str = Field(alias="JobId")
438    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartRxNormInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

441class StartRxNormInferenceJobResponseModel(BaseModel):
442    job_id: str = Field(alias="JobId")
443    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StartSNOMEDCTInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

446class StartSNOMEDCTInferenceJobResponseModel(BaseModel):
447    job_id: str = Field(alias="JobId")
448    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopEntitiesDetectionV2JobResponseModel(mypydantic.models.base_model.BaseModel): View Source

451class StopEntitiesDetectionV2JobResponseModel(BaseModel):
452    job_id: str = Field(alias="JobId")
453    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopICD10CMInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

456class StopICD10CMInferenceJobResponseModel(BaseModel):
457    job_id: str = Field(alias="JobId")
458    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopPHIDetectionJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

461class StopPHIDetectionJobResponseModel(BaseModel):
462    job_id: str = Field(alias="JobId")
463    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopRxNormInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

466class StopRxNormInferenceJobResponseModel(BaseModel):
467    job_id: str = Field(alias="JobId")
468    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class StopSNOMEDCTInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

471class StopSNOMEDCTInferenceJobResponseModel(BaseModel):
472    job_id: str = Field(alias="JobId")
473    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ICD10CMAttributeModel(mypydantic.models.base_model.BaseModel): View Source

476class ICD10CMAttributeModel(BaseModel):
477    type: Optional[
478        Literal[
479            "ACUITY",
480            "DIRECTION",
481            "QUALITY",
482            "QUANTITY",
483            "SYSTEM_ORGAN_SITE",
484            "TIME_EXPRESSION",
485            "TIME_TO_DX_NAME",
486        ]
487    ] = Field(default=None, alias="Type")
488    score: Optional[float] = Field(default=None, alias="Score")
489    relationship_score: Optional[float] = Field(default=None, alias="RelationshipScore")
490    id: Optional[int] = Field(default=None, alias="Id")
491    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
492    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
493    text: Optional[str] = Field(default=None, alias="Text")
494    traits: Optional[List[ICD10CMTraitModel]] = Field(default=None, alias="Traits")
495    category: Optional[Literal["DX_NAME", "TIME_EXPRESSION"]] = Field(
496        default=None, alias="Category"
497    )
498    relationship_type: Optional[Literal["OVERLAP", "SYSTEM_ORGAN_SITE"]] = Field(
499        default=None, alias="RelationshipType"
500    )

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class RxNormAttributeModel(mypydantic.models.base_model.BaseModel): View Source

503class RxNormAttributeModel(BaseModel):
504    type: Optional[
505        Literal[
506            "DOSAGE",
507            "DURATION",
508            "FORM",
509            "FREQUENCY",
510            "RATE",
511            "ROUTE_OR_MODE",
512            "STRENGTH",
513        ]
514    ] = Field(default=None, alias="Type")
515    score: Optional[float] = Field(default=None, alias="Score")
516    relationship_score: Optional[float] = Field(default=None, alias="RelationshipScore")
517    id: Optional[int] = Field(default=None, alias="Id")
518    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
519    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
520    text: Optional[str] = Field(default=None, alias="Text")
521    traits: Optional[List[RxNormTraitModel]] = Field(default=None, alias="Traits")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class SNOMEDCTAttributeModel(mypydantic.models.base_model.BaseModel): View Source

524class SNOMEDCTAttributeModel(BaseModel):
525    category: Optional[
526        Literal["ANATOMY", "MEDICAL_CONDITION", "TEST_TREATMENT_PROCEDURE"]
527    ] = Field(default=None, alias="Category")
528    type: Optional[
529        Literal[
530            "ACUITY",
531            "DIRECTION",
532            "QUALITY",
533            "SYSTEM_ORGAN_SITE",
534            "TEST_UNIT",
535            "TEST_VALUE",
536        ]
537    ] = Field(default=None, alias="Type")
538    score: Optional[float] = Field(default=None, alias="Score")
539    relationship_score: Optional[float] = Field(default=None, alias="RelationshipScore")
540    relationship_type: Optional[
541        Literal[
542            "ACUITY",
543            "DIRECTION",
544            "QUALITY",
545            "SYSTEM_ORGAN_SITE",
546            "TEST_UNITS",
547            "TEST_VALUE",
548        ]
549    ] = Field(default=None, alias="RelationshipType")
550    id: Optional[int] = Field(default=None, alias="Id")
551    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
552    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
553    text: Optional[str] = Field(default=None, alias="Text")
554    traits: Optional[List[SNOMEDCTTraitModel]] = Field(default=None, alias="Traits")
555    s_nomedctconcepts: Optional[List[SNOMEDCTConceptModel]] = Field(
556        default=None, alias="SNOMEDCTConcepts"
557    )

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class EntityModel(mypydantic.models.base_model.BaseModel): View Source

560class EntityModel(BaseModel):
561    id: Optional[int] = Field(default=None, alias="Id")
562    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
563    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
564    score: Optional[float] = Field(default=None, alias="Score")
565    text: Optional[str] = Field(default=None, alias="Text")
566    category: Optional[
567        Literal[
568            "ANATOMY",
569            "BEHAVIORAL_ENVIRONMENTAL_SOCIAL",
570            "MEDICAL_CONDITION",
571            "MEDICATION",
572            "PROTECTED_HEALTH_INFORMATION",
573            "TEST_TREATMENT_PROCEDURE",
574            "TIME_EXPRESSION",
575        ]
576    ] = Field(default=None, alias="Category")
577    type: Optional[
578        Literal[
579            "ACUITY",
580            "ADDRESS",
581            "AGE",
582            "ALCOHOL_CONSUMPTION",
583            "ALLERGIES",
584            "AMOUNT",
585            "BRAND_NAME",
586            "CONTACT_POINT",
587            "DATE",
588            "DIRECTION",
589            "DOSAGE",
590            "DURATION",
591            "DX_NAME",
592            "EMAIL",
593            "FORM",
594            "FREQUENCY",
595            "GENDER",
596            "GENERIC_NAME",
597            "ID",
598            "IDENTIFIER",
599            "NAME",
600            "PHONE_OR_FAX",
601            "PROCEDURE_NAME",
602            "PROFESSION",
603            "QUALITY",
604            "QUANTITY",
605            "RACE_ETHNICITY",
606            "RATE",
607            "REC_DRUG_USE",
608            "ROUTE_OR_MODE",
609            "STRENGTH",
610            "SYSTEM_ORGAN_SITE",
611            "TEST_NAME",
612            "TEST_UNIT",
613            "TEST_UNITS",
614            "TEST_VALUE",
615            "TIME_EXPRESSION",
616            "TIME_TO_DX_NAME",
617            "TIME_TO_MEDICATION_NAME",
618            "TIME_TO_PROCEDURE_NAME",
619            "TIME_TO_TEST_NAME",
620            "TIME_TO_TREATMENT_NAME",
621            "TOBACCO_USE",
622            "TREATMENT_NAME",
623            "URL",
624        ]
625    ] = Field(default=None, alias="Type")
626    traits: Optional[List[TraitModel]] = Field(default=None, alias="Traits")
627    attributes: Optional[List[AttributeModel]] = Field(default=None, alias="Attributes")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class UnmappedAttributeModel(mypydantic.models.base_model.BaseModel): View Source

630class UnmappedAttributeModel(BaseModel):
631    type: Optional[
632        Literal[
633            "ANATOMY",
634            "BEHAVIORAL_ENVIRONMENTAL_SOCIAL",
635            "MEDICAL_CONDITION",
636            "MEDICATION",
637            "PROTECTED_HEALTH_INFORMATION",
638            "TEST_TREATMENT_PROCEDURE",
639            "TIME_EXPRESSION",
640        ]
641    ] = Field(default=None, alias="Type")
642    attribute: Optional[AttributeModel] = Field(default=None, alias="Attribute")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribeEntitiesDetectionV2JobResponseModel(mypydantic.models.base_model.BaseModel): View Source

645class DescribeEntitiesDetectionV2JobResponseModel(BaseModel):
646    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
647        alias="ComprehendMedicalAsyncJobProperties"
648    )
649    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribeICD10CMInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

652class DescribeICD10CMInferenceJobResponseModel(BaseModel):
653    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
654        alias="ComprehendMedicalAsyncJobProperties"
655    )
656    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribePHIDetectionJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

659class DescribePHIDetectionJobResponseModel(BaseModel):
660    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
661        alias="ComprehendMedicalAsyncJobProperties"
662    )
663    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribeRxNormInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

666class DescribeRxNormInferenceJobResponseModel(BaseModel):
667    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
668        alias="ComprehendMedicalAsyncJobProperties"
669    )
670    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DescribeSNOMEDCTInferenceJobResponseModel(mypydantic.models.base_model.BaseModel): View Source

673class DescribeSNOMEDCTInferenceJobResponseModel(BaseModel):
674    comprehend_medical_async_job_properties: ComprehendMedicalAsyncJobPropertiesModel = Field(
675        alias="ComprehendMedicalAsyncJobProperties"
676    )
677    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListEntitiesDetectionV2JobsResponseModel(mypydantic.models.base_model.BaseModel): View Source

680class ListEntitiesDetectionV2JobsResponseModel(BaseModel):
681    comprehend_medical_async_job_properties_list: List[
682        ComprehendMedicalAsyncJobPropertiesModel
683    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
684    next_token: str = Field(alias="NextToken")
685    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListICD10CMInferenceJobsResponseModel(mypydantic.models.base_model.BaseModel): View Source

688class ListICD10CMInferenceJobsResponseModel(BaseModel):
689    comprehend_medical_async_job_properties_list: List[
690        ComprehendMedicalAsyncJobPropertiesModel
691    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
692    next_token: str = Field(alias="NextToken")
693    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListPHIDetectionJobsResponseModel(mypydantic.models.base_model.BaseModel): View Source

696class ListPHIDetectionJobsResponseModel(BaseModel):
697    comprehend_medical_async_job_properties_list: List[
698        ComprehendMedicalAsyncJobPropertiesModel
699    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
700    next_token: str = Field(alias="NextToken")
701    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListRxNormInferenceJobsResponseModel(mypydantic.models.base_model.BaseModel): View Source

704class ListRxNormInferenceJobsResponseModel(BaseModel):
705    comprehend_medical_async_job_properties_list: List[
706        ComprehendMedicalAsyncJobPropertiesModel
707    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
708    next_token: str = Field(alias="NextToken")
709    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ListSNOMEDCTInferenceJobsResponseModel(mypydantic.models.base_model.BaseModel): View Source

712class ListSNOMEDCTInferenceJobsResponseModel(BaseModel):
713    comprehend_medical_async_job_properties_list: List[
714        ComprehendMedicalAsyncJobPropertiesModel
715    ] = Field(alias="ComprehendMedicalAsyncJobPropertiesList")
716    next_token: str = Field(alias="NextToken")
717    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class ICD10CMEntityModel(mypydantic.models.base_model.BaseModel): View Source

720class ICD10CMEntityModel(BaseModel):
721    id: Optional[int] = Field(default=None, alias="Id")
722    text: Optional[str] = Field(default=None, alias="Text")
723    category: Optional[Literal["MEDICAL_CONDITION"]] = Field(
724        default=None, alias="Category"
725    )
726    type: Optional[Literal["DX_NAME", "TIME_EXPRESSION"]] = Field(
727        default=None, alias="Type"
728    )
729    score: Optional[float] = Field(default=None, alias="Score")
730    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
731    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
732    attributes: Optional[List[ICD10CMAttributeModel]] = Field(
733        default=None, alias="Attributes"
734    )
735    traits: Optional[List[ICD10CMTraitModel]] = Field(default=None, alias="Traits")
736    icd10_cmconcepts: Optional[List[ICD10CMConceptModel]] = Field(
737        default=None, alias="ICD10CMConcepts"
738    )

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class RxNormEntityModel(mypydantic.models.base_model.BaseModel): View Source

741class RxNormEntityModel(BaseModel):
742    id: Optional[int] = Field(default=None, alias="Id")
743    text: Optional[str] = Field(default=None, alias="Text")
744    category: Optional[Literal["MEDICATION"]] = Field(default=None, alias="Category")
745    type: Optional[Literal["BRAND_NAME", "GENERIC_NAME"]] = Field(
746        default=None, alias="Type"
747    )
748    score: Optional[float] = Field(default=None, alias="Score")
749    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
750    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
751    attributes: Optional[List[RxNormAttributeModel]] = Field(
752        default=None, alias="Attributes"
753    )
754    traits: Optional[List[RxNormTraitModel]] = Field(default=None, alias="Traits")
755    rx_norm_concepts: Optional[List[RxNormConceptModel]] = Field(
756        default=None, alias="RxNormConcepts"
757    )

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class SNOMEDCTEntityModel(mypydantic.models.base_model.BaseModel): View Source

760class SNOMEDCTEntityModel(BaseModel):
761    id: Optional[int] = Field(default=None, alias="Id")
762    text: Optional[str] = Field(default=None, alias="Text")
763    category: Optional[
764        Literal["ANATOMY", "MEDICAL_CONDITION", "TEST_TREATMENT_PROCEDURE"]
765    ] = Field(default=None, alias="Category")
766    type: Optional[
767        Literal["DX_NAME", "PROCEDURE_NAME", "TEST_NAME", "TREATMENT_NAME"]
768    ] = Field(default=None, alias="Type")
769    score: Optional[float] = Field(default=None, alias="Score")
770    begin_offset: Optional[int] = Field(default=None, alias="BeginOffset")
771    end_offset: Optional[int] = Field(default=None, alias="EndOffset")
772    attributes: Optional[List[SNOMEDCTAttributeModel]] = Field(
773        default=None, alias="Attributes"
774    )
775    traits: Optional[List[SNOMEDCTTraitModel]] = Field(default=None, alias="Traits")
776    s_nomedctconcepts: Optional[List[SNOMEDCTConceptModel]] = Field(
777        default=None, alias="SNOMEDCTConcepts"
778    )

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DetectPHIResponseModel(mypydantic.models.base_model.BaseModel): View Source

781class DetectPHIResponseModel(BaseModel):
782    entities: List[EntityModel] = Field(alias="Entities")
783    pagination_token: str = Field(alias="PaginationToken")
784    model_version: str = Field(alias="ModelVersion")
785    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DetectEntitiesResponseModel(mypydantic.models.base_model.BaseModel): View Source

788class DetectEntitiesResponseModel(BaseModel):
789    entities: List[EntityModel] = Field(alias="Entities")
790    unmapped_attributes: List[UnmappedAttributeModel] = Field(
791        alias="UnmappedAttributes"
792    )
793    pagination_token: str = Field(alias="PaginationToken")
794    model_version: str = Field(alias="ModelVersion")
795    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class DetectEntitiesV2ResponseModel(mypydantic.models.base_model.BaseModel): View Source

798class DetectEntitiesV2ResponseModel(BaseModel):
799    entities: List[EntityModel] = Field(alias="Entities")
800    unmapped_attributes: List[UnmappedAttributeModel] = Field(
801        alias="UnmappedAttributes"
802    )
803    pagination_token: str = Field(alias="PaginationToken")
804    model_version: str = Field(alias="ModelVersion")
805    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class InferICD10CMResponseModel(mypydantic.models.base_model.BaseModel): View Source

808class InferICD10CMResponseModel(BaseModel):
809    entities: List[ICD10CMEntityModel] = Field(alias="Entities")
810    pagination_token: str = Field(alias="PaginationToken")
811    model_version: str = Field(alias="ModelVersion")
812    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class InferRxNormResponseModel(mypydantic.models.base_model.BaseModel): View Source

815class InferRxNormResponseModel(BaseModel):
816    entities: List[RxNormEntityModel] = Field(alias="Entities")
817    pagination_token: str = Field(alias="PaginationToken")
818    model_version: str = Field(alias="ModelVersion")
819    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs

class InferSNOMEDCTResponseModel(mypydantic.models.base_model.BaseModel): View Source

822class InferSNOMEDCTResponseModel(BaseModel):
823    entities: List[SNOMEDCTEntityModel] = Field(alias="Entities")
824    pagination_token: str = Field(alias="PaginationToken")
825    model_version: str = Field(alias="ModelVersion")
826    s_nomedctdetails: SNOMEDCTDetailsModel = Field(alias="SNOMEDCTDetails")
827    characters: CharactersModel = Field(alias="Characters")
828    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")

Inherited Members

mypydantic.models.base_model.BaseModel: BaseModel; Config
pydantic.main.BaseModel: dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs