ImagingStudy class
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.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
ImagingStudy({@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.
constfactory
-
ImagingStudy.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- ImagingStudy.fromJsonString(String source)
-
Acts like a constructor, returns a ImagingStudy, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- ImagingStudy.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
basedOn
→ List<
Reference> ? -
basedOn A list of the diagnostic requests that resulted in this
imaging study being performed.
no setterinherited
-
contained
→ List<
Resource> ? -
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.
no setterinherited
-
copyWith
→ $ImagingStudyCopyWith<
ImagingStudy> -
no setterinherited
- dbId → int?
-
no setterinherited
- description → String?
-
description The Imaging Manager description of the study.
Institution-generated description or classification of the Study
(component) performed.
no setterinherited
- descriptionElement → Element?
-
descriptionElement ("_description") Extensions for description
no setterinherited
- encounter → Reference?
-
encounter The healthcare event (e.g. a patient and healthcare
provider interaction) during which this ImagingStudy is made.
no setterinherited
-
endpoint
→ List<
Reference> ? -
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.
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier Identifiers for the ImagingStudy such as DICOM Study
Instance UID.
no setterinherited
- implicitRules → FhirUri?
-
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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- location → Reference?
-
location The principal physical location where the ImagingStudy was
performed.
no setterinherited
- meta → FhirMeta?
-
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.
no setterinherited
-
modality
→ List<
CodeableConcept> ? -
modality A list of all the distinct values of series.modality. This
may include both acquisition and non-acquisition modalities.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
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).
no setterinherited
-
note
→ List<
Annotation> ? -
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.
no setterinherited
- numberOfInstances → FhirUnsignedInt?
-
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.
no setterinherited
- numberOfInstancesElement → Element?
-
numberOfInstancesElement ("_numberOfInstances") Extensions for
numberOfInstances
no setterinherited
- numberOfSeries → FhirUnsignedInt?
-
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.
no setterinherited
- numberOfSeriesElement → Element?
-
numberOfSeriesElement ("_numberOfSeries") Extensions for
numberOfSeries
no setterinherited
-
partOf
→ List<
Reference> ? -
partOf A larger event of which this particular ImagingStudy is a
component or step. For example, an ImagingStudy as part of a
procedure.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
procedure
→ List<
CodeableReference> ? -
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.
no setterinherited
-
reason
→ List<
CodeableReference> ? -
reason Description of clinical condition indicating why the
ImagingStudy was requested, and/or Indicates another resource whose
existence justifies this Study.
no setterinherited
- referrer → Reference?
-
referrer The requesting/referring physician.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a ImagingStudy resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
series
→ List<
ImagingStudySeries> ? -
series Each study has one or more series of images or other content.
no setterinherited
- started → FhirDateTime?
-
started Date and time the study started.
no setterinherited
- startedElement → Element?
-
startedElement ("_started") Extensions for started
no setterinherited
- status → FhirCode?
-
status The current state of the ImagingStudy resource. This is not
the status of any ServiceRequest or Task resources associated with the
ImagingStudy.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- subject → Reference
-
subject The subject, typically a patient, of the imaging study.
no setterinherited
- text → Narrative?
-
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.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited