| Imaging UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
This class contains those attributes and associations common to both Radiology / Nuclear Medicine imaging examinations and the scanning of paper documents into an image storage and retrieval system. 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 | ||
PractitionerParticipation | author |
Pointer to a Practitioner in the Role of Author. This Practitioner is the person who is responsible for the Imaging Event and who "owns" the Imaging Event record. |
«TS» PointInTime | dateTime |
The date (and optionally time) that the Imaging Event occurred. |
String | description |
This property provides further narrative of the imaging event or of the images that were produced as part of the imaging event. |
«II» Id | identifier |
This property is used to uniquely identify the Imaging Event and therefore the set of images resulting from the Imaging Event. |
String | imageCategory |
A categorization of the image, which can be used for searching and sorting. We can imagine many possible mechanisms or axes by which images can be categorized, but none which can be easily standardized for universal use, so this property is currently modeled as string rather than a code. It is anticipated that this one string field may be implemented by one or more coded and/or non-coded fields in any given implementation depending on the categorization needs of the system.It is noted that the VA's VistA system has several categorization mechanisms that might inform how this field may be used here, for example:VistA table 2005.82 which includes: Administrative, Clinical, Admin/Clinical.VistA table 2005.83VistA table 2005.84 which categorizes the image by specialty/subspecialtyAnother possible axis is to categorize the procedure that generated the image. Possible values include: Colonoscopy, Surgery, Surgical pathology, Radiology. Another possible axis is to categorize the software system or package that generated and/or accesses the image. Possible values include (from the VA): Radiology, Laboratory, Medicine, Clinical Document, Surgery, Photo ID, etc.When the image is a scanned document, this field might be used to identify the kind of document contained in the image. Possible values (from the VA) include: Insurance form, Eligibility form, Patient Rights and Responsibilities form, Means Test form, Allied Veteran form, Appointment of a VSO as claimant's representative, DD214 enlisted record and report of separation, Death certificate, Miscellaneous document, etc. |
ServiceDeliveryLocation | imagingLocation |
Pointer to the organization/location at which the imaging study is to (or did) take place. Note that this property is modeled as zero-to-many in order to handle multiple kinds of organization/location associations such as the ward, bed section, etc. |
Patient | patient |
"The patient imaged in the study." - HL7 FHIR,ImagingStudy.patient |
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 | true |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ImagingEvent |
Name Expression | |
Namespace | Imaging |
Owned Template Signature | |
Owner | Imaging |
Owning Template Parameter | |
Package | Imaging |
Qualified Name | FHIM::Imaging::ImagingEvent |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public PractitionerParticipation author
Pointer to a Practitioner in the Role of Author. This Practitioner is the person who is responsible for the Imaging Event and who "owns" the Imaging Event record.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingEvent |
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 | author |
Name Expression | |
Namespace | ImagingEvent |
Opposite | |
Owner | ImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingEvent::author |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime dateTime
The date (and optionally time) that the Imaging Event occurred.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingEvent |
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 | ImagingEvent |
Opposite | |
Owner | ImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingEvent::dateTime |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String description
This property provides further narrative of the imaging event or of the images that were produced as part of the imaging event.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingEvent |
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 | ImagingEvent |
Opposite | |
Owner | ImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingEvent::description |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «II» Id identifier
This property is used to uniquely identify the Imaging Event and therefore the set of images resulting from the Imaging Event.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingEvent |
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 | identifier |
Name Expression | |
Namespace | ImagingEvent |
Opposite | |
Owner | ImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingEvent::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String imageCategory
A categorization of the image, which can be used for searching and sorting. We can imagine many possible mechanisms or axes by which images can be categorized, but none which can be easily standardized for universal use, so this property is currently modeled as string rather than a code. It is anticipated that this one string field may be implemented by one or more coded and/or non-coded fields in any given implementation depending on the categorization needs of the system.It is noted that the VA's VistA system has several categorization mechanisms that might inform how this field may be used here, for example:VistA table 2005.82 which includes: Administrative, Clinical, Admin/Clinical.VistA table 2005.83VistA table 2005.84 which categorizes the image by specialty/subspecialtyAnother possible axis is to categorize the procedure that generated the image. Possible values include: Colonoscopy, Surgery, Surgical pathology, Radiology. Another possible axis is to categorize the software system or package that generated and/or accesses the image. Possible values include (from the VA): Radiology, Laboratory, Medicine, Clinical Document, Surgery, Photo ID, etc.When the image is a scanned document, this field might be used to identify the kind of document contained in the image. Possible values (from the VA) include: Insurance form, Eligibility form, Patient Rights and Responsibilities form, Means Test form, Allied Veteran form, Appointment of a VSO as claimant's representative, DD214 enlisted record and report of separation, Death certificate, Miscellaneous document, etc.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImagingEvent |
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 | imageCategory |
Name Expression | |
Namespace | ImagingEvent |
Opposite | |
Owner | ImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingEvent::imageCategory |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ServiceDeliveryLocation imagingLocation
Pointer to the organization/location at which the imaging study is to (or did) take place. Note that this property is modeled as zero-to-many in order to handle multiple kinds of organization/location associations such as the ward, bed section, etc.
Aggregation | None |
Alias | |
Association | imagingEvent_imagingLocation |
Association End | |
Class | ImagingEvent |
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 | imagingLocation |
Name Expression | |
Namespace | ImagingEvent |
Opposite | |
Owner | ImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingEvent::imagingLocation |
Stereotype | |
Template Parameter | |
Type | ServiceDeliveryLocation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Patient patient
"The patient imaged in the study." - HL7 FHIR,ImagingStudy.patient
Aggregation | None |
Alias | |
Association | imagingEvent_patient |
Association End | |
Class | ImagingEvent |
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 | patient |
Name Expression | |
Namespace | ImagingEvent |
Opposite | |
Owner | ImagingEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Imaging::ImagingEvent::patient |
Stereotype | |
Template Parameter | |
Type | Patient |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Imaging UML Documentation |
Summary:AttributesProperties | Detail:Attributes |