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 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 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 category

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

Image content 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 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 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 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 deviceName

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

Integer duration duration

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

AbstractEncounter encounter encounter

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

Integer frames 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

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

«II» Id identifier 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 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 note

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

Participation operator operator

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

«ANY» Any partOf partOf

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

«CS» Code reason reason

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

«CS» Code status status
Subject 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 view

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

Integer width width

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


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameMedia
Name Expression
NamespaceCommon
Owned Template Signature
OwnerCommon
Owning Template Parameter
PackageCommon
Qualified NameFHIM::Common::Media
Representation
Stereotype
Template Parameter
VisibilityPublic

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:

AggregationNone
Alias
Association
Association End
ClassMedia
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*
NamebasedOn
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::basedOn
Stereotype
Template Parameter
TypeActionStatement
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
NamebodySite
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::bodySite
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Namecategory
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::category
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::content
Stereotype
Template Parameter
TypeImage
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
NamedateTimeCreated
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::dateTimeCreated
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
NamedateTimeIssued
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::dateTimeIssued
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Namedevice
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::device
Stereotype
Template Parameter
TypeDeviceInstance
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
NamedeviceName
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::deviceName
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 duration
Public Integer duration

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Nameduration
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::duration
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 encounter
Public AbstractEncounter encounter

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Nameencounter
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::encounter
Stereotype
Template Parameter
TypeAbstractEncounter
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Nameframes
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::frames
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 height
Public Integer height

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Nameheight
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::height
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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*
Nameidentifier
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::identifier
Stereotype
Template Parameter
Type«II» Id
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Namemodality
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::modality
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 note
Public Annotation note

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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*
Namenote
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::note
Stereotype
Template Parameter
TypeAnnotation
Upper*
Upper Value(*)
VisibilityPublic


 operator
Public Participation operator

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Nameoperator
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::operator
Stereotype
Template Parameter
TypeParticipation
Upper1
Upper Value(1)
VisibilityPublic


 partOf
Public «ANY» Any partOf

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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*
NamepartOf
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::partOf
Stereotype
Template Parameter
Type«ANY» Any
Upper*
Upper Value(*)
VisibilityPublic


 reason
Public «CS» Code reason

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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*
Namereason
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::reason
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 status
Public «CS» Code status
Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Namestatus
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Namesubject
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::subject
Stereotype
Template Parameter
TypeSubject
Upper1
Upper Value(1)
VisibilityPublic


 view
Public «CS» Code view

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Nameview
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::view
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 width
Public Integer width

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedia
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
Namewidth
Name Expression
NamespaceMedia
Opposite
OwnerMedia
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Media::width
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic