| Imaging UML Documentation |
Imaging
Class DocumentImagingEvent
This class contains attributes associated with scanned documents. Historically, both diagnostic imaging and the scanning and retrieval of paper documents have been included in the "imaging" domain as they both share certain characteristics in terms of the equipment used to store and retrieve the images. Yet a distinction is often made with respect to the amount and type of metadata associated with the images. For example, "Diagnostic Images" are those stored and retrieved in Picture Archive and Communications Systems (PACS) which require certain codified information regarding the modality of the image, body site, etc., and are organized into Studies, Series, Images, and subsets (regions) of images. In contrast, scanned documents do not require any of these metadata. As patient-generated images become more commonplace, we foresee a need to store these images (for example, a patient uses a smart phone to take a picture of a wound and emails it to a clinician) as well. We would foresee such images stored in the "Medical Imaging Event" hierarchy, even if a relatively-empty Study and Series construct would be required to contain such images. However, scanned documents simply need a pointer to the resulting image(s), and we therefore find it useful to continue with a logical separation of the two kinds of images.
Attributes |
DeviceInstance | acquisitionDevice |
Pointer to the individual Device that was used to produce the image.
|
«TS» PointInTime | documentDate |
If the item being scanned is a dated document, this property identifies the date of the document. For example, if on 1/15/2016 a patient's birth certificate dated 6/17/1961 were scanned, this property would contain the birth certificate date (6/17/1961), while the ImagingEvent.dateTime would contain the date that the document was scanned (1/15/2016).
|
PageImageEvent | pageImageEvent |
Pointer to a page (or potentially a group of pages) within the scanned document.
|
Integer | pageQuantity |
The number of paper pages that were scanned at the same time. These pages typically comprise the entire document of interest, but may be only a subset of the original paper document. This property is marked as derived as it will generally be calculated at the time of scanning.
|
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 | DocumentImagingEvent |
Name Expression | |
Namespace | Imaging |
Owned Template Signature | |
Owner | Imaging |
Owning Template Parameter | |
Package | Imaging |
Qualified Name | FHIM::Imaging::DocumentImagingEvent |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
acquisitionDevice
Public DeviceInstance acquisitionDevice
-
Pointer to the individual Device that was used to produce the image.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | documentImagingEvent_acquisitionDevice |
Association End | |
Class | DocumentImagingEvent |
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 | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | acquisitionDevice |
Name Expression | |
Namespace | DocumentImagingEvent |
Opposite | |
Owner | DocumentImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::DocumentImagingEvent::acquisitionDevice |
Stereotype | |
Template Parameter | |
Type | DeviceInstance |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
documentDate
Public «TS» PointInTime documentDate
-
If the item being scanned is a dated document, this property identifies the date of the document. For example, if on 1/15/2016 a patient's birth certificate dated 6/17/1961 were scanned, this property would contain the birth certificate date (6/17/1961), while the ImagingEvent.dateTime would contain the date that the document was scanned (1/15/2016).
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | DocumentImagingEvent |
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 | documentDate |
Name Expression | |
Namespace | DocumentImagingEvent |
Opposite | |
Owner | DocumentImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::DocumentImagingEvent::documentDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
pageImageEvent
Public PageImageEvent pageImageEvent
-
Pointer to a page (or potentially a group of pages) within the scanned document.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | documentImagingEvent_pageImagingEvent |
Association End | |
Class | DocumentImagingEvent |
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 | pageImageEvent |
Name Expression | |
Namespace | DocumentImagingEvent |
Opposite | |
Owner | DocumentImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::DocumentImagingEvent::pageImageEvent |
Stereotype | |
Template Parameter | |
Type | PageImageEvent |
Upper | * |
Upper Value | (*) |
Visibility | Public |
pageQuantity
Public Integer pageQuantity
-
The number of paper pages that were scanned at the same time. These pages typically comprise the entire document of interest, but may be only a subset of the original paper document. This property is marked as derived as it will generally be calculated at the time of scanning.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | DocumentImagingEvent |
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 | pageQuantity |
Name Expression | |
Namespace | DocumentImagingEvent |
Opposite | |
Owner | DocumentImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::DocumentImagingEvent::pageQuantity |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Imaging UML Documentation |