Imaging
Class Series

"Each study has one or more series of images or other content." - HL7 FHIR, ImagingStudy.series

Attributes
String availability availability

This property indicates whether the image series 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 systems. 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 series (online, offline or nearline)." - HL7 FHIR, ImagingStudy.series.availability

«CS» Code bodySite 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." - HL7 FHIR, ImagingStudy.series.bodySite

«TS» PointInTime dateTime dateTime

"The date and time the series was started." - HL7 FHIR, ImagingStudy.series.started

String description description

"A description of the series." - HL7 FHIR, ImagingStudy.series.description

DeviceInstance deviceInstance deviceInstance

Pointer to the individual Device that was used to produce the image.

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

ImageInstance imageInstance imageInstance

Pointer to the medical image (along with metadata to help identify, locate, and classify the image).
"A single SOP instance within the series, e.g. an image, or presentation state." - HL7 FHIR, ImagingStudy.series.instance
"Identity and locating information of the selected DICOM SOP instances." - HL7 FHIR, ImagingManifest.study.series.instance

«CS» Code 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." - HL7 FHIR, ImagingStudy.series.laterality

«CS» Code modality modality

"The modality of this series sequence." - HL7 FHIR, ImagingStudy.series.modality

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

Integer seriesNumber seriesNumber

"The numeric identifier of this series in the study." - HL7 FHIR, ImagingStudy.series.number

String uid uid

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


Properties:

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

Attribute Details

 availability
Public String availability

This property indicates whether the image series 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 systems. 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 series (online, offline or nearline)." - HL7 FHIR, ImagingStudy.series.availability

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
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
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::availability
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 bodySite
Public «CS» Code 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." - HL7 FHIR, ImagingStudy.series.bodySite

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
Terminologies[
HL7_FHIR_R4 SNOMED CT Body Structures http://hl7.org/fhir/ValueSet/body-site
]
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
NamebodySite
Name Expression
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::bodySite
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 dateTime
Public «TS» PointInTime dateTime

"The date and time the series was started." - HL7 FHIR, ImagingStudy.series.started

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamedateTime
Name Expression
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::dateTime
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 description
Public String description

"A description of the series." - HL7 FHIR, ImagingStudy.series.description

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
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
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::description
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 deviceInstance
Public DeviceInstance deviceInstance

Pointer to the individual Device that was used to produce the image.

Constraints:
Properties:

AggregationNone
Alias
Associationseries_deviceInstance
Association End
ClassSeries
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamedeviceInstance
Name Expression
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::deviceInstance
Stereotype
Template Parameter
TypeDeviceInstance
Upper1
Upper Value(1)
VisibilityPublic


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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
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
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::endpoint
Stereotype
Template Parameter
TypeElectronicServiceEndpoint
Upper*
Upper Value(*)
VisibilityPublic


 imageInstance
Public ImageInstance imageInstance

Pointer to the medical image (along with metadata to help identify, locate, and classify the image).
"A single SOP instance within the series, e.g. an image, or presentation state." - HL7 FHIR, ImagingStudy.series.instance
"Identity and locating information of the selected DICOM SOP instances." - HL7 FHIR, ImagingManifest.study.series.instance

Constraints:
Properties:

AggregationComposite
Alias
Associationseries_imageInstance
Association End
ClassSeries
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*
NameimageInstance
Name Expression
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::imageInstance
Stereotype
Template Parameter
TypeImageInstance
Upper*
Upper Value(*)
VisibilityPublic


 laterality
Public «CS» Code 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." - HL7 FHIR, ImagingStudy.series.laterality

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
Terminologies[
HL7_FHIR_R4 Laterality http://hl7.org/fhir/ValueSet/bodysite-laterality
]
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
Namelaterality
Name Expression
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::laterality
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 modality
Public «CS» Code modality

"The modality of this series sequence." - HL7 FHIR, ImagingStudy.series.modality

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
Terminologies[
HL7_FHIR_R4 Acquisition Modality 1.2.840.10008.6.1.19
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namemodality
Name Expression
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::modality
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
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
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::numberOfInstances
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 seriesNumber
Public Integer seriesNumber

"The numeric identifier of this series in the study." - HL7 FHIR, ImagingStudy.series.number

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameseriesNumber
Name Expression
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::seriesNumber
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 uid
Public String uid

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSeries
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
NamespaceSeries
Opposite
OwnerSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::Series::uid
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic