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 acquisitionDevice

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

«TS» PointInTime documentDate 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 pageImageEvent

Pointer to a page (or potentially a group of pages) within the scanned document.

Integer pageQuantity 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::Imaging::ImagingEvent FHIM::Imaging::ImagingEvent
author author, dateTime dateTime, description description, identifier identifier, imageCategory imageCategory, imagingLocation imagingLocation, patient patient

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
NameDocumentImagingEvent
Name Expression
NamespaceImaging
Owned Template Signature
OwnerImaging
Owning Template Parameter
PackageImaging
Qualified NameFHIM::Imaging::DocumentImagingEvent
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 acquisitionDevice
Public DeviceInstance acquisitionDevice

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

Constraints:
Properties:

AggregationNone
Alias
AssociationdocumentImagingEvent_acquisitionDevice
Association End
ClassDocumentImagingEvent
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameacquisitionDevice
Name Expression
NamespaceDocumentImagingEvent
Opposite
OwnerDocumentImagingEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::DocumentImagingEvent::acquisitionDevice
Stereotype
Template Parameter
TypeDeviceInstance
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassDocumentImagingEvent
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
NamedocumentDate
Name Expression
NamespaceDocumentImagingEvent
Opposite
OwnerDocumentImagingEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::DocumentImagingEvent::documentDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 pageImageEvent
Public PageImageEvent pageImageEvent

Pointer to a page (or potentially a group of pages) within the scanned document.

Constraints:
Properties:

AggregationNone
Alias
AssociationdocumentImagingEvent_pageImagingEvent
Association End
ClassDocumentImagingEvent
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*
NamepageImageEvent
Name Expression
NamespaceDocumentImagingEvent
Opposite
OwnerDocumentImagingEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::DocumentImagingEvent::pageImageEvent
Stereotype
Template Parameter
TypePageImageEvent
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassDocumentImagingEvent
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
NamepageQuantity
Name Expression
NamespaceDocumentImagingEvent
Opposite
OwnerDocumentImagingEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::DocumentImagingEvent::pageQuantity
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic