DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R4B R4 R3 R2

6.2 Resource Media - Content Resource Media - Content

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
FHIR Infrastructure FHIR Infrastructure Work Group Work Group Maturity Level : 1 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 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

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
  • 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 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 Resource Content

Structure

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

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

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

Structure

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

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

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

  Alternate definitions:

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

6.2.2.1 Terminology Bindings Terminology Bindings

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

6.2.2.2 Constraints Constraints

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

6.2.3 Search Parameters Search Parameters Search parameters for this resource. The common parameters also apply. See

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

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search
Name Type Description Paths
created date Date attachment was first created Date attachment was first created Media.content.creation
identifier token Identifier(s) for the image Identifier(s) for the image Media.identifier
operator reference The person who generated the image The person who generated the image Media.operator
( Practitioner )
patient reference Who/What this Media is a record of Who/What this Media is a record of Media.subject
( Patient )
subject reference Who/What this Media is a record of Who/What this Media is a record of Media.subject
( Specimen , , Device , , Patient , , Practitioner , , Group )
subtype token The type of acquisition equipment/process The type of acquisition equipment/process Media.subtype
type token photo | video | audio photo | video | audio Media.type
view token Imaging view, e.g. Lateral or Antero-posterior Imaging view, e.g. Lateral or Antero-posterior Media.view