| Imaging UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"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 |
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 |
"Date and time the study started" - HL7 FHIR, ImagingStudy.started |
String | description |
"Institution-generated description or classification of the Study performed." - HL7 FHIR, ImagingStudy.description |
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 |
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 |
«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. |
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.numberOfInstancesNote 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 |
"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.numberOfSeriesNote 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 |
"Description of clinical condition indicating why the ImagingStudy was requested." - HL7 FHIR, ImagingStudy.reason |
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 |
"Study instance UID of the SOP instances in the selection." - HL7 FHIR, ImagingManifest.study.uid |
Attributes inherited from FHIM::Common::ClinicalStatement | ||
clinicalDataSource, contentVersion, contextCode, encounter, note, recordStatus, relatedClinicalInformation, sourceRecordType, sourceSystem, subjectGroup, subjectOfInformation, subjectOfRecord, temporalContext, topicCode, cosigned, recorded, signed, verified |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ImagingStudy |
Name Expression | |
Namespace | Imaging |
Owned Template Signature | |
Owner | Imaging |
Owning Template Parameter | |
Package | Imaging |
Qualified Name | FHIM::Imaging::ImagingStudy |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
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 | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::availability |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime dateTimeStarted
"Date and time the study started" - HL7 FHIR, ImagingStudy.started
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
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 | dateTimeStarted |
Name Expression | |
Namespace | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::dateTimeStarted |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String description
"Institution-generated description or classification of the Study performed." - HL7 FHIR, ImagingStudy.description
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
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 | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::description |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
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 | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::endpoint |
Stereotype | |
Template Parameter | |
Type | ElectronicServiceEndpoint |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
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 | interpreter |
Name Expression | |
Namespace | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::interpreter |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
Terminologies | [ HL7_FHIR_R4 Acquisition Modality 1.2.840.10008.6.1.19 ] |
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 | * |
Name | modalityList |
Name Expression | |
Namespace | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::modalityList |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.numberOfInstancesNote that we have marked this property as derived because this information may be calculated based on the instances that makes up the study.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
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 | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::numberOfInstances |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.numberOfSeriesNote that we have marked this property as derived because this information may be calculated based on the series that makes up the study.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
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 | 1 |
Lower Value | (1) |
Multiplicity | 1..* |
Name | numberOfSeries |
Name Expression | |
Namespace | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::numberOfSeries |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code reason
"Description of clinical condition indicating why the ImagingStudy was requested." - HL7 FHIR, ImagingStudy.reason
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
Terminologies | [ HL7_FHIR_R4 Procedure Reason Codes http://hl7.org/fhir/ValueSet/procedure-reason ] |
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 | reason |
Name Expression | |
Namespace | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::reason |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | Composite |
Alias | |
Association | study_series |
Association End | |
Class | ImagingStudy |
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 | series |
Name Expression | |
Namespace | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::series |
Stereotype | |
Template Parameter | |
Type | Series |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public String uid
"Study instance UID of the SOP instances in the selection." - HL7 FHIR, ImagingManifest.study.uid
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingStudy |
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 | ImagingStudy |
Opposite | |
Owner | ImagingStudy |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingStudy::uid |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Imaging UML Documentation |
Summary:AttributesProperties | Detail:Attributes |