ImagingStudySeries constructor

const ImagingStudySeries({ @JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirId? uid, @JsonKey(name: '_uid') Element? uidElement, FhirUnsignedInt? number, @JsonKey(name: '_number') Element? numberElement, required CodeableConcept modality, String? description, @JsonKey(name: '_description') Element? descriptionElement, FhirUnsignedInt? numberOfInstances, @JsonKey(name: '_numberOfInstances') Element? numberOfInstancesElement, List<Reference>? endpoint, CodeableReference? bodySite, CodeableConcept? laterality, List<Reference>? specimen, FhirDateTime? started, @JsonKey(name: '_started') Element? startedElement, List<ImagingStudyPerformer>? performer, List<ImagingStudyInstance>? instance, })

ImagingStudySeries Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.

modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

uid The DICOM Series Instance UID for the series.

uidElement ("_uid") Extensions for uid

number The numeric identifier of this series in the study.

numberElement ("_number") Extensions for number

modality The distinct modality for this series. This may include both acquisition and non-acquisition modalities.

description A description of the series.

descriptionElement ("_description") Extensions for description

numberOfInstances Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

numberOfInstancesElement ("_numberOfInstances") Extensions for numberOfInstances

endpoint The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.

bodySite The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.

laterality The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.

specimen The specimen imaged, e.g., for whole slide imaging of a biopsy.

started The date and time the series was started.

startedElement ("_started") Extensions for started

performer Indicates who or what performed the series and how they were involved.

instance A single SOP instance within the series, e.g. an image, or presentation state.

Implementation

const factory ImagingStudySeries({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [extension_] ("extension") May be used to represent additional
  ///  information that is not part of the basic definition of the element.
  ///  To make the use of extensions safe and managable, 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] May be used to represent additional information
  ///  that is not part of the basic definition of the element and that
  ///  modifies the understanding of the element in which it is contained
  ///  and/or the understanding of the containing element's descendants.
  ///  Usually modifier elements provide negation or qualification. To make
  ///  the use of extensions safe and managable, 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.
  ///  Applications processing a resource are required to check for modifier
  ///  extensions.Modifier extensions SHALL NOT change the meaning of any
  ///  elements on Resource or DomainResource (including cannot change the
  ///  meaning of modifierExtension itself).
  List<FhirExtension>? modifierExtension,

  /// [uid] The DICOM Series Instance UID for the series.
  FhirId? uid,

  /// [uidElement] ("_uid") Extensions for uid
  @JsonKey(name: '_uid') Element? uidElement,

  /// [number] The numeric identifier of this series in the study.
  FhirUnsignedInt? number,

  /// [numberElement] ("_number") Extensions for number
  @JsonKey(name: '_number') Element? numberElement,

  /// [modality] The distinct modality for this series. This may include both
  ///  acquisition and non-acquisition modalities.
  required CodeableConcept modality,

  /// [description] A description of the series.
  String? description,

  /// [descriptionElement] ("_description") Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [numberOfInstances] Number of SOP Instances in the Study. The value
  ///  given may be larger than the number of instance elements this resource
  ///  contains due to resource availability, security, or other factors.
  ///  This element should be present if any instance elements are present.
  FhirUnsignedInt? numberOfInstances,

  /// [numberOfInstancesElement] ("_numberOfInstances") Extensions for
  ///  numberOfInstances
  @JsonKey(name: '_numberOfInstances') Element? numberOfInstancesElement,

  /// [endpoint] The network service providing access (e.g., query, view, or
  ///  retrieval) for this series. See implementation notes for information
  ///  about using DICOM endpoints. A series-level endpoint, if present, has
  ///  precedence over a study-level endpoint with the same
  ///  Endpoint.connectionType.
  List<Reference>? endpoint,

  /// [bodySite] The anatomic structures examined. See DICOM Part 16 Annex L
  ///  (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.
  ///
  CodeableReference? bodySite,

  /// [laterality] The laterality of the (possibly paired) anatomic
  ///  structures examined. E.g., the left knee, both lungs, or unpaired
  ///  abdomen. If present, shall be consistent with any laterality
  ///  information indicated in ImagingStudy.series.bodySite.
  CodeableConcept? laterality,

  /// [specimen] The specimen imaged, e.g., for whole slide imaging of a
  ///  biopsy.
  List<Reference>? specimen,

  /// [started] The date and time the series was started.
  FhirDateTime? started,

  /// [startedElement] ("_started") Extensions for started
  @JsonKey(name: '_started') Element? startedElement,

  /// [performer] Indicates who or what performed the series and how they
  ///  were involved.
  List<ImagingStudyPerformer>? performer,

  /// [instance] A single SOP instance within the series, e.g. an image, or
  ///  presentation state.
  List<ImagingStudyInstance>? instance,
}) = _ImagingStudySeries;