ImagingStudy constructor
- @Default(R5ResourceType.ImagingStudy) @JsonKey(unknownEnumValue: R5ResourceType.ImagingStudy) R5ResourceType resourceType,
- @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
- @JsonKey(name: 'id') FhirId? fhirId,
- FhirMeta? meta,
- FhirUri? implicitRules,
- @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
- FhirCode? language,
- @JsonKey(name: '_language') Element? languageElement,
- Narrative? text,
- List<
Resource> ? contained, - @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - List<
FhirExtension> ? modifierExtension, - List<
Identifier> ? identifier, - FhirCode? status,
- @JsonKey(name: '_status') Element? statusElement,
- List<
CodeableConcept> ? modality, - required Reference subject,
- Reference? encounter,
- FhirDateTime? started,
- @JsonKey(name: '_started') Element? startedElement,
- List<
Reference> ? basedOn, - List<
Reference> ? partOf, - Reference? referrer,
- List<
Reference> ? endpoint, - FhirUnsignedInt? numberOfSeries,
- @JsonKey(name: '_numberOfSeries') Element? numberOfSeriesElement,
- FhirUnsignedInt? numberOfInstances,
- @JsonKey(name: '_numberOfInstances') Element? numberOfInstancesElement,
- List<
CodeableReference> ? procedure, - Reference? location,
- List<
CodeableReference> ? reason, - List<
Annotation> ? note, - String? description,
- @JsonKey(name: '_description') Element? descriptionElement,
- List<
ImagingStudySeries> ? series,
ImagingStudy 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.
resourceType
This is a ImagingStudy resource
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta
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.
implicitRules
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.
implicitRulesElement
("_implicitRules") Extensions for implicitRules
language
The base language in which the resource is written.
languageElement
("_language") Extensions for language
text
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.
contained
These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it is
referenced by a resource that provides context/meaning.
extension_
("extension") 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 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 resource and that modifies
the understanding of the element that contains it 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
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.Modifier extensions SHALL NOT change the meaning of any
elements on Resource or DomainResource (including cannot change the
meaning of modifierExtension itself).
identifier
Identifiers for the ImagingStudy such as DICOM Study
Instance UID.
status
The current state of the ImagingStudy resource. This is not the
status of any ServiceRequest or Task resources associated with the
ImagingStudy.
statusElement
("_status") Extensions for status
modality
A list of all the distinct values of series.modality. This may
include both acquisition and non-acquisition modalities.
subject
The subject, typically a patient, of the imaging study.
encounter
The healthcare event (e.g. a patient and healthcare provider
interaction) during which this ImagingStudy is made.
started
Date and time the study started.
startedElement
("_started") Extensions for started
basedOn
A list of the diagnostic requests that resulted in this imaging
study being performed.
partOf
A larger event of which this particular ImagingStudy is a
component or step. For example, an ImagingStudy as part of a procedure.
referrer
The requesting/referring physician.
endpoint
The network service providing access (e.g., query, view, or
retrieval) for the study. See implementation notes for information about
using DICOM endpoints. A study-level endpoint applies to each series in
the study, unless overridden by a series-level endpoint with the same
Endpoint.connectionType.
numberOfSeries
Number of Series in the Study. This value given may be
larger than the number of series elements this Resource contains due to
resource availability, security, or other factors. This element should
be present if any series elements are present.
numberOfSeriesElement
("_numberOfSeries") Extensions for numberOfSeries
numberOfInstances
Number of SOP Instances in Study. This 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
procedure
This field corresponds to the DICOM Procedure Code Sequence
(0008,1032). This is different from the FHIR Procedure resource that may
include the ImagingStudy.
location
The principal physical location where the ImagingStudy was
performed.
reason
Description of clinical condition indicating why the
ImagingStudy was requested, and/or Indicates another resource whose
existence justifies this Study.
note
Per the recommended DICOM mapping, this element is derived from
the Study Description attribute (0008,1030). Observations or findings
about the imaging study should be recorded in another resource, e.g.
Observation, and not in this element.
description
The Imaging Manager description of the study.
Institution-generated description or classification of the Study
(component) performed.
descriptionElement
("_description") Extensions for description
series
Each study has one or more series of images or other content.
Implementation
const factory ImagingStudy({
/// [resourceType] This is a ImagingStudy resource
@Default(R5ResourceType.ImagingStudy)
@JsonKey(unknownEnumValue: R5ResourceType.ImagingStudy)
R5ResourceType resourceType,
@JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
/// [id] The logical id of the resource, as used in the URL for the
/// resource. Once assigned, this value never changes.
@JsonKey(name: 'id') FhirId? fhirId,
/// [meta] 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.
FhirMeta? meta,
/// [implicitRules] 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.
FhirUri? implicitRules,
/// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
@JsonKey(name: '_implicitRules') Element? implicitRulesElement,
/// [language] The base language in which the resource is written.
FhirCode? language,
/// [languageElement] ("_language") Extensions for language
@JsonKey(name: '_language') Element? languageElement,
/// [text] 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.
Narrative? text,
/// [contained] These resources do not have an independent existence apart
/// from the resource that contains them - they cannot be identified
/// independently, nor can they have their own independent transaction
/// scope. This is allowed to be a Parameters resource if and only if it
/// is referenced by a resource that provides context/meaning.
List<Resource>? contained,
/// [extension_] ("extension") 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 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 resource and that
/// modifies the understanding of the element that contains it 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 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.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,
/// [identifier] Identifiers for the ImagingStudy such as DICOM Study
/// Instance UID.
List<Identifier>? identifier,
/// [status] The current state of the ImagingStudy resource. This is not
/// the status of any ServiceRequest or Task resources associated with the
/// ImagingStudy.
FhirCode? status,
/// [statusElement] ("_status") Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [modality] A list of all the distinct values of series.modality. This
/// may include both acquisition and non-acquisition modalities.
List<CodeableConcept>? modality,
/// [subject] The subject, typically a patient, of the imaging study.
required Reference subject,
/// [encounter] The healthcare event (e.g. a patient and healthcare
/// provider interaction) during which this ImagingStudy is made.
Reference? encounter,
/// [started] Date and time the study started.
FhirDateTime? started,
/// [startedElement] ("_started") Extensions for started
@JsonKey(name: '_started') Element? startedElement,
/// [basedOn] A list of the diagnostic requests that resulted in this
/// imaging study being performed.
List<Reference>? basedOn,
/// [partOf] A larger event of which this particular ImagingStudy is a
/// component or step. For example, an ImagingStudy as part of a
/// procedure.
List<Reference>? partOf,
/// [referrer] The requesting/referring physician.
Reference? referrer,
/// [endpoint] The network service providing access (e.g., query, view, or
/// retrieval) for the study. See implementation notes for information
/// about using DICOM endpoints. A study-level endpoint applies to each
/// series in the study, unless overridden by a series-level endpoint with
/// the same Endpoint.connectionType.
List<Reference>? endpoint,
/// [numberOfSeries] Number of Series in the Study. This value given may be
/// larger than the number of series elements this Resource contains due
/// to resource availability, security, or other factors. This element
/// should be present if any series elements are present.
FhirUnsignedInt? numberOfSeries,
/// [numberOfSeriesElement] ("_numberOfSeries") Extensions for
/// numberOfSeries
@JsonKey(name: '_numberOfSeries') Element? numberOfSeriesElement,
/// [numberOfInstances] Number of SOP Instances in Study. This 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,
/// [procedure] This field corresponds to the DICOM Procedure Code Sequence
/// (0008,1032). This is different from the FHIR Procedure resource that
/// may include the ImagingStudy.
List<CodeableReference>? procedure,
/// [location] The principal physical location where the ImagingStudy was
/// performed.
Reference? location,
/// [reason] Description of clinical condition indicating why the
/// ImagingStudy was requested, and/or Indicates another resource whose
/// existence justifies this Study.
List<CodeableReference>? reason,
/// [note] Per the recommended DICOM mapping, this element is derived from
/// the Study Description attribute (0008,1030). Observations or findings
/// about the imaging study should be recorded in another resource, e.g.
/// Observation, and not in this element.
List<Annotation>? note,
/// [description] The Imaging Manager description of the study.
/// Institution-generated description or classification of the Study
/// (component) performed.
String? description,
/// [descriptionElement] ("_description") Extensions for description
@JsonKey(name: '_description') Element? descriptionElement,
/// [series] Each study has one or more series of images or other content.
List<ImagingStudySeries>? series,
}) = _ImagingStudy;