@medplum/definitions 5.1.27 → 5.1.28

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.
@@ -200,7 +200,10 @@
200
200
  "PackageInstallation": "#/definitions/PackageInstallation",
201
201
  "SmartHealthLink": "#/definitions/SmartHealthLink",
202
202
  "SmartHealthLinkFile": "#/definitions/SmartHealthLinkFile",
203
- "ProjectDefaultAccessPolicies": "#/definitions/ProjectDefaultAccessPolicies"
203
+ "ProjectDefaultAccessPolicies": "#/definitions/ProjectDefaultAccessPolicies",
204
+ "DicomStudy": "#/definitions/DicomStudy",
205
+ "DicomSeries": "#/definitions/DicomSeries",
206
+ "DicomInstance": "#/definitions/DicomInstance"
204
207
  }
205
208
  },
206
209
  "oneOf": [
@@ -791,6 +794,15 @@
791
794
  },
792
795
  {
793
796
  "$ref": "#/definitions/ProjectDefaultAccessPolicies"
797
+ },
798
+ {
799
+ "$ref": "#/definitions/DicomStudy"
800
+ },
801
+ {
802
+ "$ref": "#/definitions/DicomSeries"
803
+ },
804
+ {
805
+ "$ref": "#/definitions/DicomInstance"
794
806
  }
795
807
  ],
796
808
  "definitions": {
@@ -1383,6 +1395,15 @@
1383
1395
  },
1384
1396
  {
1385
1397
  "$ref": "#/definitions/ProjectDefaultAccessPolicies"
1398
+ },
1399
+ {
1400
+ "$ref": "#/definitions/DicomStudy"
1401
+ },
1402
+ {
1403
+ "$ref": "#/definitions/DicomSeries"
1404
+ },
1405
+ {
1406
+ "$ref": "#/definitions/DicomInstance"
1386
1407
  }
1387
1408
  ]
1388
1409
  },
@@ -61447,7 +61468,8 @@
61447
61468
  "transaction-bundles",
61448
61469
  "validate-terminology",
61449
61470
  "range-search",
61450
- "log-streaming"
61471
+ "log-streaming",
61472
+ "async-batch"
61451
61473
  ]
61452
61474
  },
61453
61475
  "type": "array"
@@ -64816,6 +64838,10 @@
64816
64838
  "logo": {
64817
64839
  "description": "Logo for the Log In Form.",
64818
64840
  "$ref": "#/definitions/Attachment"
64841
+ },
64842
+ "showScopeSelection": {
64843
+ "description": "Whether the Log In Form prompts the user to select OAuth and SMART scopes. When set, this value is authoritative. When unset, the scope selection screen is shown if the authorization request asks for any scope other than \"openid\". Setting this to false suppresses the prompt and grants the client the full scope that it requested. Note that granular scope selection is required for patient-facing apps under ONC 170.315(g)(10), so this should only be disabled for provider-facing or trusted first-party clients.",
64844
+ "$ref": "#/definitions/boolean"
64819
64845
  }
64820
64846
  },
64821
64847
  "additionalProperties": false
@@ -65296,6 +65322,343 @@
65296
65322
  "profileType",
65297
65323
  "accessPolicy"
65298
65324
  ]
65325
+ },
65326
+ "DicomStudy": {
65327
+ "description": "Definition of a DICOM study, which represents a collection of DICOM images and related metadata.",
65328
+ "properties": {
65329
+ "resourceType": {
65330
+ "description": "This is a DicomStudy resource",
65331
+ "const": "DicomStudy"
65332
+ },
65333
+ "id": {
65334
+ "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
65335
+ "$ref": "#/definitions/string"
65336
+ },
65337
+ "meta": {
65338
+ "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
65339
+ "$ref": "#/definitions/Meta"
65340
+ },
65341
+ "implicitRules": {
65342
+ "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
65343
+ "$ref": "#/definitions/uri"
65344
+ },
65345
+ "language": {
65346
+ "description": "The base language in which the resource is written.",
65347
+ "$ref": "#/definitions/code"
65348
+ },
65349
+ "text": {
65350
+ "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
65351
+ "$ref": "#/definitions/Narrative"
65352
+ },
65353
+ "contained": {
65354
+ "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
65355
+ "items": {
65356
+ "$ref": "#/definitions/Resource"
65357
+ },
65358
+ "type": "array"
65359
+ },
65360
+ "extension": {
65361
+ "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
65362
+ "items": {
65363
+ "$ref": "#/definitions/Extension"
65364
+ },
65365
+ "type": "array"
65366
+ },
65367
+ "modifierExtension": {
65368
+ "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
65369
+ "items": {
65370
+ "$ref": "#/definitions/Extension"
65371
+ },
65372
+ "type": "array"
65373
+ },
65374
+ "studyInstanceUid": {
65375
+ "description": "Unique identifier for the study.",
65376
+ "$ref": "#/definitions/id"
65377
+ },
65378
+ "studyId": {
65379
+ "description": "User-friendly identifier for the study.",
65380
+ "$ref": "#/definitions/string"
65381
+ },
65382
+ "studyDate": {
65383
+ "description": "Date the study started.",
65384
+ "$ref": "#/definitions/date"
65385
+ },
65386
+ "studyTime": {
65387
+ "description": "Time the study started.",
65388
+ "$ref": "#/definitions/time"
65389
+ },
65390
+ "accessionNumber": {
65391
+ "description": "The accession number for the study.",
65392
+ "$ref": "#/definitions/string"
65393
+ },
65394
+ "instanceAvailability": {
65395
+ "description": "Availability of the study instances (e.g., ONLINE, OFFLINE).",
65396
+ "$ref": "#/definitions/code"
65397
+ },
65398
+ "modalitiesInStudy": {
65399
+ "description": "The modalities (e.g., CT, MR) that are present in the study.",
65400
+ "items": {
65401
+ "$ref": "#/definitions/code"
65402
+ },
65403
+ "type": "array"
65404
+ },
65405
+ "referringPhysiciansName": {
65406
+ "description": "The name of the referring physician.",
65407
+ "$ref": "#/definitions/string"
65408
+ },
65409
+ "timezoneOffsetFromUtc": {
65410
+ "description": "The timezone offset from UTC for the study (e.g., -0700).",
65411
+ "$ref": "#/definitions/string"
65412
+ },
65413
+ "patientName": {
65414
+ "description": "The name of the patient.",
65415
+ "$ref": "#/definitions/string"
65416
+ },
65417
+ "patientId": {
65418
+ "description": "The ID of the patient.",
65419
+ "$ref": "#/definitions/string"
65420
+ },
65421
+ "patientBirthDate": {
65422
+ "description": "The birth date of the patient.",
65423
+ "$ref": "#/definitions/string"
65424
+ },
65425
+ "patientSex": {
65426
+ "description": "The sex of the patient.",
65427
+ "$ref": "#/definitions/string"
65428
+ },
65429
+ "numberOfStudyRelatedSeries": {
65430
+ "description": "The number of series related to the study.",
65431
+ "$ref": "#/definitions/unsignedInt"
65432
+ },
65433
+ "numberOfStudyRelatedInstances": {
65434
+ "description": "The number of instances related to the study.",
65435
+ "$ref": "#/definitions/unsignedInt"
65436
+ }
65437
+ },
65438
+ "additionalProperties": false,
65439
+ "required": [
65440
+ "resourceType",
65441
+ "studyInstanceUid"
65442
+ ]
65443
+ },
65444
+ "DicomSeries": {
65445
+ "description": "Definition of a DICOM series, which represents a collection of DICOM images and related metadata that are part of a DICOM study.",
65446
+ "properties": {
65447
+ "resourceType": {
65448
+ "description": "This is a DicomSeries resource",
65449
+ "const": "DicomSeries"
65450
+ },
65451
+ "id": {
65452
+ "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
65453
+ "$ref": "#/definitions/string"
65454
+ },
65455
+ "meta": {
65456
+ "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
65457
+ "$ref": "#/definitions/Meta"
65458
+ },
65459
+ "implicitRules": {
65460
+ "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
65461
+ "$ref": "#/definitions/uri"
65462
+ },
65463
+ "language": {
65464
+ "description": "The base language in which the resource is written.",
65465
+ "$ref": "#/definitions/code"
65466
+ },
65467
+ "text": {
65468
+ "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
65469
+ "$ref": "#/definitions/Narrative"
65470
+ },
65471
+ "contained": {
65472
+ "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
65473
+ "items": {
65474
+ "$ref": "#/definitions/Resource"
65475
+ },
65476
+ "type": "array"
65477
+ },
65478
+ "extension": {
65479
+ "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
65480
+ "items": {
65481
+ "$ref": "#/definitions/Extension"
65482
+ },
65483
+ "type": "array"
65484
+ },
65485
+ "modifierExtension": {
65486
+ "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
65487
+ "items": {
65488
+ "$ref": "#/definitions/Extension"
65489
+ },
65490
+ "type": "array"
65491
+ },
65492
+ "study": {
65493
+ "description": "The study that this DICOM series belongs to.",
65494
+ "$ref": "#/definitions/Reference"
65495
+ },
65496
+ "seriesInstanceUid": {
65497
+ "description": "Unique identifier for the series.",
65498
+ "$ref": "#/definitions/id"
65499
+ },
65500
+ "seriesNumber": {
65501
+ "description": "The number of this series within the study.",
65502
+ "$ref": "#/definitions/string"
65503
+ },
65504
+ "modality": {
65505
+ "description": "The modality of the series (e.g., CT, MR, US).",
65506
+ "$ref": "#/definitions/code"
65507
+ },
65508
+ "timezoneOffsetFromUtc": {
65509
+ "description": "The timezone offset from UTC for the study (e.g., -0700).",
65510
+ "$ref": "#/definitions/string"
65511
+ },
65512
+ "seriesDescription": {
65513
+ "description": "A description of the series (e.g., \u0027CT Abdomen with contrast\u0027).",
65514
+ "$ref": "#/definitions/string"
65515
+ },
65516
+ "numberOfSeriesRelatedInstances": {
65517
+ "description": "The number of instances related to the series.",
65518
+ "$ref": "#/definitions/unsignedInt"
65519
+ },
65520
+ "performedProcedureStepStartDate": {
65521
+ "description": "The start date of the performed procedure step (YYYYMMDD).",
65522
+ "$ref": "#/definitions/date"
65523
+ },
65524
+ "performedProcedureStepStartTime": {
65525
+ "description": "The start time of the performed procedure step (HHMMSS.frac).",
65526
+ "$ref": "#/definitions/time"
65527
+ },
65528
+ "scheduledProcedureStepId": {
65529
+ "description": "The ID of the scheduled procedure step.",
65530
+ "$ref": "#/definitions/string"
65531
+ },
65532
+ "requestedProcedureId": {
65533
+ "description": "The ID of the requested procedure.",
65534
+ "$ref": "#/definitions/string"
65535
+ }
65536
+ },
65537
+ "additionalProperties": false,
65538
+ "required": [
65539
+ "resourceType",
65540
+ "study",
65541
+ "seriesInstanceUid"
65542
+ ]
65543
+ },
65544
+ "DicomInstance": {
65545
+ "description": "Definition of a DICOM instance, which represents a single DICOM image and related metadata that are part of a DICOM series.",
65546
+ "properties": {
65547
+ "resourceType": {
65548
+ "description": "This is a DicomInstance resource",
65549
+ "const": "DicomInstance"
65550
+ },
65551
+ "id": {
65552
+ "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
65553
+ "$ref": "#/definitions/string"
65554
+ },
65555
+ "meta": {
65556
+ "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
65557
+ "$ref": "#/definitions/Meta"
65558
+ },
65559
+ "implicitRules": {
65560
+ "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
65561
+ "$ref": "#/definitions/uri"
65562
+ },
65563
+ "language": {
65564
+ "description": "The base language in which the resource is written.",
65565
+ "$ref": "#/definitions/code"
65566
+ },
65567
+ "text": {
65568
+ "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
65569
+ "$ref": "#/definitions/Narrative"
65570
+ },
65571
+ "contained": {
65572
+ "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
65573
+ "items": {
65574
+ "$ref": "#/definitions/Resource"
65575
+ },
65576
+ "type": "array"
65577
+ },
65578
+ "extension": {
65579
+ "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
65580
+ "items": {
65581
+ "$ref": "#/definitions/Extension"
65582
+ },
65583
+ "type": "array"
65584
+ },
65585
+ "modifierExtension": {
65586
+ "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
65587
+ "items": {
65588
+ "$ref": "#/definitions/Extension"
65589
+ },
65590
+ "type": "array"
65591
+ },
65592
+ "study": {
65593
+ "description": "The study that this DICOM instance belongs to.",
65594
+ "$ref": "#/definitions/Reference"
65595
+ },
65596
+ "series": {
65597
+ "description": "The series that this DICOM instance belongs to.",
65598
+ "$ref": "#/definitions/Reference"
65599
+ },
65600
+ "sopClassUid": {
65601
+ "description": "The SOP Class UID of the DICOM instance.",
65602
+ "$ref": "#/definitions/id"
65603
+ },
65604
+ "sopInstanceUid": {
65605
+ "description": "The SOP Instance UID of the DICOM instance.",
65606
+ "$ref": "#/definitions/id"
65607
+ },
65608
+ "instanceAvailability": {
65609
+ "description": "The availability of the DICOM instance.",
65610
+ "$ref": "#/definitions/code"
65611
+ },
65612
+ "timezoneOffsetFromUtc": {
65613
+ "description": "The timezone offset from UTC for the study (e.g., -0700).",
65614
+ "$ref": "#/definitions/string"
65615
+ },
65616
+ "instanceNumber": {
65617
+ "description": "The number of the instance in the study.",
65618
+ "$ref": "#/definitions/string"
65619
+ },
65620
+ "rows": {
65621
+ "description": "The number of rows in the image.",
65622
+ "$ref": "#/definitions/unsignedInt"
65623
+ },
65624
+ "columns": {
65625
+ "description": "The number of columns in the image.",
65626
+ "$ref": "#/definitions/unsignedInt"
65627
+ },
65628
+ "bitsAllocated": {
65629
+ "description": "The number of bits allocated for each pixel.",
65630
+ "$ref": "#/definitions/unsignedInt"
65631
+ },
65632
+ "numberOfFrames": {
65633
+ "description": "The number of frames in the image.",
65634
+ "$ref": "#/definitions/unsignedInt"
65635
+ },
65636
+ "metadata": {
65637
+ "description": "The DICOM metadata of the instance, typically stored as a JSON string containing the DICOM tags and their values.",
65638
+ "$ref": "#/definitions/string"
65639
+ },
65640
+ "raw": {
65641
+ "description": "The raw binary data of the DICOM instance, typically stored as a reference to a Binary resource containing the DICOM file.",
65642
+ "$ref": "#/definitions/Reference"
65643
+ },
65644
+ "pixelData": {
65645
+ "description": "The pixel data of the DICOM instance, typically stored as a reference to a Binary resource containing the pixel data. This is an alternative to rawData for cases where the pixel data is stored separately from the full DICOM file.",
65646
+ "items": {
65647
+ "$ref": "#/definitions/Reference"
65648
+ },
65649
+ "type": "array"
65650
+ }
65651
+ },
65652
+ "additionalProperties": false,
65653
+ "required": [
65654
+ "resourceType",
65655
+ "study",
65656
+ "series",
65657
+ "sopClassUid",
65658
+ "sopInstanceUid",
65659
+ "metadata",
65660
+ "raw"
65661
+ ]
65299
65662
  }
65300
65663
  }
65301
65664
  }