This page is part of the FHIR Specification (v3.0.2: STU 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
FHIR Infrastructure Work Group | Maturity Level: 1 | Trial Use | Compartments: Device, Patient, Practitioner |
Detailed Descriptions for the elements in the Media resource.
Media | |
Definition | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. |
Control | 1..1 |
Invariants | Defined on this element mda-1: Height can only be used for a photo or video (expression : height.empty() or type != 'audio', xpath: not(f:type/@value='audio') or not(f:height)) mda-2: Width can only be used for a photo or video (expression : width.empty() or type != 'audio', xpath: not(f:type/@value='audio') or not(f:width)) mda-3: Frames can only be used for a photo (expression : frames.empty() or type = 'photo', xpath: (f:type/@value='photo') or not(f:frames)) mda-4: Duration can only be used for an audio or a video (expression : duration.empty() or type != 'photo', xpath: not(f:type/@value='photo') or not(f:duration)) |
Media.identifier | |
Definition | 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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
Comments | The identifier label and use can be used to determine what kind of identifier it is. |
Media.basedOn | |
Definition | A procedure that is fulfilled in whole or in part by the creation of this media. |
Control | 0..* |
Type | Reference(ProcedureRequest) |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Alternate Names | fulfills |
Summary | true |
Media.type | |
Definition | Whether the media is a photo (still image), an audio recording, or a video recording. |
Control | 1..1 |
Terminology Binding | DigitalMediaType (Required) |
Type | code |
Summary | true |
Media.subtype | |
Definition | 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. |
Control | 0..1 |
Terminology Binding | Media SubType (Example) |
Type | CodeableConcept |
Summary | true |
Media.view | |
Definition | The name of the imaging view e.g. Lateral or Antero-posterior (AP). |
Control | 0..1 |
Terminology Binding | Media Collection View/Projection (Example) |
Type | CodeableConcept |
Summary | true |
Media.subject | |
Definition | Who/What this Media is a record of. |
Control | 0..1 |
Type | Reference(Patient | Practitioner | Group | Device | Specimen) |
Summary | true |
Media.context | |
Definition | The encounter or episode of care that establishes the context for this media. |
Control | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
Requirements | Links the media to the Encounter context. |
Alternate Names | encounter |
Summary | true |
Comments | This will typically be the encounter the media occurred within. |
Media.occurrence[x] | |
Definition | The date and time(s) at which the media was collected. |
Control | 0..1 |
Type | dateTime|Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Alternate Names | timing |
Summary | true |
Media.operator | |
Definition | The person who administered the collection of the image. |
Control | 0..1 |
Type | Reference(Practitioner) |
Summary | true |
Media.reasonCode | |
Definition | Describes why the event occurred in coded or textual form. |
Control | 0..* |
Terminology Binding | Procedure Reason Codes (Example) |
Type | CodeableConcept |
Summary | true |
Comments | Textual reasons can be caprued using reasonCode.text. |
Media.bodySite | |
Definition | Indicates the site on the subject's body where the media was collected (i.e. the target site). |
Control | 0..1 |
Terminology Binding | SNOMED CT Body Structures (Example) |
Type | CodeableConcept |
Summary | true |
Comments | If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use The standard extension body-site-instance. |
Media.device | |
Definition | The device used to collect the media. |
Control | 0..1 |
Type | Reference(Device | DeviceMetric) |
Summary | true |
Comments | An extension should be used if further typing of the device is needed. Scondary devices used to support collecting a media can be represented using either extension or through the Observation.related element. |
Media.height | |
Definition | Height of the image in pixels (photo/video). |
Control | 0..1 |
Type | positiveInt |
Summary | true |
Invariants | Affect this element mda-1: Height can only be used for a photo or video (expression : height.empty() or type != 'audio', xpath: not(f:type/@value='audio') or not(f:height)) |
Media.width | |
Definition | Width of the image in pixels (photo/video). |
Control | 0..1 |
Type | positiveInt |
Summary | true |
Invariants | Affect this element mda-2: Width can only be used for a photo or video (expression : width.empty() or type != 'audio', xpath: not(f:type/@value='audio') or not(f:width)) |
Media.frames | |
Definition | 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. |
Control | 0..1 |
Type | positiveInt |
Default Value | 1 |
Summary | true |
Invariants | Affect this element mda-3: Frames can only be used for a photo (expression : frames.empty() or type = 'photo', xpath: (f:type/@value='photo') or not(f:frames)) |
Media.duration | |
Definition | The duration of the recording in seconds - for audio and video. |
Control | 0..1 |
Type | unsignedInt |
Summary | true |
Comments | The duration might differ from occurrencePeriod if recording was paused. |
Invariants | Affect this element mda-4: Duration can only be used for an audio or a video (expression : duration.empty() or type != 'photo', xpath: not(f:type/@value='photo') or not(f:duration)) |
Media.content | |
Definition | The actual content of the media - inline or by direct reference to the media source file. |
Control | 1..1 |
Type | Attachment |
Comments | Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For an media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching. |
Media.note | |
Definition | Comments made about the media by the performer, subject or other participants. |
Control | 0..* |
Type | Annotation |