@medplum/fhirtypes 3.2.17 → 3.2.18

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.
@@ -6,8 +6,9 @@
6
6
  import { Annotation } from './Annotation';
7
7
  import { CodeableConcept } from './CodeableConcept';
8
8
  import { ContactDetail } from './ContactDetail';
9
- import { DataRequirement } from './DataRequirement';
10
- import { Duration } from './Duration';
9
+ import { Device } from './Device';
10
+ import { DeviceMetric } from './DeviceMetric';
11
+ import { Evidence } from './Evidence';
11
12
  import { Expression } from './Expression';
12
13
  import { Extension } from './Extension';
13
14
  import { Group } from './Group';
@@ -15,11 +16,11 @@ import { Identifier } from './Identifier';
15
16
  import { Meta } from './Meta';
16
17
  import { Narrative } from './Narrative';
17
18
  import { Period } from './Period';
19
+ import { Quantity } from './Quantity';
20
+ import { Range } from './Range';
18
21
  import { Reference } from './Reference';
19
22
  import { RelatedArtifact } from './RelatedArtifact';
20
23
  import { Resource } from './Resource';
21
- import { Timing } from './Timing';
22
- import { TriggerDefinition } from './TriggerDefinition';
23
24
  import { UsageContext } from './UsageContext';
24
25
 
25
26
  /**
@@ -285,15 +286,15 @@ export interface EvidenceVariable {
285
286
  type?: 'dichotomous' | 'continuous' | 'descriptive';
286
287
 
287
288
  /**
288
- * A characteristic that defines the members of the evidence element.
289
- * Multiple characteristics are applied with "and" semantics.
289
+ * A defining factor of the EvidenceVariable. Multiple characteristics
290
+ * are applied with "and" semantics.
290
291
  */
291
- characteristic: EvidenceVariableCharacteristic[];
292
+ characteristic?: EvidenceVariableCharacteristic[];
292
293
  }
293
294
 
294
295
  /**
295
- * A characteristic that defines the members of the evidence element.
296
- * Multiple characteristics are applied with "and" semantics.
296
+ * A defining factor of the EvidenceVariable. Multiple characteristics
297
+ * are applied with "and" semantics.
297
298
  */
298
299
  export interface EvidenceVariableCharacteristic {
299
300
 
@@ -306,10 +307,10 @@ export interface EvidenceVariableCharacteristic {
306
307
  /**
307
308
  * May be used to represent additional information that is not part of
308
309
  * the basic definition of the element. To make the use of extensions
309
- * safe and manageable, there is a strict set of governance applied to
310
- * the definition and use of extensions. Though any implementer can
311
- * define an extension, there is a set of requirements that SHALL be met
312
- * as part of the definition of the extension.
310
+ * safe and managable, there is a strict set of governance applied to the
311
+ * definition and use of extensions. Though any implementer can define an
312
+ * extension, there is a set of requirements that SHALL be met as part of
313
+ * the definition of the extension.
313
314
  */
314
315
  extension?: Extension[];
315
316
 
@@ -319,7 +320,7 @@ export interface EvidenceVariableCharacteristic {
319
320
  * understanding of the element in which it is contained and/or the
320
321
  * understanding of the containing element's descendants. Usually
321
322
  * modifier elements provide negation or qualification. To make the use
322
- * of extensions safe and manageable, there is a strict set of governance
323
+ * of extensions safe and managable, there is a strict set of governance
323
324
  * applied to the definition and use of extensions. Though any
324
325
  * implementer can define an extension, there is a set of requirements
325
326
  * that SHALL be met as part of the definition of the extension.
@@ -332,6 +333,11 @@ export interface EvidenceVariableCharacteristic {
332
333
  */
333
334
  modifierExtension?: Extension[];
334
335
 
336
+ /**
337
+ * Label used for when a characteristic refers to another characteristic.
338
+ */
339
+ linkId?: string;
340
+
335
341
  /**
336
342
  * A short, natural language description of the characteristic that could
337
343
  * be used to communicate the criteria to an end-user.
@@ -339,106 +345,330 @@ export interface EvidenceVariableCharacteristic {
339
345
  description?: string;
340
346
 
341
347
  /**
342
- * Define members of the evidence element using Codes (such as condition,
343
- * medication, or observation), Expressions ( using an expression
344
- * language such as FHIRPath or CQL) or DataRequirements (such as
345
- * Diabetes diagnosis onset in the last year).
348
+ * A human-readable string to clarify or explain concepts about the
349
+ * characteristic.
350
+ */
351
+ note?: Annotation[];
352
+
353
+ /**
354
+ * When true, this characteristic is an exclusion criterion. In other
355
+ * words, not matching this characteristic definition is equivalent to
356
+ * meeting this criterion.
357
+ */
358
+ exclude?: boolean;
359
+
360
+ /**
361
+ * Defines the characteristic using a Reference.
346
362
  */
347
- definitionReference?: Reference<Group>;
363
+ definitionReference?: Reference<EvidenceVariable | Group | Evidence>;
348
364
 
349
365
  /**
350
- * Define members of the evidence element using Codes (such as condition,
351
- * medication, or observation), Expressions ( using an expression
352
- * language such as FHIRPath or CQL) or DataRequirements (such as
353
- * Diabetes diagnosis onset in the last year).
366
+ * Defines the characteristic using Canonical.
354
367
  */
355
368
  definitionCanonical?: string;
356
369
 
357
370
  /**
358
- * Define members of the evidence element using Codes (such as condition,
359
- * medication, or observation), Expressions ( using an expression
360
- * language such as FHIRPath or CQL) or DataRequirements (such as
361
- * Diabetes diagnosis onset in the last year).
371
+ * Defines the characteristic using CodeableConcept.
362
372
  */
363
373
  definitionCodeableConcept?: CodeableConcept;
364
374
 
365
375
  /**
366
- * Define members of the evidence element using Codes (such as condition,
367
- * medication, or observation), Expressions ( using an expression
368
- * language such as FHIRPath or CQL) or DataRequirements (such as
369
- * Diabetes diagnosis onset in the last year).
376
+ * Defines the characteristic using Expression.
370
377
  */
371
378
  definitionExpression?: Expression;
372
379
 
373
380
  /**
374
- * Define members of the evidence element using Codes (such as condition,
375
- * medication, or observation), Expressions ( using an expression
376
- * language such as FHIRPath or CQL) or DataRequirements (such as
377
- * Diabetes diagnosis onset in the last year).
381
+ * Defines the characteristic using id.
378
382
  */
379
- definitionDataRequirement?: DataRequirement;
383
+ definitionId?: string;
380
384
 
381
385
  /**
382
- * Define members of the evidence element using Codes (such as condition,
383
- * medication, or observation), Expressions ( using an expression
384
- * language such as FHIRPath or CQL) or DataRequirements (such as
385
- * Diabetes diagnosis onset in the last year).
386
+ * Defines the characteristic using both a type and value[x] elements.
386
387
  */
387
- definitionTriggerDefinition?: TriggerDefinition;
388
+ definitionByTypeAndValue?: EvidenceVariableCharacteristicDefinitionByTypeAndValue;
388
389
 
389
390
  /**
390
- * Use UsageContext to define the members of the population, such as Age
391
- * Ranges, Genders, Settings.
391
+ * Defines the characteristic as a combination of two or more
392
+ * characteristics.
392
393
  */
393
- usageContext?: UsageContext[];
394
+ definitionByCombination?: EvidenceVariableCharacteristicDefinitionByCombination;
394
395
 
395
396
  /**
396
- * When true, members with this characteristic are excluded from the
397
- * element.
397
+ * Number of occurrences meeting the characteristic.
398
398
  */
399
- exclude?: boolean;
399
+ instancesQuantity?: Quantity;
400
400
 
401
401
  /**
402
- * Indicates what effective period the study covers.
402
+ * Number of occurrences meeting the characteristic.
403
403
  */
404
- participantEffectiveDateTime?: string;
404
+ instancesRange?: Range;
405
405
 
406
406
  /**
407
- * Indicates what effective period the study covers.
407
+ * Length of time in which the characteristic is met.
408
408
  */
409
- participantEffectivePeriod?: Period;
409
+ durationQuantity?: Quantity;
410
410
 
411
411
  /**
412
- * Indicates what effective period the study covers.
412
+ * Length of time in which the characteristic is met.
413
+ */
414
+ durationRange?: Range;
415
+
416
+ /**
417
+ * Timing in which the characteristic is determined.
418
+ */
419
+ timeFromEvent?: EvidenceVariableCharacteristicTimeFromEvent[];
420
+ }
421
+
422
+ /**
423
+ * Number of occurrences meeting the characteristic.
424
+ */
425
+ export type EvidenceVariableCharacteristicInstances = Quantity | Range;
426
+
427
+ /**
428
+ * Length of time in which the characteristic is met.
429
+ */
430
+ export type EvidenceVariableCharacteristicDuration = Quantity | Range;
431
+
432
+ /**
433
+ * Defines the characteristic as a combination of two or more
434
+ * characteristics.
435
+ */
436
+ export interface EvidenceVariableCharacteristicDefinitionByCombination {
437
+
438
+ /**
439
+ * Unique id for the element within a resource (for internal references).
440
+ * This may be any string value that does not contain spaces.
441
+ */
442
+ id?: string;
443
+
444
+ /**
445
+ * May be used to represent additional information that is not part of
446
+ * the basic definition of the element. To make the use of extensions
447
+ * safe and managable, there is a strict set of governance applied to the
448
+ * definition and use of extensions. Though any implementer can define an
449
+ * extension, there is a set of requirements that SHALL be met as part of
450
+ * the definition of the extension.
451
+ */
452
+ extension?: Extension[];
453
+
454
+ /**
455
+ * May be used to represent additional information that is not part of
456
+ * the basic definition of the element and that modifies the
457
+ * understanding of the element in which it is contained and/or the
458
+ * understanding of the containing element's descendants. Usually
459
+ * modifier elements provide negation or qualification. To make the use
460
+ * of extensions safe and managable, there is a strict set of governance
461
+ * applied to the definition and use of extensions. Though any
462
+ * implementer can define an extension, there is a set of requirements
463
+ * that SHALL be met as part of the definition of the extension.
464
+ * Applications processing a resource are required to check for modifier
465
+ * extensions.
466
+ *
467
+ * Modifier extensions SHALL NOT change the meaning of any elements on
468
+ * Resource or DomainResource (including cannot change the meaning of
469
+ * modifierExtension itself).
413
470
  */
414
- participantEffectiveDuration?: Duration;
471
+ modifierExtension?: Extension[];
415
472
 
416
473
  /**
417
- * Indicates what effective period the study covers.
474
+ * Used to specify if two or more characteristics are combined with OR or
475
+ * AND.
418
476
  */
419
- participantEffectiveTiming?: Timing;
477
+ code: string;
420
478
 
421
479
  /**
422
- * Indicates duration from the participant's study entry.
480
+ * Provides the value of &quot;n&quot; when &quot;at-least&quot; or &quot;at-most&quot; codes are used.
423
481
  */
424
- timeFromStart?: Duration;
482
+ threshold?: number;
425
483
 
426
484
  /**
427
- * Indicates how elements are aggregated within the study effective
428
- * period.
485
+ * A defining factor of the characteristic.
429
486
  */
430
- groupMeasure?: 'mean' | 'median' | 'mean-of-mean' | 'mean-of-median' | 'median-of-mean' | 'median-of-median';
487
+ characteristic: EvidenceVariableCharacteristic[];
431
488
  }
432
489
 
433
490
  /**
434
- * Define members of the evidence element using Codes (such as condition,
435
- * medication, or observation), Expressions ( using an expression
436
- * language such as FHIRPath or CQL) or DataRequirements (such as
437
- * Diabetes diagnosis onset in the last year).
491
+ * Defines the characteristic using both a type and value[x] elements.
438
492
  */
439
- export type EvidenceVariableCharacteristicDefinition = CodeableConcept | DataRequirement | Expression | Reference<Group> | string | TriggerDefinition;
493
+ export interface EvidenceVariableCharacteristicDefinitionByTypeAndValue {
494
+
495
+ /**
496
+ * Unique id for the element within a resource (for internal references).
497
+ * This may be any string value that does not contain spaces.
498
+ */
499
+ id?: string;
500
+
501
+ /**
502
+ * May be used to represent additional information that is not part of
503
+ * the basic definition of the element. To make the use of extensions
504
+ * safe and managable, there is a strict set of governance applied to the
505
+ * definition and use of extensions. Though any implementer can define an
506
+ * extension, there is a set of requirements that SHALL be met as part of
507
+ * the definition of the extension.
508
+ */
509
+ extension?: Extension[];
510
+
511
+ /**
512
+ * May be used to represent additional information that is not part of
513
+ * the basic definition of the element and that modifies the
514
+ * understanding of the element in which it is contained and/or the
515
+ * understanding of the containing element's descendants. Usually
516
+ * modifier elements provide negation or qualification. To make the use
517
+ * of extensions safe and managable, there is a strict set of governance
518
+ * applied to the definition and use of extensions. Though any
519
+ * implementer can define an extension, there is a set of requirements
520
+ * that SHALL be met as part of the definition of the extension.
521
+ * Applications processing a resource are required to check for modifier
522
+ * extensions.
523
+ *
524
+ * Modifier extensions SHALL NOT change the meaning of any elements on
525
+ * Resource or DomainResource (including cannot change the meaning of
526
+ * modifierExtension itself).
527
+ */
528
+ modifierExtension?: Extension[];
529
+
530
+ /**
531
+ * Used to express the type of characteristic.
532
+ */
533
+ type: CodeableConcept;
534
+
535
+ /**
536
+ * Method for how the characteristic value was determined.
537
+ */
538
+ method?: CodeableConcept[];
539
+
540
+ /**
541
+ * Device used for determining characteristic.
542
+ */
543
+ device?: Reference<Device | DeviceMetric>;
544
+
545
+ /**
546
+ * Defines the characteristic when paired with characteristic.type.
547
+ */
548
+ valueCodeableConcept?: CodeableConcept;
549
+
550
+ /**
551
+ * Defines the characteristic when paired with characteristic.type.
552
+ */
553
+ valueBoolean?: boolean;
554
+
555
+ /**
556
+ * Defines the characteristic when paired with characteristic.type.
557
+ */
558
+ valueQuantity?: Quantity;
559
+
560
+ /**
561
+ * Defines the characteristic when paired with characteristic.type.
562
+ */
563
+ valueRange?: Range;
564
+
565
+ /**
566
+ * Defines the characteristic when paired with characteristic.type.
567
+ */
568
+ valueReference?: Reference;
569
+
570
+ /**
571
+ * Defines the characteristic when paired with characteristic.type.
572
+ */
573
+ valueId?: string;
574
+
575
+ /**
576
+ * Defines the reference point for comparison when valueQuantity or
577
+ * valueRange is not compared to zero.
578
+ */
579
+ offset?: CodeableConcept;
580
+ }
581
+
582
+ /**
583
+ * Defines the characteristic when paired with characteristic.type.
584
+ */
585
+ export type EvidenceVariableCharacteristicDefinitionByTypeAndValueValue = boolean | CodeableConcept | Quantity | Range | Reference | string;
586
+
587
+ /**
588
+ * Timing in which the characteristic is determined.
589
+ */
590
+ export interface EvidenceVariableCharacteristicTimeFromEvent {
591
+
592
+ /**
593
+ * Unique id for the element within a resource (for internal references).
594
+ * This may be any string value that does not contain spaces.
595
+ */
596
+ id?: string;
597
+
598
+ /**
599
+ * May be used to represent additional information that is not part of
600
+ * the basic definition of the element. To make the use of extensions
601
+ * safe and managable, there is a strict set of governance applied to the
602
+ * definition and use of extensions. Though any implementer can define an
603
+ * extension, there is a set of requirements that SHALL be met as part of
604
+ * the definition of the extension.
605
+ */
606
+ extension?: Extension[];
607
+
608
+ /**
609
+ * May be used to represent additional information that is not part of
610
+ * the basic definition of the element and that modifies the
611
+ * understanding of the element in which it is contained and/or the
612
+ * understanding of the containing element's descendants. Usually
613
+ * modifier elements provide negation or qualification. To make the use
614
+ * of extensions safe and managable, there is a strict set of governance
615
+ * applied to the definition and use of extensions. Though any
616
+ * implementer can define an extension, there is a set of requirements
617
+ * that SHALL be met as part of the definition of the extension.
618
+ * Applications processing a resource are required to check for modifier
619
+ * extensions.
620
+ *
621
+ * Modifier extensions SHALL NOT change the meaning of any elements on
622
+ * Resource or DomainResource (including cannot change the meaning of
623
+ * modifierExtension itself).
624
+ */
625
+ modifierExtension?: Extension[];
626
+
627
+ /**
628
+ * Human readable description.
629
+ */
630
+ description?: string;
631
+
632
+ /**
633
+ * A human-readable string to clarify or explain concepts about the
634
+ * timeFromEvent.
635
+ */
636
+ note?: Annotation[];
637
+
638
+ /**
639
+ * The event used as a base point (reference point) in time.
640
+ */
641
+ eventCodeableConcept?: CodeableConcept;
642
+
643
+ /**
644
+ * The event used as a base point (reference point) in time.
645
+ */
646
+ eventReference?: Reference;
647
+
648
+ /**
649
+ * The event used as a base point (reference point) in time.
650
+ */
651
+ eventDateTime?: string;
652
+
653
+ /**
654
+ * The event used as a base point (reference point) in time.
655
+ */
656
+ eventId?: string;
657
+
658
+ /**
659
+ * Used to express the observation at a defined amount of time before or
660
+ * after the event.
661
+ */
662
+ quantity?: Quantity;
663
+
664
+ /**
665
+ * Used to express the observation within a period before and/or after
666
+ * the event.
667
+ */
668
+ range?: Range;
669
+ }
440
670
 
441
671
  /**
442
- * Indicates what effective period the study covers.
672
+ * The event used as a base point (reference point) in time.
443
673
  */
444
- export type EvidenceVariableCharacteristicParticipantEffective = Duration | Period | string | Timing;
674
+ export type EvidenceVariableCharacteristicTimeFromEventEvent = CodeableConcept | Reference | string;
@@ -7,6 +7,7 @@ import { AccessPolicy } from './AccessPolicy';
7
7
  import { Bot } from './Bot';
8
8
  import { ClientApplication } from './ClientApplication';
9
9
  import { Extension } from './Extension';
10
+ import { Identifier } from './Identifier';
10
11
  import { Meta } from './Meta';
11
12
  import { Narrative } from './Narrative';
12
13
  import { Patient } from './Patient';
@@ -100,6 +101,11 @@ export interface ProjectMembership {
100
101
  */
101
102
  modifierExtension?: Extension[];
102
103
 
104
+ /**
105
+ * An identifier for this ProjectMembership.
106
+ */
107
+ identifier?: Identifier[];
108
+
103
109
  /**
104
110
  * Project where the memberships are available.
105
111
  */
@@ -4,8 +4,12 @@
4
4
  */
5
5
 
6
6
  import { Annotation } from './Annotation';
7
+ import { Citation } from './Citation';
7
8
  import { CodeableConcept } from './CodeableConcept';
8
9
  import { ContactDetail } from './ContactDetail';
10
+ import { DiagnosticReport } from './DiagnosticReport';
11
+ import { EvidenceReport } from './EvidenceReport';
12
+ import { EvidenceVariable } from './EvidenceVariable';
9
13
  import { Extension } from './Extension';
10
14
  import { Group } from './Group';
11
15
  import { Identifier } from './Identifier';
@@ -115,10 +119,20 @@ export interface ResearchStudy {
115
119
  identifier?: Identifier[];
116
120
 
117
121
  /**
118
- * A short, descriptive user-friendly label for the study.
122
+ * Name for this study (computer friendly).
123
+ */
124
+ name?: string;
125
+
126
+ /**
127
+ * The human readable name of the research study.
119
128
  */
120
129
  title?: string;
121
130
 
131
+ /**
132
+ * Additional names for the study.
133
+ */
134
+ label?: ResearchStudyLabel[];
135
+
122
136
  /**
123
137
  * The set of steps expected to be performed as part of the execution of
124
138
  * the study.
@@ -150,6 +164,13 @@ export interface ResearchStudy {
150
164
  */
151
165
  phase?: CodeableConcept;
152
166
 
167
+ /**
168
+ * Codes categorizing the type of study such as investigational vs.
169
+ * observational, type of blinding, type of randomization, safety vs.
170
+ * efficacy, etc.
171
+ */
172
+ studyDesign?: CodeableConcept[];
173
+
153
174
  /**
154
175
  * Codes categorizing the type of study such as investigational vs.
155
176
  * observational, type of blinding, type of randomization, safety vs.
@@ -179,7 +200,11 @@ export interface ResearchStudy {
179
200
  contact?: ContactDetail[];
180
201
 
181
202
  /**
182
- * Citations, references and other related documents.
203
+ * Citations, references, URLs and other related documents. When using
204
+ * relatedArtifact to share URLs, the relatedArtifact.type will often be
205
+ * set to one of &quot;documentation&quot; or &quot;supported-with&quot; and the URL value
206
+ * will often be in relatedArtifact.document.url but another possible
207
+ * location is relatedArtifact.resource when it is a canonical URL.
183
208
  */
184
209
  relatedArtifact?: RelatedArtifact[];
185
210
 
@@ -195,7 +220,19 @@ export interface ResearchStudy {
195
220
  location?: CodeableConcept[];
196
221
 
197
222
  /**
198
- * A full description of how the study is being conducted.
223
+ * A country, state or other area where the study is taking place rather
224
+ * than its precise geographic location or address.
225
+ */
226
+ region?: CodeableConcept[];
227
+
228
+ /**
229
+ * A brief text for explaining the study.
230
+ */
231
+ descriptionSummary?: string;
232
+
233
+ /**
234
+ * A detailed and human-readable narrative of the study. E.g., study
235
+ * abstract.
199
236
  */
200
237
  description?: string;
201
238
 
@@ -229,7 +266,7 @@ export interface ResearchStudy {
229
266
  /**
230
267
  * A facility in which study activities are conducted.
231
268
  */
232
- site?: Reference<Location>[];
269
+ site?: Reference<Location | ResearchStudy | Organization>[];
233
270
 
234
271
  /**
235
272
  * A description and/or code explaining the premature termination of the
@@ -250,12 +287,67 @@ export interface ResearchStudy {
250
287
  */
251
288
  arm?: ResearchStudyArm[];
252
289
 
290
+ /**
291
+ * Additional grouping mechanism or categorization of a research study.
292
+ * Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b
293
+ * (a German legal requirement), IRB-exempt, etc. Implementation Note: do
294
+ * not use the classifier element to support existing semantics that are
295
+ * already supported thru explicit elements in the resource.
296
+ */
297
+ classifier?: CodeableConcept[];
298
+
299
+ /**
300
+ * Sponsors, collaborators, and other parties.
301
+ */
302
+ associatedParty?: ResearchStudyAssociatedParty[];
303
+
304
+ /**
305
+ * Status of study with time for that status.
306
+ */
307
+ progressStatus?: ResearchStudyProgressStatus[];
308
+
309
+ /**
310
+ * A description and/or code explaining the premature termination of the
311
+ * study.
312
+ */
313
+ whyStopped?: CodeableConcept;
314
+
315
+ /**
316
+ * Target or actual group of participants enrolled in study.
317
+ */
318
+ recruitment?: ResearchStudyRecruitment;
319
+
320
+ /**
321
+ * Describes an expected event or sequence of events for one of the
322
+ * subjects of a study. E.g. for a living subject: exposure to drug A,
323
+ * wash-out, exposure to drug B, wash-out, follow-up. E.g. for a
324
+ * stability study: {store sample from lot A at 25 degrees for 1 month},
325
+ * {store sample from lot A at 40 degrees for 1 month}.
326
+ */
327
+ comparisonGroup?: ResearchStudyComparisonGroup[];
328
+
253
329
  /**
254
330
  * A goal that the study is aiming to achieve in terms of a scientific
255
331
  * question to be answered by the analysis of data collected during the
256
332
  * study.
257
333
  */
258
334
  objective?: ResearchStudyObjective[];
335
+
336
+ /**
337
+ * An &quot;outcome measure&quot;, &quot;endpoint&quot;, &quot;effect measure&quot; or &quot;measure of
338
+ * effect&quot; is a specific measurement or observation used to quantify the
339
+ * effect of experimental variables on the participants in a study, or
340
+ * for observational studies, to describe patterns of diseases or traits
341
+ * or associations with exposures, risk factors or treatment.
342
+ */
343
+ outcomeMeasure?: ResearchStudyOutcomeMeasure[];
344
+
345
+ /**
346
+ * Link to one or more sets of results generated by the study. Could
347
+ * also link to a research registry holding the results such as
348
+ * ClinicalTrials.gov.
349
+ */
350
+ result?: Reference<EvidenceReport | Citation | DiagnosticReport>[];
259
351
  }
260
352
 
261
353
  /**
@@ -318,6 +410,203 @@ export interface ResearchStudyArm {
318
410
  description?: string;
319
411
  }
320
412
 
413
+ /**
414
+ * Sponsors, collaborators, and other parties.
415
+ */
416
+ export interface ResearchStudyAssociatedParty {
417
+
418
+ /**
419
+ * Unique id for the element within a resource (for internal references).
420
+ * This may be any string value that does not contain spaces.
421
+ */
422
+ id?: string;
423
+
424
+ /**
425
+ * May be used to represent additional information that is not part of
426
+ * the basic definition of the element. To make the use of extensions
427
+ * safe and managable, there is a strict set of governance applied to the
428
+ * definition and use of extensions. Though any implementer can define an
429
+ * extension, there is a set of requirements that SHALL be met as part of
430
+ * the definition of the extension.
431
+ */
432
+ extension?: Extension[];
433
+
434
+ /**
435
+ * May be used to represent additional information that is not part of
436
+ * the basic definition of the element and that modifies the
437
+ * understanding of the element in which it is contained and/or the
438
+ * understanding of the containing element's descendants. Usually
439
+ * modifier elements provide negation or qualification. To make the use
440
+ * of extensions safe and managable, there is a strict set of governance
441
+ * applied to the definition and use of extensions. Though any
442
+ * implementer can define an extension, there is a set of requirements
443
+ * that SHALL be met as part of the definition of the extension.
444
+ * Applications processing a resource are required to check for modifier
445
+ * extensions.
446
+ *
447
+ * Modifier extensions SHALL NOT change the meaning of any elements on
448
+ * Resource or DomainResource (including cannot change the meaning of
449
+ * modifierExtension itself).
450
+ */
451
+ modifierExtension?: Extension[];
452
+
453
+ /**
454
+ * Name of associated party.
455
+ */
456
+ name?: string;
457
+
458
+ /**
459
+ * Type of association.
460
+ */
461
+ role: CodeableConcept;
462
+
463
+ /**
464
+ * Identifies the start date and the end date of the associated party in
465
+ * the role.
466
+ */
467
+ period?: Period[];
468
+
469
+ /**
470
+ * A categorization other than role for the associated party.
471
+ */
472
+ classifier?: CodeableConcept[];
473
+
474
+ /**
475
+ * Individual or organization associated with study (use practitionerRole
476
+ * to specify their organisation).
477
+ */
478
+ party?: Reference<Practitioner | PractitionerRole | Organization>;
479
+ }
480
+
481
+ /**
482
+ * Describes an expected event or sequence of events for one of the
483
+ * subjects of a study. E.g. for a living subject: exposure to drug A,
484
+ * wash-out, exposure to drug B, wash-out, follow-up. E.g. for a
485
+ * stability study: {store sample from lot A at 25 degrees for 1 month},
486
+ * {store sample from lot A at 40 degrees for 1 month}.
487
+ */
488
+ export interface ResearchStudyComparisonGroup {
489
+
490
+ /**
491
+ * Unique id for the element within a resource (for internal references).
492
+ * This may be any string value that does not contain spaces.
493
+ */
494
+ id?: string;
495
+
496
+ /**
497
+ * May be used to represent additional information that is not part of
498
+ * the basic definition of the element. To make the use of extensions
499
+ * safe and managable, there is a strict set of governance applied to the
500
+ * definition and use of extensions. Though any implementer can define an
501
+ * extension, there is a set of requirements that SHALL be met as part of
502
+ * the definition of the extension.
503
+ */
504
+ extension?: Extension[];
505
+
506
+ /**
507
+ * May be used to represent additional information that is not part of
508
+ * the basic definition of the element and that modifies the
509
+ * understanding of the element in which it is contained and/or the
510
+ * understanding of the containing element's descendants. Usually
511
+ * modifier elements provide negation or qualification. To make the use
512
+ * of extensions safe and managable, there is a strict set of governance
513
+ * applied to the definition and use of extensions. Though any
514
+ * implementer can define an extension, there is a set of requirements
515
+ * that SHALL be met as part of the definition of the extension.
516
+ * Applications processing a resource are required to check for modifier
517
+ * extensions.
518
+ *
519
+ * Modifier extensions SHALL NOT change the meaning of any elements on
520
+ * Resource or DomainResource (including cannot change the meaning of
521
+ * modifierExtension itself).
522
+ */
523
+ modifierExtension?: Extension[];
524
+
525
+ /**
526
+ * Allows the comparisonGroup for the study and the comparisonGroup for
527
+ * the subject to be linked easily.
528
+ */
529
+ linkId?: string;
530
+
531
+ /**
532
+ * Unique, human-readable label for this comparisonGroup of the study.
533
+ */
534
+ name: string;
535
+
536
+ /**
537
+ * Categorization of study comparisonGroup, e.g. experimental, active
538
+ * comparator, placebo comparater.
539
+ */
540
+ type?: CodeableConcept;
541
+
542
+ /**
543
+ * A succinct description of the path through the study that would be
544
+ * followed by a subject adhering to this comparisonGroup.
545
+ */
546
+ description?: string;
547
+
548
+ /**
549
+ * Interventions or exposures in this comparisonGroup or cohort.
550
+ */
551
+ intendedExposure?: Reference<EvidenceVariable>[];
552
+
553
+ /**
554
+ * Group of participants who were enrolled in study comparisonGroup.
555
+ */
556
+ observedGroup?: Reference<Group>;
557
+ }
558
+
559
+ /**
560
+ * Additional names for the study.
561
+ */
562
+ export interface ResearchStudyLabel {
563
+
564
+ /**
565
+ * Unique id for the element within a resource (for internal references).
566
+ * This may be any string value that does not contain spaces.
567
+ */
568
+ id?: string;
569
+
570
+ /**
571
+ * May be used to represent additional information that is not part of
572
+ * the basic definition of the element. To make the use of extensions
573
+ * safe and managable, there is a strict set of governance applied to the
574
+ * definition and use of extensions. Though any implementer can define an
575
+ * extension, there is a set of requirements that SHALL be met as part of
576
+ * the definition of the extension.
577
+ */
578
+ extension?: Extension[];
579
+
580
+ /**
581
+ * May be used to represent additional information that is not part of
582
+ * the basic definition of the element and that modifies the
583
+ * understanding of the element in which it is contained and/or the
584
+ * understanding of the containing element's descendants. Usually
585
+ * modifier elements provide negation or qualification. To make the use
586
+ * of extensions safe and managable, there is a strict set of governance
587
+ * applied to the definition and use of extensions. Though any
588
+ * implementer can define an extension, there is a set of requirements
589
+ * that SHALL be met as part of the definition of the extension.
590
+ * Applications processing a resource are required to check for modifier
591
+ * extensions.
592
+ *
593
+ * Modifier extensions SHALL NOT change the meaning of any elements on
594
+ * Resource or DomainResource (including cannot change the meaning of
595
+ * modifierExtension itself).
596
+ */
597
+ modifierExtension?: Extension[];
598
+
599
+ /**
600
+ * Kind of name.
601
+ */
602
+ type?: CodeableConcept;
603
+
604
+ /**
605
+ * The name.
606
+ */
607
+ value?: string;
608
+ }
609
+
321
610
  /**
322
611
  * A goal that the study is aiming to achieve in terms of a scientific
323
612
  * question to be answered by the analysis of data collected during the
@@ -334,10 +623,10 @@ export interface ResearchStudyObjective {
334
623
  /**
335
624
  * May be used to represent additional information that is not part of
336
625
  * the basic definition of the element. To make the use of extensions
337
- * safe and manageable, there is a strict set of governance applied to
338
- * the definition and use of extensions. Though any implementer can
339
- * define an extension, there is a set of requirements that SHALL be met
340
- * as part of the definition of the extension.
626
+ * safe and managable, there is a strict set of governance applied to the
627
+ * definition and use of extensions. Though any implementer can define an
628
+ * extension, there is a set of requirements that SHALL be met as part of
629
+ * the definition of the extension.
341
630
  */
342
631
  extension?: Extension[];
343
632
 
@@ -347,7 +636,7 @@ export interface ResearchStudyObjective {
347
636
  * understanding of the element in which it is contained and/or the
348
637
  * understanding of the containing element's descendants. Usually
349
638
  * modifier elements provide negation or qualification. To make the use
350
- * of extensions safe and manageable, there is a strict set of governance
639
+ * of extensions safe and managable, there is a strict set of governance
351
640
  * applied to the definition and use of extensions. Though any
352
641
  * implementer can define an extension, there is a set of requirements
353
642
  * that SHALL be met as part of the definition of the extension.
@@ -369,4 +658,196 @@ export interface ResearchStudyObjective {
369
658
  * The kind of study objective.
370
659
  */
371
660
  type?: CodeableConcept;
661
+
662
+ /**
663
+ * Free text description of the objective of the study. This is what the
664
+ * study is trying to achieve rather than how it is going to achieve it
665
+ * (see ResearchStudy.description).
666
+ */
667
+ description?: string;
668
+ }
669
+
670
+ /**
671
+ * An &quot;outcome measure&quot;, &quot;endpoint&quot;, &quot;effect measure&quot; or &quot;measure of
672
+ * effect&quot; is a specific measurement or observation used to quantify the
673
+ * effect of experimental variables on the participants in a study, or
674
+ * for observational studies, to describe patterns of diseases or traits
675
+ * or associations with exposures, risk factors or treatment.
676
+ */
677
+ export interface ResearchStudyOutcomeMeasure {
678
+
679
+ /**
680
+ * Unique id for the element within a resource (for internal references).
681
+ * This may be any string value that does not contain spaces.
682
+ */
683
+ id?: string;
684
+
685
+ /**
686
+ * May be used to represent additional information that is not part of
687
+ * the basic definition of the element. To make the use of extensions
688
+ * safe and managable, there is a strict set of governance applied to the
689
+ * definition and use of extensions. Though any implementer can define an
690
+ * extension, there is a set of requirements that SHALL be met as part of
691
+ * the definition of the extension.
692
+ */
693
+ extension?: Extension[];
694
+
695
+ /**
696
+ * May be used to represent additional information that is not part of
697
+ * the basic definition of the element and that modifies the
698
+ * understanding of the element in which it is contained and/or the
699
+ * understanding of the containing element's descendants. Usually
700
+ * modifier elements provide negation or qualification. To make the use
701
+ * of extensions safe and managable, there is a strict set of governance
702
+ * applied to the definition and use of extensions. Though any
703
+ * implementer can define an extension, there is a set of requirements
704
+ * that SHALL be met as part of the definition of the extension.
705
+ * Applications processing a resource are required to check for modifier
706
+ * extensions.
707
+ *
708
+ * Modifier extensions SHALL NOT change the meaning of any elements on
709
+ * Resource or DomainResource (including cannot change the meaning of
710
+ * modifierExtension itself).
711
+ */
712
+ modifierExtension?: Extension[];
713
+
714
+ /**
715
+ * Label for the outcome.
716
+ */
717
+ name?: string;
718
+
719
+ /**
720
+ * The parameter or characteristic being assessed as one of the values by
721
+ * which the study is assessed.
722
+ */
723
+ type?: CodeableConcept[];
724
+
725
+ /**
726
+ * Description of the outcome.
727
+ */
728
+ description?: string;
729
+
730
+ /**
731
+ * Structured outcome definition.
732
+ */
733
+ reference?: Reference<EvidenceVariable>;
734
+ }
735
+
736
+ /**
737
+ * Status of study with time for that status.
738
+ */
739
+ export interface ResearchStudyProgressStatus {
740
+
741
+ /**
742
+ * Unique id for the element within a resource (for internal references).
743
+ * This may be any string value that does not contain spaces.
744
+ */
745
+ id?: string;
746
+
747
+ /**
748
+ * May be used to represent additional information that is not part of
749
+ * the basic definition of the element. To make the use of extensions
750
+ * safe and managable, there is a strict set of governance applied to the
751
+ * definition and use of extensions. Though any implementer can define an
752
+ * extension, there is a set of requirements that SHALL be met as part of
753
+ * the definition of the extension.
754
+ */
755
+ extension?: Extension[];
756
+
757
+ /**
758
+ * May be used to represent additional information that is not part of
759
+ * the basic definition of the element and that modifies the
760
+ * understanding of the element in which it is contained and/or the
761
+ * understanding of the containing element's descendants. Usually
762
+ * modifier elements provide negation or qualification. To make the use
763
+ * of extensions safe and managable, there is a strict set of governance
764
+ * applied to the definition and use of extensions. Though any
765
+ * implementer can define an extension, there is a set of requirements
766
+ * that SHALL be met as part of the definition of the extension.
767
+ * Applications processing a resource are required to check for modifier
768
+ * extensions.
769
+ *
770
+ * Modifier extensions SHALL NOT change the meaning of any elements on
771
+ * Resource or DomainResource (including cannot change the meaning of
772
+ * modifierExtension itself).
773
+ */
774
+ modifierExtension?: Extension[];
775
+
776
+ /**
777
+ * Label for status or state (e.g. recruitment status).
778
+ */
779
+ state: CodeableConcept;
780
+
781
+ /**
782
+ * An indication of whether or not the date is a known date when the
783
+ * state changed or will change. A value of true indicates a known date.
784
+ * A value of false indicates an estimated date.
785
+ */
786
+ actual?: boolean;
787
+
788
+ /**
789
+ * Date range.
790
+ */
791
+ period?: Period;
792
+ }
793
+
794
+ /**
795
+ * Target or actual group of participants enrolled in study.
796
+ */
797
+ export interface ResearchStudyRecruitment {
798
+
799
+ /**
800
+ * Unique id for the element within a resource (for internal references).
801
+ * This may be any string value that does not contain spaces.
802
+ */
803
+ id?: string;
804
+
805
+ /**
806
+ * May be used to represent additional information that is not part of
807
+ * the basic definition of the element. To make the use of extensions
808
+ * safe and managable, there is a strict set of governance applied to the
809
+ * definition and use of extensions. Though any implementer can define an
810
+ * extension, there is a set of requirements that SHALL be met as part of
811
+ * the definition of the extension.
812
+ */
813
+ extension?: Extension[];
814
+
815
+ /**
816
+ * May be used to represent additional information that is not part of
817
+ * the basic definition of the element and that modifies the
818
+ * understanding of the element in which it is contained and/or the
819
+ * understanding of the containing element's descendants. Usually
820
+ * modifier elements provide negation or qualification. To make the use
821
+ * of extensions safe and managable, there is a strict set of governance
822
+ * applied to the definition and use of extensions. Though any
823
+ * implementer can define an extension, there is a set of requirements
824
+ * that SHALL be met as part of the definition of the extension.
825
+ * Applications processing a resource are required to check for modifier
826
+ * extensions.
827
+ *
828
+ * Modifier extensions SHALL NOT change the meaning of any elements on
829
+ * Resource or DomainResource (including cannot change the meaning of
830
+ * modifierExtension itself).
831
+ */
832
+ modifierExtension?: Extension[];
833
+
834
+ /**
835
+ * Estimated total number of participants to be enrolled.
836
+ */
837
+ targetNumber?: number;
838
+
839
+ /**
840
+ * Actual total number of participants enrolled in study.
841
+ */
842
+ actualNumber?: number;
843
+
844
+ /**
845
+ * Inclusion and exclusion criteria.
846
+ */
847
+ eligibility?: Reference<Group | EvidenceVariable>;
848
+
849
+ /**
850
+ * Group of participants who were enrolled in study.
851
+ */
852
+ actualGroup?: Reference<Group>;
372
853
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@medplum/fhirtypes",
3
- "version": "3.2.17",
3
+ "version": "3.2.18",
4
4
  "description": "Medplum FHIR Type Definitions",
5
5
  "keywords": [
6
6
  "medplum",