STU 3 Candidate

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 . Page versions: R4B R4 R3 R2

6.2 Resource Media - Content

FHIR Infrastructure Work GroupMaturity Level: 1Compartments: 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media IDomainResourceA 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
... identifier Σ0..*IdentifierIdentifier(s) for the image
... type Σ1..1codephoto | video | audio
DigitalMediaType (Required)
... subtype Σ0..1CodeableConceptThe type of acquisition equipment/process
Media SubType (Example)
... view Σ0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Media Collection View/Projection (Example)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device | Specimen)Who/What this Media is a record of
... operator Σ0..1Reference(Practitioner)The person who generated the image
... deviceName Σ0..1stringName of the device/manufacturer
... height Σ I0..1positiveIntHeight of the image in pixels (photo/video)
... width Σ I0..1positiveIntWidth of the image in pixels (photo/video)
... frames Σ I0..1positiveIntNumber of frames if > 1 (photo)
... duration Σ I0..1unsignedIntLength in seconds (audio / video)
... content 1..1AttachmentActual Media - reference or data

doco Documentation for this format

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 identifiersidentifier : Identifier [0..*]Whether the media is a photo (still image), an audio recording, or a video recordingtype : code [1..1] « 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 modalitysubtype : CodeableConcept [0..1] « Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it (Strength=Example)Media SubType?? »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...?? »Who/What this Media is a record ofsubject : Reference [0..1] « Patient|Practitioner|Group|Device| Specimen »The person who administered the collection of the imageoperator : Reference [0..1] « Practitioner »The name of the device / manufacturer of the device that was used to make the recordingdeviceName : 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 requiredframes : positiveInt [0..1]The duration of the recording in seconds - for audio and videoduration : unsignedInt [0..1]The actual content of the media - inline or by direct reference to the media source filecontent : Attachment [1..1]

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media IDomainResourceA 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
... identifier Σ0..*IdentifierIdentifier(s) for the image
... type Σ1..1codephoto | video | audio
DigitalMediaType (Required)
... subtype Σ0..1CodeableConceptThe type of acquisition equipment/process
Media SubType (Example)
... view Σ0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Media Collection View/Projection (Example)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device | Specimen)Who/What this Media is a record of
... operator Σ0..1Reference(Practitioner)The person who generated the image
... deviceName Σ0..1stringName of the device/manufacturer
... height Σ I0..1positiveIntHeight of the image in pixels (photo/video)
... width Σ I0..1positiveIntWidth of the image in pixels (photo/video)
... frames Σ I0..1positiveIntNumber of frames if > 1 (photo)
... duration Σ I0..1unsignedIntLength in seconds (audio / video)
... content 1..1AttachmentActual Media - reference or data

doco Documentation for this format

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 identifiersidentifier : Identifier [0..*]Whether the media is a photo (still image), an audio recording, or a video recordingtype : code [1..1] « 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 modalitysubtype : CodeableConcept [0..1] « Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it (Strength=Example)Media SubType?? »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...?? »Who/What this Media is a record ofsubject : Reference [0..1] « Patient|Practitioner|Group|Device| Specimen »The person who administered the collection of the imageoperator : Reference [0..1] « Practitioner »The name of the device / manufacturer of the device that was used to make the recordingdeviceName : 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 requiredframes : positiveInt [0..1]The duration of the recording in seconds - for audio and videoduration : unsignedInt [0..1]The actual content of the media - inline or by direct reference to the media source filecontent : Attachment [1..1]

 

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

6.2.2.1 Terminology Bindings

PathDefinitionTypeReference
Media.type Whether the Media is a photo, video, or audioRequiredDigitalMediaType
Media.subtype Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate itExampleMedia SubType
Media.view Imaging view (projection) used when collecting an imageExampleMedia Collection View/Projection

6.2.2.2 Constraints

  • mda-1: 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 (expression: width.empty() or type != 'audio')
  • mda-3: 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 (expression: duration.empty() or type != 'photo')

6.2.3 Search Parameters

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

NameTypeDescriptionPaths
createddateDate attachment was first createdMedia.content.creation
identifiertokenIdentifier(s) for the imageMedia.identifier
operatorreferenceThe person who generated the imageMedia.operator
(Practitioner)
patientreferenceWho/What this Media is a record ofMedia.subject
(Patient)
subjectreferenceWho/What this Media is a record ofMedia.subject
(Specimen, Device, Patient, Practitioner, Group)
subtypetokenThe type of acquisition equipment/processMedia.subtype
typetokenphoto | video | audioMedia.type
viewtokenImaging view, e.g. Lateral or Antero-posteriorMedia.view