DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 2). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

6.2 Resource Media - Content

FHIR Infrastructure Work Group Maturity Level : 1 Compartments : Device , Patient , Practitioner

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

6.2.1 Scope and Usage

The Media resource contains photos, videos, and audio recordings. It is used with media acquired or used as part of the healthcare process. Here are some typical usages:

  • Photos of patients and staff for identification purposes
  • Photos and videos of diagnostic or care provision procedures for recording purposes
  • Storing scans and faxes of paper documents where not enough metadata exists to create a DocumentReference
  • Images on diagnostic reports

The Media resource may contain medical images in a DICOM format. While such images may also be accessible through an ImagingStudy resource, the Media resource enables "ready for presentation" access to a specific image. Such images would preferentially be made available in a FHIR ecosystem by the Media.content.url providing a reference to a WADO-RS service to access the image. That WADO-RS service may include rendering the image with annotations and display parameters from an associated DICOM presentation state. Although the Media resource is allowed to contain images collected by a DICOM based system, DICOM images would preferentially be made available in a FHIR ecosystem by provision of a resource with references to a WADO-RS server .

This resource is referenced by diagnosticreport

6.2.2 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
.. Media I DomainResource A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
Height can only be used for a photo or video
Width can only be used for a photo or video
Duration can only be used for an audio or a video
Frames can only be used for a photo
... type Σ 1..1 code photo | video | audio
DigitalMediaType ( Required )
... subtype Σ 0..1 CodeableConcept The type of acquisition equipment/process
Media SubType ( Example )
... identifier Σ 0..* Identifier Identifier(s) for the image
... subject Σ 0..1 Reference ( Patient | Practitioner | Group | Device | Specimen ) Who/What this Media is a record of
... operator Σ 0..1 Reference ( Practitioner ) The person who generated the image
... view Σ 0..1 CodeableConcept Imaging view, e.g. Lateral or Antero-posterior
Media Collection View/Projection ( Example )
... deviceName Σ 0..1 string Name of the device/manufacturer
... height Σ I 0..1 positiveInt Height of the image in pixels (photo/video)
... width Σ I 0..1 positiveInt Width of the image in pixels (photo/video)
... frames Σ I 0..1 positiveInt Number of frames if > 1 (photo)
... duration Σ I 0..1 unsignedInt Length in seconds (audio / video)
... content 1..1 Attachment Actual Media - reference or data

doco Documentation for this format

UML Diagram

Media ( Resource DomainResource ) Whether the media is a photo (still image), an audio recording, or a video recording type : code 1..1 << [1..1] « Whether the Media is a photo, video, or audio (Strength=Required) MediaType >> DigitalMediaType ! » 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 subtype : CodeableConcept 0..1 << [0..1] « Detailed information about the type of the image - it's its kind, purpose, or the kind of equipment used to generate it (Strength=Example) MediaSubtype Media SubType >> ?? » 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 identifier : Identifier 0..* [0..*] When Who/What this Media is a record of subject : Reference [0..1] « Patient | Practitioner | Group | Device | Specimen » The person who administered the media collection of the image operator : Reference [0..1] « Practitioner » The name of the imaging view e.g. Lateral or Antero-posterior (AP) view : CodeableConcept [0..1] « Imaging view (projection) used when collecting an image (Strength=Example) Media Collection View/Project... ?? » The name of the device / manufacturer of the device that was originally recorded. For video used to make the recording deviceName : string [0..1] Height of the image in pixels (photo/video) height : positiveInt [0..1] Width of the image in pixels (photo/video) width : positiveInt [0..1] 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 frames : positiveInt [0..1] The duration of the recording in seconds - for audio and audio, if video duration : unsignedInt [0..1] The actual content of the length media - inline or by direct reference to the media source file content : Attachment [1..1]

Structure

Name Flags Card. Type Description & Constraints doco
.. Media I DomainResource A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
Height can only be used for a photo or video
Width can only be used for a photo or video
Duration can only be used for an audio or a video
Frames can only be used for a photo
... type Σ 1..1 code photo | video | audio
DigitalMediaType ( Required )
... subtype Σ 0..1 CodeableConcept The type of acquisition equipment/process
Media SubType ( Example )
... identifier Σ 0..* Identifier Identifier(s) for the image
... subject Σ 0..1 Reference ( Patient | Practitioner | Group | Device | Specimen ) Who/What this Media is a record of
... operator Σ 0..1 Reference ( Practitioner ) The person who generated the image
... view Σ 0..1 CodeableConcept Imaging view, e.g. Lateral or Antero-posterior
Media Collection View/Projection ( Example )
... deviceName Σ 0..1 string Name of the device/manufacturer
... height Σ I 0..1 positiveInt Height of the image in pixels (photo/video)
... width Σ I 0..1 positiveInt Width of the image in pixels (photo/video)
... frames Σ I 0..1 positiveInt Number of frames if > 1 (photo)
... duration Σ I 0..1 unsignedInt Length in seconds (audio / video)
... content 1..1 Attachment Actual Media - reference or data

doco Documentation for this format

UML Diagram

Media ( DomainResource ) Whether the media is a photo (still image), an audio recording, or a video recording type : code [1..1] « Whether the Media is not insignificant, a photo, video, or audio (Strength=Required) DigitalMediaType ! » 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 end modality subtype : CodeableConcept [0..1] « Detailed information about the type of the recording image - its kind, purpose, or the kind of equipment used to generate it (Strength=Example) dateTime Media SubType ?? » 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 identifier : dateTime Identifier 0..1 [0..*] Who/What this Media is a record of subject : Resource Reference ( [0..1] « Patient | Practitioner | Group | Device | Specimen ) 0..1 » The person who administered the collection of the image operator : Resource Reference ( [0..1] « Practitioner ) 0..1 » The name of the imaging view e.g e.g. Lateral or Antero-posterior (AP) view : CodeableConcept 0..1 << [0..1] « Imaging view (projection) used when collecting an image (Strength=Example) MediaView Media Collection View/Project... >> ?? » The name of the device / manufacturer of the device that was used to make the recording deviceName : string 0..1 [0..1] Height of the image in pixels(photo/video) pixels (photo/video) height : integer positiveInt 0..1 [0..1] Width of the image in pixels (photo/video) width : integer positiveInt 0..1 [0..1] 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 frames : integer positiveInt 0..1 [0..1] The length duration of the recording in seconds - for audio and video length duration : integer unsignedInt 0..1 [0..1] The actual content of the media - inline or by direct reference to the media source file content : Attachment 1..1 [1..1] This resource is referenced by DiagnosticReport and DocumentManifest

XML Template

< <!-- from --> < <</subtype> <</identifier> < < Who/What this Media is a record of</subject> <</operator> <</view> < < < < < <</content>

 

Alternate definitions: Schema / Schematron , Resource Profile ( XML , JSON ), Questionnaire

6.2.2.1 Terminology Bindings

Path Definition Type Reference
Media.type Whether the Media is a photo, video, or audio Fixed Required http://hl7.org/fhir/media-type DigitalMediaType
Media.subtype Detailed information about the type of the image - it's its kind, purpose, or the kind of equipment used to generate it Example http://hl7.org/fhir/vs/media-subtype Media SubType
Media.view Imaging view (projection) used when collecting an image Example http://hl7.org/fhir/vs/media-view Media Collection View/Projection

6.2.2.2 Constraints

  • Inv-1 mda-1 : Height can only be used for a photo or video (xpath: not(f:type/@value='audio') or not(f:height) )
  • Inv-2 mda-2 : Width can only be used for a photo or video (xpath: not(f:type/@value='audio') or not(f:width) )
  • Inv-3 mda-3 : Frames can only be used for a photo (xpath: (f:type/@value='photo') or not(f:frames) )
  • Inv-4 mda-4 : Length Duration can only be used for an audio or a video (xpath: not(f:type/@value='photo') or not(f:length) not(f:duration) )

6.2.3 Search Parameters

Search parameters for this resource. The standard common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Paths
_id token The logical resource id associated with the resource (must be supported by all servers) _language token The language of the resource date created date When the media Date attachment was taken/recorded (end) first created Media.dateTime Media.content.creation
identifier token Identifier(s) for the image Media.identifier
operator reference The person who generated the image Media.operator
( Practitioner )
patient reference Who/What this Media is a record of Media.subject
( Patient )
subject reference Who/What this Media is a record of Media.subject
( Specimen , Device , Patient , Practitioner , Group )
subtype token The type of acquisition equipment/process Media.subtype
type token photo | video | audio Media.type
view token Imaging view e.g view, e.g. Lateral or Antero-posterior Media.view
var disqus_shortname = 'fhirdstu';(function() {var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); Please enable JavaScript to view the comments powered by Disqus. comments powered by Disqus var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-676355-1']); _gaq.push(['_setDomainName', '.hl7.org']); _gaq.push(['_trackPageview']); (function()