| Imaging UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"Each study has one or more series of images or other content." - HL7 FHIR, ImagingStudy.series
Attributes | ||
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 |
«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 |
«TS» PointInTime | dateTime |
"The date and time the series was started." - HL7 FHIR, ImagingStudy.series.started |
String | description |
"A description of the series." - HL7 FHIR, ImagingStudy.series.description |
DeviceInstance | deviceInstance |
Pointer to the individual Device that was used to produce the image. |
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 |
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 |
"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 |
"The modality of this series sequence." - HL7 FHIR, ImagingStudy.series.modality |
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.numberOfInstancesNote 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 |
"The numeric identifier of this series in the study." - HL7 FHIR, ImagingStudy.series.number |
String | uid |
"Series instance UID of the SOP instances in the selection." - HL7 FHIR, ImagingManifest.study.series.uid |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | Series |
Name Expression | |
Namespace | Imaging |
Owned Template Signature | |
Owner | Imaging |
Owning Template Parameter | |
Package | Imaging |
Qualified Name | FHIM::Imaging::Series |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | availability |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::availability |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Terminologies | [ HL7_FHIR_R4 SNOMED CT Body Structures http://hl7.org/fhir/ValueSet/body-site ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | bodySite |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::bodySite |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime dateTime
"The date and time the series was started." - HL7 FHIR, ImagingStudy.series.started
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | dateTime |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::dateTime |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String description
"A description of the series." - HL7 FHIR, ImagingStudy.series.description
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | description |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::description |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public DeviceInstance deviceInstance
Pointer to the individual Device that was used to produce the image.
Aggregation | None |
Alias | |
Association | series_deviceInstance |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | deviceInstance |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::deviceInstance |
Stereotype | |
Template Parameter | |
Type | DeviceInstance |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | endpoint |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::endpoint |
Stereotype | |
Template Parameter | |
Type | ElectronicServiceEndpoint |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | Composite |
Alias | |
Association | series_imageInstance |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | true |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | imageInstance |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::imageInstance |
Stereotype | |
Template Parameter | |
Type | ImageInstance |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Terminologies | [ HL7_FHIR_R4 Laterality http://hl7.org/fhir/ValueSet/bodysite-laterality ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | laterality |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::laterality |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code modality
"The modality of this series sequence." - HL7 FHIR, ImagingStudy.series.modality
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Terminologies | [ HL7_FHIR_R4 Acquisition Modality 1.2.840.10008.6.1.19 ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | modality |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::modality |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.numberOfInstancesNote that we have marked this property as derived because this information may be calculated based on the instances that makes up the series.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | numberOfInstances |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::numberOfInstances |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Integer seriesNumber
"The numeric identifier of this series in the study." - HL7 FHIR, ImagingStudy.series.number
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | seriesNumber |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::seriesNumber |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String uid
"Series instance UID of the SOP instances in the selection." - HL7 FHIR, ImagingManifest.study.series.uid
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Series |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | uid |
Name Expression | |
Namespace | Series |
Opposite | |
Owner | Series |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::Series::uid |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Imaging UML Documentation |
Summary:AttributesProperties | Detail:Attributes |