Common UML Documentation

Element

Common
Class Media

"A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference." - HL7 FHIR, Media

Attributes
ActionStatement	basedOn	"A procedure that is fulfilled in whole or in part by the creation of this media." - HL7 FHIR, Media.basedOn Note that in FHIR, this could be a Service Request or a Care Plan. In the FHIM this is currently modeled as any Action Statement.
«CS» Code	bodySite	"Indicates the site on the subject's body where the media was collected (i.e. the target site)." - HL7 FHIR, Media.bodySite
«CS» Code	category	"Whether the media is a photo (still image), an audio recording, or a video recording." - HL7 FHIR, Media.type
Image	content	"The actual content of the media - inline or by direct reference to the media source file." - HL7 FHIR, Media.content
«IVL_TS» Period	dateTimeCreated	"The date and time(s) at which the media was collected." - HL7 FHIR, Media.created[x] Note that FHIR can be a dateTime or a Period. The FHIM is modeled as a Period in order to handle both cases.
«TS» PointInTime	dateTimeIssued	"The date and time this version of the media was made available to providers, typically after having been reviewed." - HL7 FHIR, Media.issued
DeviceInstance	device	"The device used to collect the media." - HL7 FHIR, Media.device Note that FHIR can point to either a Device or a DeviceMetric. FHIM points to DeviceInstance.
String	deviceName	"The name of the device manufacturer of the device that was used to make the recording." - HL7 FHIR, Media.deviceName
Integer	duration	"The duration of the recording in seconds - for audio and video." - HL7 FHIR, Media.duration
AbstractEncounter	encounter	"The encounter that establishes the context for this media." - HL7 FHIR, Media.encounter
Integer	frames	"The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required." - HL7 FHIR, Media.frames
Integer	height	"Height of the image in pixels (photo/video)." - HL7 FHIR, Media.height
«II» Id	identifier	"Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers." - HL7 FHIR, Media.identifier
«CS» Code	modality	"Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality." - HL7 FHIR, Media.modality
Annotation	note	"Comments made about the media by the performer, subject or other participants." - HL7 FHIR, Media.note
Participation	operator	"The person who administered the collection of the image." - HL7 FHIR, Media.operator
«ANY» Any	partOf	"A larger event of which this particular event is a component or step." - HL7 FHIR, Media.partOf
«CS» Code	reason	"Describes why the event occurred in coded or textual form." - HL7 FHIR, Media.reasonCode
«CS» Code	status
Subject	subject	"Who/What this Media is a record of." - HL7 FHIR, Media.subject Note that in FHIR, the subject can be a Patient, Practitioner, Group, Device, or Specimen. In the FHIM, we point to Subject, which points to an Entity, so this can be handled
«CS» Code	view	"The name of the imaging view e.g. Lateral or Antero-posterior (AP)." - HL7 FHIR, Media.view
Integer	width	"Width of the image in pixels (photo/video)." - HL7 FHIR, Media.width

Properties:

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

Attribute Details

basedOn

Public ActionStatement basedOn

"A procedure that is fulfilled in whole or in part by the creation of this media." - HL7 FHIR, Media.basedOn
Note that in FHIR, this could be a Service Request or a Care Plan. In the FHIM this is currently modeled as any Action Statement.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Media
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	basedOn
Name Expression
Namespace	Media
Opposite
Owner	Media
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Media::basedOn
Stereotype
Template Parameter
Type	ActionStatement
Upper	*
Upper Value	(*)
Visibility	Public

bodySite

Public «CS» Code bodySite

"Indicates the site on the subject's body where the media was collected (i.e. the target site)." - HL7 FHIR, Media.bodySite

Constraints:

Properties:

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

category

Public «CS» Code category

"Whether the media is a photo (still image), an audio recording, or a video recording." - HL7 FHIR, Media.type

Constraints:

Properties:

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

content

Public Image content

"The actual content of the media - inline or by direct reference to the media source file." - HL7 FHIR, Media.content

Constraints:

Properties:

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

dateTimeCreated

Public «IVL_TS» Period dateTimeCreated

"The date and time(s) at which the media was collected." - HL7 FHIR, Media.created[x]
Note that FHIR can be a dateTime or a Period. The FHIM is modeled as a Period in order to handle both cases.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Media
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	dateTimeCreated
Name Expression
Namespace	Media
Opposite
Owner	Media
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Media::dateTimeCreated
Stereotype
Template Parameter
Type	«IVL_TS» Period
Upper	1
Upper Value	(1)
Visibility	Public

dateTimeIssued

Public «TS» PointInTime dateTimeIssued

"The date and time this version of the media was made available to providers, typically after having been reviewed." - HL7 FHIR, Media.issued

Constraints:

Properties:

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

device

Public DeviceInstance device

"The device used to collect the media." - HL7 FHIR, Media.device
Note that FHIR can point to either a Device or a DeviceMetric. FHIM points to DeviceInstance.

Constraints:

Properties:

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

deviceName

Public String deviceName

"The name of the device manufacturer of the device that was used to make the recording." - HL7 FHIR, Media.deviceName

Constraints:

Properties:

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

duration

Public Integer duration

"The duration of the recording in seconds - for audio and video." - HL7 FHIR, Media.duration

Constraints:

Properties:

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

encounter

Public AbstractEncounter encounter

"The encounter that establishes the context for this media." - HL7 FHIR, Media.encounter

Constraints:

Properties:

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

frames

Public Integer frames

"The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required." - HL7 FHIR, Media.frames

Constraints:

Properties:

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

height

Public Integer height

"Height of the image in pixels (photo/video)." - HL7 FHIR, Media.height

Constraints:

Properties:

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

identifier

Public «II» Id identifier

"Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers." - HL7 FHIR, Media.identifier

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Media
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	identifier
Name Expression
Namespace	Media
Opposite
Owner	Media
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Media::identifier
Stereotype
Template Parameter
Type	«II» Id
Upper	*
Upper Value	(*)
Visibility	Public

modality

Public «CS» Code modality

"Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality." - HL7 FHIR, Media.modality

Constraints:

Properties:

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

note

Public Annotation note

"Comments made about the media by the performer, subject or other participants." - HL7 FHIR, Media.note

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Media
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	note
Name Expression
Namespace	Media
Opposite
Owner	Media
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Media::note
Stereotype
Template Parameter
Type	Annotation
Upper	*
Upper Value	(*)
Visibility	Public

operator

Public Participation operator

"The person who administered the collection of the image." - HL7 FHIR, Media.operator

Constraints:

Properties:

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

partOf

Public «ANY» Any partOf

"A larger event of which this particular event is a component or step." - HL7 FHIR, Media.partOf

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Media
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	partOf
Name Expression
Namespace	Media
Opposite
Owner	Media
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Media::partOf
Stereotype
Template Parameter
Type	«ANY» Any
Upper	*
Upper Value	(*)
Visibility	Public

reason

Public «CS» Code reason

"Describes why the event occurred in coded or textual form." - HL7 FHIR, Media.reasonCode

Constraints:

Properties:

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

status

Public «CS» Code status

Constraints:

Properties:

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

subject

Public Subject subject

"Who/What this Media is a record of." - HL7 FHIR, Media.subject
Note that in FHIR, the subject can be a Patient, Practitioner, Group, Device, or Specimen. In the FHIM, we point to Subject, which points to an Entity, so this can be handled

Constraints:

Properties:

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

view

Public «CS» Code view

"The name of the imaging view e.g. Lateral or Antero-posterior (AP)." - HL7 FHIR, Media.view

Constraints:

Properties:

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

width

Public Integer width

"Width of the image in pixels (photo/video)." - HL7 FHIR, Media.width

Constraints:

Properties:

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

Overview

Top

Package

Element

Common UML Documentation

Summary:AttributesProperties

Detail:Attributes