Datatypes UML Documentation

Element

Datatypes
Class Image

This class represents an Image, particularly but not limited to, diagnostic images. The class may also be used for scanned documents and incoming facsimiles.
Note that this class is equivalent to a the FHIR Attachment data type.

Attributes
«CS» Code	contentType	"Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate." - HL7 FHIR, Attachment.contentType. The FHIM will likely use the system at OID: 2.16.840.1.113883.5.79. See the IANA site at: http://www.iana.org/assignments/media-types/media-types.xhtml
String	data	Contains the image itself. Note that while this property is modeled as a string, this will usually be implemented using a binary representation such as base64. "The actual data of the attachment - a sequence of bytes. In XML, represented using base64." - HL7 FHIR, Attachment.data.
«TS» PointInTime	dateCreated	"The date that the attachment was first created." - HL7 FHIR, Attachment.creation.
String	hash	A hash function is any function that can be used to map data of arbitrary size to data of fixed size. Note that while this property is modeled as a string, this will usually be implemented using a binary representation such as base64. "The calculated hash of the data using SHA-1. Represented using base64." - HL7 FHIR, Attachment.hash.
«CS» Code	language	"The human language of the content. The value can be any valid value according to BCP 47." - HL7 FHIR, Attachment.language.
Integer	size	"The number of bytes of data that make up this attachment." - HL7 FHIR, Attachment.size.
String	title	"A label or set of text to display in place of the data." - HL7 FHIR, Attachment.title.
String	url	"An alternative location where the data can be accessed." - HL7 FHIR, Attachment.url.

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	Image
Name Expression
Namespace	Datatypes
Owned Template Signature
Owner	Datatypes
Owning Template Parameter
Package	Datatypes
Qualified Name	FHIM::Datatypes::Image
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

contentType

Public «CS» Code contentType

"Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate." - HL7 FHIR, Attachment.contentType.
The FHIM will likely use the system at OID: 2.16.840.1.113883.5.79. See the IANA site at: http://www.iana.org/assignments/media-types/media-types.xhtml

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Image
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	contentType
Name Expression
Namespace	Image
Opposite
Owner	Image
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Image::contentType
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

data

Public String data

Contains the image itself. Note that while this property is modeled as a string, this will usually be implemented using a binary representation such as base64.
"The actual data of the attachment - a sequence of bytes. In XML, represented using base64." - HL7 FHIR, Attachment.data.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Image
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	data
Name Expression
Namespace	Image
Opposite
Owner	Image
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Image::data
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

dateCreated

Public «TS» PointInTime dateCreated

"The date that the attachment was first created." - HL7 FHIR, Attachment.creation.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Image
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	dateCreated
Name Expression
Namespace	Image
Opposite
Owner	Image
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Image::dateCreated
Stereotype
Template Parameter
Type	«TS» PointInTime
Upper	1
Upper Value	(1)
Visibility	Public

hash

Public String hash

A hash function is any function that can be used to map data of arbitrary size to data of fixed size. Note that while this property is modeled as a string, this will usually be implemented using a binary representation such as base64.
"The calculated hash of the data using SHA-1. Represented using base64." - HL7 FHIR, Attachment.hash.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Image
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	hash
Name Expression
Namespace	Image
Opposite
Owner	Image
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Image::hash
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

language

Public «CS» Code language

"The human language of the content. The value can be any valid value according to BCP 47." - HL7 FHIR, Attachment.language.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Image
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	language
Name Expression
Namespace	Image
Opposite
Owner	Image
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Image::language
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

size

Public Integer size

"The number of bytes of data that make up this attachment." - HL7 FHIR, Attachment.size.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Image
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	size
Name Expression
Namespace	Image
Opposite
Owner	Image
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Image::size
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value	(1)
Visibility	Public

title

Public String title

"A label or set of text to display in place of the data." - HL7 FHIR, Attachment.title.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Image
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	title
Name Expression
Namespace	Image
Opposite
Owner	Image
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Image::title
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

url

Public String url

"An alternative location where the data can be accessed." - HL7 FHIR, Attachment.url.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Image
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	url
Name Expression
Namespace	Image
Opposite
Owner	Image
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Datatypes::Image::url
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

Datatypes UML Documentation

Summary:AttributesProperties

Detail:Attributes