trialmap 0.1.0__py3-none-any.whl

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.
@@ -0,0 +1,1140 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ """TypedDicts for the raw JSON returned by the ClinicalTrials.gov v2 API.
3
+
4
+ Every key is optional (``total=False``): the API omits empty fields, and the
5
+ ``fields`` parameter can drop any of them.
6
+
7
+ GENERATED by tools/gen_from_spec.py from the ClinicalTrials.gov OpenAPI spec (API 2.0.5).
8
+ Do not edit by hand.
9
+ """
10
+
11
+ from __future__ import annotations
12
+
13
+ from typing import Any, Literal, TypedDict
14
+
15
+ AgencyClassValue = Literal[
16
+ "NIH", "FED", "OTHER_GOV", "INDIV", "INDUSTRY", "NETWORK", "AMBIG", "OTHER", "UNKNOWN"
17
+ ]
18
+ AgreementRestrictionTypeValue = Literal["LTE60", "GT60", "OTHER"]
19
+ AnalysisDispersionTypeValue = Literal["STANDARD_DEVIATION", "STANDARD_ERROR_OF_MEAN"]
20
+ ArmGroupTypeValue = Literal[
21
+ "EXPERIMENTAL",
22
+ "ACTIVE_COMPARATOR",
23
+ "PLACEBO_COMPARATOR",
24
+ "SHAM_COMPARATOR",
25
+ "NO_INTERVENTION",
26
+ "OTHER",
27
+ ]
28
+ BioSpecRetentionValue = Literal["NONE_RETAINED", "SAMPLES_WITH_DNA", "SAMPLES_WITHOUT_DNA"]
29
+ BrowseLeafRelevanceValue = Literal["LOW", "HIGH"]
30
+ ConfidenceIntervalNumSidesValue = Literal["ONE_SIDED", "TWO_SIDED"]
31
+ ContactRoleValue = Literal[
32
+ "STUDY_CHAIR", "STUDY_DIRECTOR", "PRINCIPAL_INVESTIGATOR", "SUB_INVESTIGATOR", "CONTACT"
33
+ ]
34
+ DateTypeValue = Literal["ACTUAL", "ESTIMATED"]
35
+ DesignAllocationValue = Literal["RANDOMIZED", "NON_RANDOMIZED", "NA"]
36
+ DesignMaskingValue = Literal["NONE", "SINGLE", "DOUBLE", "TRIPLE", "QUADRUPLE"]
37
+ DesignTimePerspectiveValue = Literal["RETROSPECTIVE", "PROSPECTIVE", "CROSS_SECTIONAL", "OTHER"]
38
+ EnrollmentTypeValue = Literal["ACTUAL", "ESTIMATED"]
39
+ EventAssessmentValue = Literal["NON_SYSTEMATIC_ASSESSMENT", "SYSTEMATIC_ASSESSMENT"]
40
+ ExpandedAccessStatusValue = Literal[
41
+ "AVAILABLE", "NO_LONGER_AVAILABLE", "TEMPORARILY_NOT_AVAILABLE", "APPROVED_FOR_MARKETING"
42
+ ]
43
+ FieldStatsTypeValue = Literal["ENUM", "STRING", "DATE", "INTEGER", "NUMBER", "BOOLEAN"]
44
+ InterventionTypeValue = Literal[
45
+ "BEHAVIORAL",
46
+ "BIOLOGICAL",
47
+ "COMBINATION_PRODUCT",
48
+ "DEVICE",
49
+ "DIAGNOSTIC_TEST",
50
+ "DIETARY_SUPPLEMENT",
51
+ "DRUG",
52
+ "GENETIC",
53
+ "PROCEDURE",
54
+ "RADIATION",
55
+ "OTHER",
56
+ ]
57
+ InterventionalAssignmentValue = Literal[
58
+ "SINGLE_GROUP", "PARALLEL", "CROSSOVER", "FACTORIAL", "SEQUENTIAL"
59
+ ]
60
+ IpdSharingValue = Literal["YES", "NO", "UNDECIDED"]
61
+ IpdSharingInfoTypeValue = Literal["STUDY_PROTOCOL", "SAP", "ICF", "CSR", "ANALYTIC_CODE"]
62
+ MeasureDispersionTypeValue = Literal[
63
+ "NA",
64
+ "STANDARD_DEVIATION",
65
+ "STANDARD_ERROR",
66
+ "INTER_QUARTILE_RANGE",
67
+ "FULL_RANGE",
68
+ "CONFIDENCE_80",
69
+ "CONFIDENCE_90",
70
+ "CONFIDENCE_95",
71
+ "CONFIDENCE_975",
72
+ "CONFIDENCE_99",
73
+ "CONFIDENCE_OTHER",
74
+ "GEOMETRIC_COEFFICIENT",
75
+ ]
76
+ MeasureParamValue = Literal[
77
+ "GEOMETRIC_MEAN",
78
+ "GEOMETRIC_LEAST_SQUARES_MEAN",
79
+ "LEAST_SQUARES_MEAN",
80
+ "LOG_MEAN",
81
+ "MEAN",
82
+ "MEDIAN",
83
+ "NUMBER",
84
+ "COUNT_OF_PARTICIPANTS",
85
+ "COUNT_OF_UNITS",
86
+ ]
87
+ NonInferiorityTypeValue = Literal[
88
+ "SUPERIORITY",
89
+ "NON_INFERIORITY",
90
+ "EQUIVALENCE",
91
+ "OTHER",
92
+ "NON_INFERIORITY_OR_EQUIVALENCE",
93
+ "SUPERIORITY_OR_OTHER",
94
+ "NON_INFERIORITY_OR_EQUIVALENCE_LEGACY",
95
+ "SUPERIORITY_OR_OTHER_LEGACY",
96
+ ]
97
+ ObservationalModelValue = Literal[
98
+ "COHORT",
99
+ "CASE_CONTROL",
100
+ "CASE_ONLY",
101
+ "CASE_CROSSOVER",
102
+ "ECOLOGIC_OR_COMMUNITY",
103
+ "FAMILY_BASED",
104
+ "DEFINED_POPULATION",
105
+ "NATURAL_HISTORY",
106
+ "OTHER",
107
+ ]
108
+ OfficialRoleValue = Literal[
109
+ "STUDY_CHAIR", "STUDY_DIRECTOR", "PRINCIPAL_INVESTIGATOR", "SUB_INVESTIGATOR"
110
+ ]
111
+ OrgStudyIdTypeValue = Literal["NIH", "FDA", "VA", "CDC", "AHRQ", "SAMHSA"]
112
+ OutcomeMeasureTypeValue = Literal["PRIMARY", "SECONDARY", "OTHER_PRE_SPECIFIED", "POST_HOC"]
113
+ PhaseValue = Literal["NA", "EARLY_PHASE1", "PHASE1", "PHASE2", "PHASE3", "PHASE4"]
114
+ PrimaryPurposeValue = Literal[
115
+ "TREATMENT",
116
+ "PREVENTION",
117
+ "DIAGNOSTIC",
118
+ "ECT",
119
+ "SUPPORTIVE_CARE",
120
+ "SCREENING",
121
+ "HEALTH_SERVICES_RESEARCH",
122
+ "BASIC_SCIENCE",
123
+ "DEVICE_FEASIBILITY",
124
+ "OTHER",
125
+ ]
126
+ RecruitmentStatusValue = Literal[
127
+ "ACTIVE_NOT_RECRUITING",
128
+ "COMPLETED",
129
+ "ENROLLING_BY_INVITATION",
130
+ "NOT_YET_RECRUITING",
131
+ "RECRUITING",
132
+ "SUSPENDED",
133
+ "TERMINATED",
134
+ "WITHDRAWN",
135
+ "AVAILABLE",
136
+ ]
137
+ ReferenceTypeValue = Literal["BACKGROUND", "RESULT", "DERIVED"]
138
+ ReportingStatusValue = Literal["NOT_POSTED", "POSTED"]
139
+ ResponsiblePartyTypeValue = Literal["SPONSOR", "PRINCIPAL_INVESTIGATOR", "SPONSOR_INVESTIGATOR"]
140
+ SamplingMethodValue = Literal["PROBABILITY_SAMPLE", "NON_PROBABILITY_SAMPLE"]
141
+ SecondaryIdTypeValue = Literal[
142
+ "NIH",
143
+ "FDA",
144
+ "VA",
145
+ "CDC",
146
+ "AHRQ",
147
+ "SAMHSA",
148
+ "OTHER_GRANT",
149
+ "EUDRACT_NUMBER",
150
+ "CTIS",
151
+ "REGISTRY",
152
+ "OTHER",
153
+ ]
154
+ SexValue = Literal["FEMALE", "MALE", "ALL"]
155
+ StandardAgeValue = Literal["CHILD", "ADULT", "OLDER_ADULT"]
156
+ StatusValue = Literal[
157
+ "ACTIVE_NOT_RECRUITING",
158
+ "COMPLETED",
159
+ "ENROLLING_BY_INVITATION",
160
+ "NOT_YET_RECRUITING",
161
+ "RECRUITING",
162
+ "SUSPENDED",
163
+ "TERMINATED",
164
+ "WITHDRAWN",
165
+ "AVAILABLE",
166
+ "NO_LONGER_AVAILABLE",
167
+ "TEMPORARILY_NOT_AVAILABLE",
168
+ "APPROVED_FOR_MARKETING",
169
+ "WITHHELD",
170
+ "UNKNOWN",
171
+ ]
172
+ StudyTypeValue = Literal["EXPANDED_ACCESS", "INTERVENTIONAL", "OBSERVATIONAL"]
173
+ UnpostedEventTypeValue = Literal["RESET", "RELEASE", "UNRELEASE"]
174
+ ViolationEventTypeValue = Literal[
175
+ "VIOLATION_IDENTIFIED",
176
+ "CORRECTION_CONFIRMED",
177
+ "PENALTY_IMPOSED",
178
+ "ISSUES_IN_LETTER_ADDRESSED_CONFIRMED",
179
+ ]
180
+ WhoMaskedValue = Literal["PARTICIPANT", "CARE_PROVIDER", "INVESTIGATOR", "OUTCOMES_ASSESSOR"]
181
+
182
+
183
+ class AdverseEventDict(TypedDict, total=False):
184
+ term: str
185
+ organSystem: str
186
+ sourceVocabulary: str
187
+ assessmentType: EventAssessmentValue
188
+ notes: str
189
+ stats: list[EventStatsDict]
190
+
191
+
192
+ class AdverseEventsModuleDict(TypedDict, total=False):
193
+ frequencyThreshold: str
194
+ timeFrame: str
195
+ description: str
196
+ allCauseMortalityComment: str
197
+ eventGroups: list[EventGroupDict]
198
+ seriousEvents: list[AdverseEventDict]
199
+ otherEvents: list[AdverseEventDict]
200
+
201
+
202
+ class AnnotationModuleDict(TypedDict, total=False):
203
+ unpostedAnnotation: UnpostedAnnotationDict
204
+ violationAnnotation: ViolationAnnotationDict
205
+
206
+
207
+ class AnnotationSectionDict(TypedDict, total=False):
208
+ annotationModule: AnnotationModuleDict
209
+
210
+
211
+ class ArmGroupDict(TypedDict, total=False):
212
+ label: str
213
+ type: ArmGroupTypeValue
214
+ description: str
215
+ interventionNames: list[str]
216
+
217
+
218
+ class ArmsInterventionsModuleDict(TypedDict, total=False):
219
+ armGroups: list[ArmGroupDict]
220
+ interventions: list[InterventionDict]
221
+
222
+
223
+ class AvailIpdDict(TypedDict, total=False):
224
+ id: str
225
+ type: str
226
+ url: str
227
+ comment: str
228
+
229
+
230
+ class BaselineCharacteristicsModuleDict(TypedDict, total=False):
231
+ populationDescription: str
232
+ typeUnitsAnalyzed: str
233
+ groups: list[MeasureGroupDict]
234
+ denoms: list[DenomDict]
235
+ measures: list[BaselineMeasureDict]
236
+
237
+
238
+ class BaselineMeasureDict(TypedDict, total=False):
239
+ title: str
240
+ description: str
241
+ populationDescription: str
242
+ paramType: MeasureParamValue
243
+ dispersionType: MeasureDispersionTypeValue
244
+ unitOfMeasure: str
245
+ calculatePct: bool
246
+ denomUnitsSelected: str
247
+ denoms: list[DenomDict]
248
+ classes: list[MeasureClassDict]
249
+
250
+
251
+ class BioSpecDict(TypedDict, total=False):
252
+ retention: BioSpecRetentionValue
253
+ description: str
254
+
255
+
256
+ class BooleanStatsDict(TypedDict, total=False):
257
+ falseCount: int
258
+ field: str
259
+ missingStudiesCount: int
260
+ piece: str
261
+ trueCount: int
262
+ type: FieldStatsTypeValue
263
+
264
+
265
+ class BrowseBranchDict(TypedDict, total=False):
266
+ abbrev: str
267
+ name: str
268
+
269
+
270
+ class BrowseLeafDict(TypedDict, total=False):
271
+ id: str
272
+ name: str
273
+ asFound: str
274
+ relevance: BrowseLeafRelevanceValue
275
+
276
+
277
+ class BrowseModuleDict(TypedDict, total=False):
278
+ meshes: list[MeshDict]
279
+ ancestors: list[MeshDict]
280
+ browseLeaves: list[BrowseLeafDict]
281
+ browseBranches: list[BrowseBranchDict]
282
+
283
+
284
+ class CertainAgreementDict(TypedDict, total=False):
285
+ piSponsorEmployee: bool
286
+ restrictionType: AgreementRestrictionTypeValue
287
+ restrictiveAgreement: bool
288
+ otherDetails: str
289
+
290
+
291
+ class ConditionsModuleDict(TypedDict, total=False):
292
+ conditions: list[str]
293
+ keywords: list[str]
294
+
295
+
296
+ class ContactDict(TypedDict, total=False):
297
+ name: str
298
+ role: ContactRoleValue
299
+ phone: str
300
+ phoneExt: str
301
+ email: str
302
+
303
+
304
+ class ContactsLocationsModuleDict(TypedDict, total=False):
305
+ centralContacts: list[ContactDict]
306
+ overallOfficials: list[OfficialDict]
307
+ locations: list[LocationDict]
308
+
309
+
310
+ class DateStatsDict(TypedDict, total=False):
311
+ field: str
312
+ formats: list[str]
313
+ max: str
314
+ min: str
315
+ missingStudiesCount: int
316
+ piece: str
317
+ type: FieldStatsTypeValue
318
+
319
+
320
+ class DateStructDict(TypedDict, total=False):
321
+ date: str
322
+ type: DateTypeValue
323
+
324
+
325
+ class DenomDict(TypedDict, total=False):
326
+ units: str
327
+ counts: list[DenomCountDict]
328
+
329
+
330
+ class DenomCountDict(TypedDict, total=False):
331
+ groupId: str
332
+ value: str
333
+
334
+
335
+ class DerivedSectionDict(TypedDict, total=False):
336
+ miscInfoModule: MiscInfoModuleDict
337
+ conditionBrowseModule: BrowseModuleDict
338
+ interventionBrowseModule: BrowseModuleDict
339
+
340
+
341
+ class DescriptionModuleDict(TypedDict, total=False):
342
+ briefSummary: str
343
+ detailedDescription: str
344
+
345
+
346
+ class DesignInfoDict(TypedDict, total=False):
347
+ allocation: DesignAllocationValue
348
+ interventionModel: InterventionalAssignmentValue
349
+ interventionModelDescription: str
350
+ primaryPurpose: PrimaryPurposeValue
351
+ observationalModel: ObservationalModelValue
352
+ timePerspective: DesignTimePerspectiveValue
353
+ maskingInfo: MaskingBlockDict
354
+
355
+
356
+ class DesignModuleDict(TypedDict, total=False):
357
+ studyType: StudyTypeValue
358
+ nPtrsToThisExpAccNctId: int
359
+ expandedAccessTypes: ExpandedAccessTypesDict
360
+ patientRegistry: bool
361
+ targetDuration: str
362
+ phases: list[PhaseValue]
363
+ designInfo: DesignInfoDict
364
+ bioSpec: BioSpecDict
365
+ enrollmentInfo: EnrollmentInfoDict
366
+
367
+
368
+ class DistItemDict(TypedDict, total=False):
369
+ sizeRange: str
370
+ studiesCount: int
371
+
372
+
373
+ class DocumentSectionDict(TypedDict, total=False):
374
+ largeDocumentModule: LargeDocumentModuleDict
375
+
376
+
377
+ class DropWithdrawDict(TypedDict, total=False):
378
+ type: str
379
+ comment: str
380
+ reasons: list[FlowStatsDict]
381
+
382
+
383
+ class EligibilityModuleDict(TypedDict, total=False):
384
+ eligibilityCriteria: str
385
+ healthyVolunteers: bool
386
+ sex: SexValue
387
+ genderBased: bool
388
+ genderDescription: str
389
+ minimumAge: str
390
+ maximumAge: str
391
+ stdAges: list[StandardAgeValue]
392
+ studyPopulation: str
393
+ samplingMethod: SamplingMethodValue
394
+
395
+
396
+ class EnrollmentInfoDict(TypedDict, total=False):
397
+ count: int
398
+ type: EnrollmentTypeValue
399
+
400
+
401
+ class EnumInfoDict(TypedDict, total=False):
402
+ pieces: list[str]
403
+ type: str
404
+ values: list[EnumItemDict]
405
+
406
+
407
+ class EnumItemDict(TypedDict, total=False):
408
+ exceptions: dict[str, Any]
409
+ legacyValue: str
410
+ value: str
411
+
412
+
413
+ class EnumStatsDict(TypedDict, total=False):
414
+ field: str
415
+ missingStudiesCount: int
416
+ piece: str
417
+ topValues: list[ValueCountDict]
418
+ type: FieldStatsTypeValue
419
+ uniqueValuesCount: int
420
+
421
+
422
+ class EventGroupDict(TypedDict, total=False):
423
+ id: str
424
+ title: str
425
+ description: str
426
+ deathsNumAffected: int
427
+ deathsNumAtRisk: int
428
+ seriousNumAffected: int
429
+ seriousNumAtRisk: int
430
+ otherNumAffected: int
431
+ otherNumAtRisk: int
432
+
433
+
434
+ class EventStatsDict(TypedDict, total=False):
435
+ groupId: str
436
+ numEvents: int
437
+ numAffected: int
438
+ numAtRisk: int
439
+
440
+
441
+ class ExpandedAccessInfoDict(TypedDict, total=False):
442
+ hasExpandedAccess: bool
443
+ nctId: str
444
+ statusForNctId: ExpandedAccessStatusValue
445
+
446
+
447
+ class ExpandedAccessTypesDict(TypedDict, total=False):
448
+ individual: bool
449
+ intermediate: bool
450
+ treatment: bool
451
+
452
+
453
+ class FieldNodeDict(TypedDict, total=False):
454
+ altPieceNames: list[str]
455
+ children: list[FieldNodeDict]
456
+ dedLink: WebLinkDict
457
+ description: str
458
+ historicOnly: bool
459
+ indexedOnly: bool
460
+ isEnum: bool
461
+ maxChars: int
462
+ name: str
463
+ nested: bool
464
+ piece: str
465
+ rules: str
466
+ sourceType: str
467
+ synonyms: bool
468
+ title: str
469
+ type: str
470
+
471
+
472
+ class FirstMcpInfoDict(TypedDict, total=False):
473
+ postDateStruct: DateStructDict
474
+
475
+
476
+ class FlowGroupDict(TypedDict, total=False):
477
+ id: str
478
+ title: str
479
+ description: str
480
+
481
+
482
+ class FlowMilestoneDict(TypedDict, total=False):
483
+ type: str
484
+ comment: str
485
+ achievements: list[FlowStatsDict]
486
+
487
+
488
+ class FlowPeriodDict(TypedDict, total=False):
489
+ title: str
490
+ milestones: list[FlowMilestoneDict]
491
+ dropWithdraws: list[DropWithdrawDict]
492
+
493
+
494
+ class FlowStatsDict(TypedDict, total=False):
495
+ groupId: str
496
+ comment: str
497
+ numSubjects: str
498
+ numUnits: str
499
+
500
+
501
+ class GeoPointDict(TypedDict, total=False):
502
+ lat: float
503
+ lon: float
504
+
505
+
506
+ class GzipStatsDict(TypedDict, total=False):
507
+ averageSizeBytes: int
508
+ largestStudies: list[StudySizeDict]
509
+ percentiles: dict[str, Any]
510
+ ranges: list[DistItemDict]
511
+ totalStudies: int
512
+
513
+
514
+ class IdentificationModuleDict(TypedDict, total=False):
515
+ nctId: str
516
+ nctIdAliases: list[str]
517
+ orgStudyIdInfo: OrgStudyIdInfoDict
518
+ secondaryIdInfos: list[SecondaryIdInfoDict]
519
+ briefTitle: str
520
+ officialTitle: str
521
+ acronym: str
522
+ organization: OrganizationDict
523
+
524
+
525
+ class IntegerStatsDict(TypedDict, total=False):
526
+ avg: float
527
+ field: str
528
+ max: int
529
+ min: int
530
+ missingStudiesCount: int
531
+ piece: str
532
+ type: FieldStatsTypeValue
533
+
534
+
535
+ class InterventionDict(TypedDict, total=False):
536
+ type: InterventionTypeValue
537
+ name: str
538
+ description: str
539
+ armGroupLabels: list[str]
540
+ otherNames: list[str]
541
+
542
+
543
+ class IpdSharingStatementModuleDict(TypedDict, total=False):
544
+ ipdSharing: IpdSharingValue
545
+ description: str
546
+ infoTypes: list[IpdSharingInfoTypeValue]
547
+ timeFrame: str
548
+ accessCriteria: str
549
+ url: str
550
+
551
+
552
+ class LargeDocDict(TypedDict, total=False):
553
+ typeAbbrev: str
554
+ hasProtocol: bool
555
+ hasSap: bool
556
+ hasIcf: bool
557
+ label: str
558
+ date: str
559
+ uploadDate: str
560
+ filename: str
561
+ size: int
562
+
563
+
564
+ class LargeDocumentModuleDict(TypedDict, total=False):
565
+ noSap: bool
566
+ largeDocs: list[LargeDocDict]
567
+
568
+
569
+ class LimitationsAndCaveatsDict(TypedDict, total=False):
570
+ description: str
571
+
572
+
573
+ class ListSizeDict(TypedDict, total=False):
574
+ size: int
575
+ studiesCount: int
576
+
577
+
578
+ class ListSizesDict(TypedDict, total=False):
579
+ field: str
580
+ maxSize: int
581
+ minSize: int
582
+ piece: str
583
+ topSizes: list[ListSizeDict]
584
+ uniqueSizesCount: int
585
+
586
+
587
+ class LocationDict(TypedDict, total=False):
588
+ facility: str
589
+ status: RecruitmentStatusValue
590
+ city: str
591
+ state: str
592
+ zip: str
593
+ country: str
594
+ contacts: list[ContactDict]
595
+ geoPoint: GeoPointDict
596
+
597
+
598
+ class LongestStringDict(TypedDict, total=False):
599
+ length: int
600
+ nctId: str
601
+ value: str
602
+
603
+
604
+ class MaskingBlockDict(TypedDict, total=False):
605
+ masking: DesignMaskingValue
606
+ maskingDescription: str
607
+ whoMasked: list[WhoMaskedValue]
608
+
609
+
610
+ class MeasureAnalysisDict(TypedDict, total=False):
611
+ paramType: str
612
+ paramValue: str
613
+ dispersionType: AnalysisDispersionTypeValue
614
+ dispersionValue: str
615
+ statisticalMethod: str
616
+ statisticalComment: str
617
+ pValue: str
618
+ pValueComment: str
619
+ ciNumSides: ConfidenceIntervalNumSidesValue
620
+ ciPctValue: str
621
+ ciLowerLimit: str
622
+ ciUpperLimit: str
623
+ ciLowerLimitComment: str
624
+ ciUpperLimitComment: str
625
+ estimateComment: str
626
+ testedNonInferiority: bool
627
+ nonInferiorityType: NonInferiorityTypeValue
628
+ nonInferiorityComment: str
629
+ otherAnalysisDescription: str
630
+ groupDescription: str
631
+ groupIds: list[str]
632
+
633
+
634
+ class MeasureCategoryDict(TypedDict, total=False):
635
+ title: str
636
+ measurements: list[MeasurementDict]
637
+
638
+
639
+ class MeasureClassDict(TypedDict, total=False):
640
+ title: str
641
+ denoms: list[DenomDict]
642
+ categories: list[MeasureCategoryDict]
643
+
644
+
645
+ class MeasureGroupDict(TypedDict, total=False):
646
+ id: str
647
+ title: str
648
+ description: str
649
+
650
+
651
+ class MeasurementDict(TypedDict, total=False):
652
+ groupId: str
653
+ value: str
654
+ spread: str
655
+ lowerLimit: str
656
+ upperLimit: str
657
+ comment: str
658
+
659
+
660
+ class MeshDict(TypedDict, total=False):
661
+ id: str
662
+ term: str
663
+
664
+
665
+ class MiscInfoModuleDict(TypedDict, total=False):
666
+ versionHolder: str
667
+ removedCountries: list[str]
668
+ submissionTracking: SubmissionTrackingDict
669
+
670
+
671
+ class MoreInfoModuleDict(TypedDict, total=False):
672
+ limitationsAndCaveats: LimitationsAndCaveatsDict
673
+ certainAgreement: CertainAgreementDict
674
+ pointOfContact: PointOfContactDict
675
+
676
+
677
+ class NumberStatsDict(TypedDict, total=False):
678
+ avg: float
679
+ field: str
680
+ max: float
681
+ min: float
682
+ missingStudiesCount: int
683
+ piece: str
684
+ type: FieldStatsTypeValue
685
+
686
+
687
+ class OfficialDict(TypedDict, total=False):
688
+ name: str
689
+ affiliation: str
690
+ role: OfficialRoleValue
691
+
692
+
693
+ class OrgStudyIdInfoDict(TypedDict, total=False):
694
+ id: str
695
+ type: OrgStudyIdTypeValue
696
+ link: str
697
+
698
+
699
+ OrganizationDict = TypedDict(
700
+ "OrganizationDict",
701
+ {
702
+ "fullName": str,
703
+ "class": AgencyClassValue,
704
+ },
705
+ total=False,
706
+ )
707
+
708
+
709
+ class OutcomeDict(TypedDict, total=False):
710
+ measure: str
711
+ description: str
712
+ timeFrame: str
713
+
714
+
715
+ class OutcomeMeasureDict(TypedDict, total=False):
716
+ type: OutcomeMeasureTypeValue
717
+ title: str
718
+ description: str
719
+ populationDescription: str
720
+ reportingStatus: ReportingStatusValue
721
+ anticipatedPostingDate: str
722
+ paramType: MeasureParamValue
723
+ dispersionType: str
724
+ unitOfMeasure: str
725
+ calculatePct: bool
726
+ timeFrame: str
727
+ typeUnitsAnalyzed: str
728
+ denomUnitsSelected: str
729
+ groups: list[MeasureGroupDict]
730
+ denoms: list[DenomDict]
731
+ classes: list[MeasureClassDict]
732
+ analyses: list[MeasureAnalysisDict]
733
+
734
+
735
+ class OutcomeMeasuresModuleDict(TypedDict, total=False):
736
+ outcomeMeasures: list[OutcomeMeasureDict]
737
+
738
+
739
+ class OutcomesModuleDict(TypedDict, total=False):
740
+ primaryOutcomes: list[OutcomeDict]
741
+ secondaryOutcomes: list[OutcomeDict]
742
+ otherOutcomes: list[OutcomeDict]
743
+
744
+
745
+ class OversightModuleDict(TypedDict, total=False):
746
+ oversightHasDmc: bool
747
+ isFdaRegulatedDrug: bool
748
+ isFdaRegulatedDevice: bool
749
+ isUnapprovedDevice: bool
750
+ isPpsd: bool
751
+ isUsExport: bool
752
+ fdaaa801Violation: bool
753
+
754
+
755
+ class PagedStudiesDict(TypedDict, total=False):
756
+ nextPageToken: str
757
+ studies: list[StudyDict]
758
+ totalCount: int
759
+
760
+
761
+ class PartialDateStructDict(TypedDict, total=False):
762
+ date: str
763
+ type: DateTypeValue
764
+
765
+
766
+ class ParticipantFlowModuleDict(TypedDict, total=False):
767
+ preAssignmentDetails: str
768
+ recruitmentDetails: str
769
+ typeUnitsAnalyzed: str
770
+ groups: list[FlowGroupDict]
771
+ periods: list[FlowPeriodDict]
772
+
773
+
774
+ class PointOfContactDict(TypedDict, total=False):
775
+ title: str
776
+ organization: str
777
+ email: str
778
+ phone: str
779
+ phoneExt: str
780
+
781
+
782
+ class ProtocolSectionDict(TypedDict, total=False):
783
+ identificationModule: IdentificationModuleDict
784
+ statusModule: StatusModuleDict
785
+ sponsorCollaboratorsModule: SponsorCollaboratorsModuleDict
786
+ oversightModule: OversightModuleDict
787
+ descriptionModule: DescriptionModuleDict
788
+ conditionsModule: ConditionsModuleDict
789
+ designModule: DesignModuleDict
790
+ armsInterventionsModule: ArmsInterventionsModuleDict
791
+ outcomesModule: OutcomesModuleDict
792
+ eligibilityModule: EligibilityModuleDict
793
+ contactsLocationsModule: ContactsLocationsModuleDict
794
+ referencesModule: ReferencesModuleDict
795
+ ipdSharingStatementModule: IpdSharingStatementModuleDict
796
+
797
+
798
+ class ReferenceDict(TypedDict, total=False):
799
+ pmid: str
800
+ type: ReferenceTypeValue
801
+ citation: str
802
+ retractions: list[RetractionDict]
803
+
804
+
805
+ class ReferencesModuleDict(TypedDict, total=False):
806
+ references: list[ReferenceDict]
807
+ seeAlsoLinks: list[SeeAlsoLinkDict]
808
+ availIpds: list[AvailIpdDict]
809
+
810
+
811
+ class ResponsiblePartyDict(TypedDict, total=False):
812
+ type: ResponsiblePartyTypeValue
813
+ investigatorFullName: str
814
+ investigatorTitle: str
815
+ investigatorAffiliation: str
816
+ oldNameTitle: str
817
+ oldOrganization: str
818
+
819
+
820
+ class ResultsSectionDict(TypedDict, total=False):
821
+ participantFlowModule: ParticipantFlowModuleDict
822
+ baselineCharacteristicsModule: BaselineCharacteristicsModuleDict
823
+ outcomeMeasuresModule: OutcomeMeasuresModuleDict
824
+ adverseEventsModule: AdverseEventsModuleDict
825
+ moreInfoModule: MoreInfoModuleDict
826
+
827
+
828
+ class RetractionDict(TypedDict, total=False):
829
+ pmid: str
830
+ source: str
831
+
832
+
833
+ class SearchAreaDict(TypedDict, total=False):
834
+ name: str
835
+ param: str
836
+ parts: list[SearchPartDict]
837
+ uiLabel: str
838
+
839
+
840
+ class SearchDocumentDict(TypedDict, total=False):
841
+ areas: list[SearchAreaDict]
842
+ name: str
843
+
844
+
845
+ class SearchPartDict(TypedDict, total=False):
846
+ isEnum: bool
847
+ isSynonyms: bool
848
+ pieces: list[str]
849
+ type: str
850
+ weight: float
851
+
852
+
853
+ class SecondaryIdInfoDict(TypedDict, total=False):
854
+ id: str
855
+ type: SecondaryIdTypeValue
856
+ domain: str
857
+ link: str
858
+
859
+
860
+ class SeeAlsoLinkDict(TypedDict, total=False):
861
+ label: str
862
+ url: str
863
+
864
+
865
+ SponsorDict = TypedDict(
866
+ "SponsorDict",
867
+ {
868
+ "name": str,
869
+ "class": AgencyClassValue,
870
+ },
871
+ total=False,
872
+ )
873
+
874
+
875
+ class SponsorCollaboratorsModuleDict(TypedDict, total=False):
876
+ responsibleParty: ResponsiblePartyDict
877
+ leadSponsor: SponsorDict
878
+ collaborators: list[SponsorDict]
879
+
880
+
881
+ class StatusModuleDict(TypedDict, total=False):
882
+ statusVerifiedDate: str
883
+ overallStatus: StatusValue
884
+ lastKnownStatus: StatusValue
885
+ delayedPosting: bool
886
+ whyStopped: str
887
+ expandedAccessInfo: ExpandedAccessInfoDict
888
+ startDateStruct: PartialDateStructDict
889
+ primaryCompletionDateStruct: PartialDateStructDict
890
+ completionDateStruct: PartialDateStructDict
891
+ studyFirstSubmitDate: str
892
+ studyFirstSubmitQcDate: str
893
+ studyFirstPostDateStruct: DateStructDict
894
+ resultsWaived: bool
895
+ resultsFirstSubmitDate: str
896
+ resultsFirstSubmitQcDate: str
897
+ resultsFirstPostDateStruct: DateStructDict
898
+ dispFirstSubmitDate: str
899
+ dispFirstSubmitQcDate: str
900
+ dispFirstPostDateStruct: DateStructDict
901
+ lastUpdateSubmitDate: str
902
+ lastUpdatePostDateStruct: DateStructDict
903
+
904
+
905
+ class StringStatsDict(TypedDict, total=False):
906
+ field: str
907
+ longest: LongestStringDict
908
+ missingStudiesCount: int
909
+ piece: str
910
+ topValues: list[ValueCountDict]
911
+ type: FieldStatsTypeValue
912
+ uniqueValuesCount: int
913
+
914
+
915
+ class StudyDict(TypedDict, total=False):
916
+ protocolSection: ProtocolSectionDict
917
+ resultsSection: ResultsSectionDict
918
+ annotationSection: AnnotationSectionDict
919
+ documentSection: DocumentSectionDict
920
+ derivedSection: DerivedSectionDict
921
+ hasResults: bool
922
+
923
+
924
+ class StudySizeDict(TypedDict, total=False):
925
+ id: str
926
+ sizeBytes: int
927
+
928
+
929
+ class SubmissionInfoDict(TypedDict, total=False):
930
+ releaseDate: str
931
+ unreleaseDate: str
932
+ unreleaseDateUnknown: bool
933
+ resetDate: str
934
+ mcpReleaseN: int
935
+
936
+
937
+ class SubmissionTrackingDict(TypedDict, total=False):
938
+ estimatedResultsFirstSubmitDate: str
939
+ firstMcpInfo: FirstMcpInfoDict
940
+ submissionInfos: list[SubmissionInfoDict]
941
+
942
+
943
+ class UnpostedAnnotationDict(TypedDict, total=False):
944
+ unpostedResponsibleParty: str
945
+ unpostedEvents: list[UnpostedEventDict]
946
+
947
+
948
+ class UnpostedEventDict(TypedDict, total=False):
949
+ type: UnpostedEventTypeValue
950
+ date: str
951
+ dateUnknown: bool
952
+
953
+
954
+ class ValueCountDict(TypedDict, total=False):
955
+ studiesCount: int
956
+ value: str
957
+
958
+
959
+ class VersionDict(TypedDict, total=False):
960
+ apiVersion: str
961
+ dataTimestamp: str
962
+
963
+
964
+ class ViolationAnnotationDict(TypedDict, total=False):
965
+ violationEvents: list[ViolationEventDict]
966
+
967
+
968
+ class ViolationEventDict(TypedDict, total=False):
969
+ type: ViolationEventTypeValue
970
+ description: str
971
+ creationDate: str
972
+ issuedDate: str
973
+ releaseDate: str
974
+ postedDate: str
975
+
976
+
977
+ class WebLinkDict(TypedDict, total=False):
978
+ label: str
979
+ url: str
980
+
981
+
982
+ FieldValuesStatsDict = (
983
+ EnumStatsDict
984
+ | StringStatsDict
985
+ | DateStatsDict
986
+ | IntegerStatsDict
987
+ | NumberStatsDict
988
+ | BooleanStatsDict
989
+ )
990
+
991
+ __all__ = [
992
+ "AdverseEventDict",
993
+ "AdverseEventsModuleDict",
994
+ "AgencyClassValue",
995
+ "AgreementRestrictionTypeValue",
996
+ "AnalysisDispersionTypeValue",
997
+ "AnnotationModuleDict",
998
+ "AnnotationSectionDict",
999
+ "ArmGroupDict",
1000
+ "ArmGroupTypeValue",
1001
+ "ArmsInterventionsModuleDict",
1002
+ "AvailIpdDict",
1003
+ "BaselineCharacteristicsModuleDict",
1004
+ "BaselineMeasureDict",
1005
+ "BioSpecDict",
1006
+ "BioSpecRetentionValue",
1007
+ "BooleanStatsDict",
1008
+ "BrowseBranchDict",
1009
+ "BrowseLeafDict",
1010
+ "BrowseLeafRelevanceValue",
1011
+ "BrowseModuleDict",
1012
+ "CertainAgreementDict",
1013
+ "ConditionsModuleDict",
1014
+ "ConfidenceIntervalNumSidesValue",
1015
+ "ContactDict",
1016
+ "ContactRoleValue",
1017
+ "ContactsLocationsModuleDict",
1018
+ "DateStatsDict",
1019
+ "DateStructDict",
1020
+ "DateTypeValue",
1021
+ "DenomCountDict",
1022
+ "DenomDict",
1023
+ "DerivedSectionDict",
1024
+ "DescriptionModuleDict",
1025
+ "DesignAllocationValue",
1026
+ "DesignInfoDict",
1027
+ "DesignMaskingValue",
1028
+ "DesignModuleDict",
1029
+ "DesignTimePerspectiveValue",
1030
+ "DistItemDict",
1031
+ "DocumentSectionDict",
1032
+ "DropWithdrawDict",
1033
+ "EligibilityModuleDict",
1034
+ "EnrollmentInfoDict",
1035
+ "EnrollmentTypeValue",
1036
+ "EnumInfoDict",
1037
+ "EnumItemDict",
1038
+ "EnumStatsDict",
1039
+ "EventAssessmentValue",
1040
+ "EventGroupDict",
1041
+ "EventStatsDict",
1042
+ "ExpandedAccessInfoDict",
1043
+ "ExpandedAccessStatusValue",
1044
+ "ExpandedAccessTypesDict",
1045
+ "FieldNodeDict",
1046
+ "FieldStatsTypeValue",
1047
+ "FieldValuesStatsDict",
1048
+ "FirstMcpInfoDict",
1049
+ "FlowGroupDict",
1050
+ "FlowMilestoneDict",
1051
+ "FlowPeriodDict",
1052
+ "FlowStatsDict",
1053
+ "GeoPointDict",
1054
+ "GzipStatsDict",
1055
+ "IdentificationModuleDict",
1056
+ "IntegerStatsDict",
1057
+ "InterventionDict",
1058
+ "InterventionTypeValue",
1059
+ "InterventionalAssignmentValue",
1060
+ "IpdSharingInfoTypeValue",
1061
+ "IpdSharingStatementModuleDict",
1062
+ "IpdSharingValue",
1063
+ "LargeDocDict",
1064
+ "LargeDocumentModuleDict",
1065
+ "LimitationsAndCaveatsDict",
1066
+ "ListSizeDict",
1067
+ "ListSizesDict",
1068
+ "LocationDict",
1069
+ "LongestStringDict",
1070
+ "MaskingBlockDict",
1071
+ "MeasureAnalysisDict",
1072
+ "MeasureCategoryDict",
1073
+ "MeasureClassDict",
1074
+ "MeasureDispersionTypeValue",
1075
+ "MeasureGroupDict",
1076
+ "MeasureParamValue",
1077
+ "MeasurementDict",
1078
+ "MeshDict",
1079
+ "MiscInfoModuleDict",
1080
+ "MoreInfoModuleDict",
1081
+ "NonInferiorityTypeValue",
1082
+ "NumberStatsDict",
1083
+ "ObservationalModelValue",
1084
+ "OfficialDict",
1085
+ "OfficialRoleValue",
1086
+ "OrgStudyIdInfoDict",
1087
+ "OrgStudyIdTypeValue",
1088
+ "OrganizationDict",
1089
+ "OutcomeDict",
1090
+ "OutcomeMeasureDict",
1091
+ "OutcomeMeasureTypeValue",
1092
+ "OutcomeMeasuresModuleDict",
1093
+ "OutcomesModuleDict",
1094
+ "OversightModuleDict",
1095
+ "PagedStudiesDict",
1096
+ "PartialDateStructDict",
1097
+ "ParticipantFlowModuleDict",
1098
+ "PhaseValue",
1099
+ "PointOfContactDict",
1100
+ "PrimaryPurposeValue",
1101
+ "ProtocolSectionDict",
1102
+ "RecruitmentStatusValue",
1103
+ "ReferenceDict",
1104
+ "ReferenceTypeValue",
1105
+ "ReferencesModuleDict",
1106
+ "ReportingStatusValue",
1107
+ "ResponsiblePartyDict",
1108
+ "ResponsiblePartyTypeValue",
1109
+ "ResultsSectionDict",
1110
+ "RetractionDict",
1111
+ "SamplingMethodValue",
1112
+ "SearchAreaDict",
1113
+ "SearchDocumentDict",
1114
+ "SearchPartDict",
1115
+ "SecondaryIdInfoDict",
1116
+ "SecondaryIdTypeValue",
1117
+ "SeeAlsoLinkDict",
1118
+ "SexValue",
1119
+ "SponsorCollaboratorsModuleDict",
1120
+ "SponsorDict",
1121
+ "StandardAgeValue",
1122
+ "StatusModuleDict",
1123
+ "StatusValue",
1124
+ "StringStatsDict",
1125
+ "StudyDict",
1126
+ "StudySizeDict",
1127
+ "StudyTypeValue",
1128
+ "SubmissionInfoDict",
1129
+ "SubmissionTrackingDict",
1130
+ "UnpostedAnnotationDict",
1131
+ "UnpostedEventDict",
1132
+ "UnpostedEventTypeValue",
1133
+ "ValueCountDict",
1134
+ "VersionDict",
1135
+ "ViolationAnnotationDict",
1136
+ "ViolationEventDict",
1137
+ "ViolationEventTypeValue",
1138
+ "WebLinkDict",
1139
+ "WhoMaskedValue",
1140
+ ]