Imaging
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." - HL7 FHIR, ImagingStudy.

Attributes
String availability availability

This property indicates whether the image is immediately available, or is stored on a medium that must be located (if available) and loaded. The need for a field like this is based on older technology and is arguably not needed anymore, but is still commonly used in older standards. FHIM is retaining this property for backwards-compatibility to FHIR, but is modeling the property as a string rather than a code in order to avoid the need to maintain a standardized value-set.
"Availability of study (online, offline or nearline)." - HL7 FHIR, ImagingStudy.availability.

«TS» PointInTime dateTimeStarted dateTimeStarted

"Date and time the study started" - HL7 FHIR, ImagingStudy.started

String description description

"Institution-generated description or classification of the Study performed." - HL7 FHIR, ImagingStudy.description

ElectronicServiceEndpoint endpoint 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.type." - HL7 FHIR, ImagingStudy.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.type." - HL7 FHIR, ImagingManifest.study.endpoint

PractitionerParticipation interpreter interpreter

A Provider who is specially trained to arrive at a diagnosis by exercising clinical judgement based on numerical or visual evidence. This is the person who developed a diagnosis based on the content of the Imaging Study.
"Who read the study and interpreted the images or other content." - HL7 FHIR, ImagingStudy.interpreter

«CS» Code modalityList modalityList

"A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19)" - HL7 FHIR, ImagingStudy.modalityList.
Note that we have marked this property as derived because this information may be calculated based on the modalities of the series that makes up the study.

Integer numberOfInstances 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." - HL7 FHIR, ImagingStudy.numberOfInstances
Note that we have marked this property as derived because this information may be calculated based on the instances that makes up the study.

Integer numberOfSeries 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." - HL7 FHIR, ImagingStudy.numberOfSeries
Note that we have marked this property as derived because this information may be calculated based on the series that makes up the study.

«CS» Code reason reason

"Description of clinical condition indicating why the ImagingStudy was requested." - HL7 FHIR, ImagingStudy.reason

Series series series

"Each study has one or more series of images or other content." - HL7 FHIR, ImagingStudy.series
"Series identity and locating information of the DICOM SOP instances in the selection." - HL7 FHIR, ImagingManifest.study.series

String uid uid

"Study instance UID of the SOP instances in the selection." - HL7 FHIR, ImagingManifest.study.uid

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contentVersion contentVersion, contextCode contextCode, encounter encounter, note note, recordStatus recordStatus, relatedClinicalInformation relatedClinicalInformation, sourceRecordType sourceRecordType, sourceSystem sourceSystem, subjectGroup subjectGroup, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord, temporalContext temporalContext, topicCode topicCode, cosigned cosigned, recorded recorded, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameImagingStudy
Name Expression
NamespaceImaging
Owned Template Signature
OwnerImaging
Owning Template Parameter
PackageImaging
Qualified NameFHIM::Imaging::ImagingStudy
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 availability
Public String availability

This property indicates whether the image is immediately available, or is stored on a medium that must be located (if available) and loaded. The need for a field like this is based on older technology and is arguably not needed anymore, but is still commonly used in older standards. FHIM is retaining this property for backwards-compatibility to FHIR, but is modeling the property as a string rather than a code in order to avoid the need to maintain a standardized value-set.
"Availability of study (online, offline or nearline)." - HL7 FHIR, ImagingStudy.availability.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameavailability
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::availability
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeStarted
Public «TS» PointInTime dateTimeStarted

"Date and time the study started" - HL7 FHIR, ImagingStudy.started

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedateTimeStarted
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::dateTimeStarted
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 description
Public String description

"Institution-generated description or classification of the Study performed." - HL7 FHIR, ImagingStudy.description

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedescription
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::description
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 endpoint
Public ElectronicServiceEndpoint 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.type." - HL7 FHIR, ImagingStudy.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.type." - HL7 FHIR, ImagingManifest.study.endpoint

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameendpoint
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::endpoint
Stereotype
Template Parameter
TypeElectronicServiceEndpoint
Upper*
Upper Value(*)
VisibilityPublic


 interpreter
Public PractitionerParticipation interpreter

A Provider who is specially trained to arrive at a diagnosis by exercising clinical judgement based on numerical or visual evidence. This is the person who developed a diagnosis based on the content of the Imaging Study.
"Who read the study and interpreted the images or other content." - HL7 FHIR, ImagingStudy.interpreter

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameinterpreter
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::interpreter
Stereotype
Template Parameter
TypePractitionerParticipation
Upper*
Upper Value(*)
VisibilityPublic


 modalityList
Public «CS» Code modalityList

"A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19)" - HL7 FHIR, ImagingStudy.modalityList.
Note that we have marked this property as derived because this information may be calculated based on the modalities of the series that makes up the study.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Terminologies[
HL7_FHIR_R4 Acquisition Modality 1.2.840.10008.6.1.19
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamemodalityList
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::modalityList
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 numberOfInstances
Public Integer 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." - HL7 FHIR, ImagingStudy.numberOfInstances
Note that we have marked this property as derived because this information may be calculated based on the instances that makes up the study.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamenumberOfInstances
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::numberOfInstances
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 numberOfSeries
Public Integer 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." - HL7 FHIR, ImagingStudy.numberOfSeries
Note that we have marked this property as derived because this information may be calculated based on the series that makes up the study.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..*
NamenumberOfSeries
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::numberOfSeries
Stereotype
Template Parameter
TypeInteger
Upper*
Upper Value(*)
VisibilityPublic


 reason
Public «CS» Code reason

"Description of clinical condition indicating why the ImagingStudy was requested." - HL7 FHIR, ImagingStudy.reason

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Terminologies[
HL7_FHIR_R4 Procedure Reason Codes http://hl7.org/fhir/ValueSet/procedure-reason
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namereason
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::reason
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 series
Public Series series

"Each study has one or more series of images or other content." - HL7 FHIR, ImagingStudy.series
"Series identity and locating information of the DICOM SOP instances in the selection." - HL7 FHIR, ImagingManifest.study.series

Constraints:
Properties:

AggregationComposite
Alias
Associationstudy_series
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositetrue
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameseries
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::series
Stereotype
Template Parameter
TypeSeries
Upper*
Upper Value(*)
VisibilityPublic


 uid
Public String uid

"Study instance UID of the SOP instances in the selection." - HL7 FHIR, ImagingManifest.study.uid

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImagingStudy
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameuid
Name Expression
NamespaceImagingStudy
Opposite
OwnerImagingStudy
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImagingStudy::uid
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic