Imaging
Class ImageInstance

This class contains an electronic representation of an optical counterpart or appearance of an object along with metadata to help identify, locate, and classify the image. This class is to be used for both clinical images which may be managed using a PACS and for scanned documents and other informal images.
"A single SOP Instance within the series, e.g. an image, or presentation state." - HL7 FHIR, ImagingStudy.series.instance

Attributes
Image content content

An electronic representation of an optical counterpart or appearance of an object. This property contains the binary data of the image.

Frame frame frame

"Identity and location information of the frames in the selected instance." - HL7 FHIR, ImagingObjectSelection.study.series.instance.frames

Integer instanceNumber instanceNumber

"The number of instance in the series." - HL7 FHIR, ImagingStudy.series.instance.number

String pacsUID pacsUID

When an image is created from an external PACS system, this property will contain the unique identifier for the image within that system.
"Formal identifier for this image or other content." - HL7 FHIR, ImagingStudy.series.instance.uid

String sopClass sopClass

"DICOM instance type." - HL7 FHIR, ImagingStudy.series.instance.sopClass
"SOP class UID of the selected instance." - HL7 FHIR, ImagingManifest.study.series.instance.sopClass
Note that in FHIR, the data type for this property is an oid. We may wish to make it a code.

String title title

"The description of the instance." - HL7 FHIR, ImagingStudy.series.instance.title

String type type

"A human-friendly SOP Class name." - HL7 FHIR, ImagingStudy.series.instance.type

String uid uid

"SOP Instance UID of the selected instance." - HL7 FHIR, ImagingManifest.study.series.instance.uid


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameImageInstance
Name Expression
NamespaceImaging
Owned Template Signature
OwnerImaging
Owning Template Parameter
PackageImaging
Qualified NameFHIM::Imaging::ImageInstance
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 content
Public Image content

An electronic representation of an optical counterpart or appearance of an object. This property contains the binary data of the image.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImageInstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namecontent
Name Expression
NamespaceImageInstance
Opposite
OwnerImageInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImageInstance::content
Stereotype
Template Parameter
TypeImage
Upper1
Upper Value(1)
VisibilityPublic


 frame
Public Frame frame

"Identity and location information of the frames in the selected instance." - HL7 FHIR, ImagingObjectSelection.study.series.instance.frames

Constraints:
Properties:

AggregationComposite
Alias
AssociationimageInstance_frame
Association End
ClassImageInstance
Datatype
Default
Default Value
Is Compositetrue
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameframe
Name Expression
NamespaceImageInstance
Opposite
OwnerImageInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImageInstance::frame
Stereotype
Template Parameter
TypeFrame
Upper*
Upper Value(*)
VisibilityPublic


 instanceNumber
Public Integer instanceNumber

"The number of instance in the series." - HL7 FHIR, ImagingStudy.series.instance.number

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImageInstance
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
NameinstanceNumber
Name Expression
NamespaceImageInstance
Opposite
OwnerImageInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImageInstance::instanceNumber
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 pacsUID
Public String pacsUID

When an image is created from an external PACS system, this property will contain the unique identifier for the image within that system.
"Formal identifier for this image or other content." - HL7 FHIR, ImagingStudy.series.instance.uid

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImageInstance
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
NamepacsUID
Name Expression
NamespaceImageInstance
Opposite
OwnerImageInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImageInstance::pacsUID
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 sopClass
Public String sopClass

"DICOM instance type." - HL7 FHIR, ImagingStudy.series.instance.sopClass
"SOP class UID of the selected instance." - HL7 FHIR, ImagingManifest.study.series.instance.sopClass
Note that in FHIR, the data type for this property is an oid. We may wish to make it a code.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImageInstance
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
NamesopClass
Name Expression
NamespaceImageInstance
Opposite
OwnerImageInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImageInstance::sopClass
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 title
Public String title

"The description of the instance." - HL7 FHIR, ImagingStudy.series.instance.title

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImageInstance
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
Nametitle
Name Expression
NamespaceImageInstance
Opposite
OwnerImageInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImageInstance::title
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 type
Public String type

"A human-friendly SOP Class name." - HL7 FHIR, ImagingStudy.series.instance.type

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImageInstance
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
Nametype
Name Expression
NamespaceImageInstance
Opposite
OwnerImageInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImageInstance::type
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 uid
Public String uid

"SOP Instance UID of the selected instance." - HL7 FHIR, ImagingManifest.study.series.instance.uid

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImageInstance
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
Nameuid
Name Expression
NamespaceImageInstance
Opposite
OwnerImageInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Imaging::ImageInstance::uid
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic