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
|
|
Compartments
|
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
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:
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
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
I | DomainResource |
|
|
|
Σ | 0..* | Identifier | Identifier(s) for the image |
![]() ![]() |
Σ | 1..1 | code |
DigitalMediaType |
|
Σ | 0..1 | CodeableConcept |
|
|
Σ |
|
|
Media Collection View/Projection ( Example ) |
|
Σ | 0..1 |
Reference
(
Patient
|
|
|
Σ | 0..1 | Reference ( Practitioner ) |
|
|
Σ | 0..1 | string |
|
|
|
0..1 | positiveInt |
|
|
|
0..1 | positiveInt |
|
|
|
0..1 | positiveInt |
|
|
|
0..1 | unsignedInt |
|
|
1..1 | Attachment |
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<Media xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Identifier(s) for the image --></identifier> <type value="[code]"/><!-- 1..1 photo | video | audio --> <subtype><!-- 0..1 CodeableConcept The type of acquisition equipment/process --></subtype>
<</identifier><view><!-- 0..1 CodeableConcept Imaging view, e.g. Lateral or Antero-posterior --></view> <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device|Specimen) Who/What this Media is a record of --></subject> <operator><!-- 0..1 Reference(Practitioner) The person who generated the image --></operator><</view><deviceName value="[string]"/><!-- 0..1 Name of the device/manufacturer --> <height value="[positiveInt]"/><!--0..1 Height of the image in pixels (photo/video) --> <width value="[positiveInt]"/><!--
0..1 Width of the image in pixels (photo/video) --> <frames value="[positiveInt]"/><!--
0..1 Number of frames if > 1 (photo) --> <duration value="[unsignedInt]"/><!--
0..1 Length in seconds (audio / video) --> <content><!-- 1..1 Attachment Actual Media - reference or data --></content> </Media>
JSON
Template
JSON Template
{
"resourceType" : "Media",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifier(s) for the image
"type" : "<code>", // R! photo | video | audio
"subtype" : { CodeableConcept }, // The type of acquisition equipment/process
"
"view" : { CodeableConcept }, // Imaging view, e.g. Lateral or Antero-posterior
"subject" : { Reference(Patient|Practitioner|Group|Device|Specimen) }, // Who/What this Media is a record of
"operator" : { Reference(Practitioner) }, // The person who generated the image
"
"deviceName" : "<string>", // Name of the device/manufacturer
"height" : "<positiveInt>", // C? Height of the image in pixels (photo/video)
"width" : "<positiveInt>", // C? Width of the image in pixels (photo/video)
"frames" : "<positiveInt>", // C? Number of frames if > 1 (photo)
"duration" : "<unsignedInt>", // C? Length in seconds (audio / video)
"content" : { Attachment } // R! Actual Media - reference or data
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
I | DomainResource |
|
|
|
Σ | 0..* | Identifier | Identifier(s) for the image |
![]() ![]() |
Σ | 1..1 | code |
DigitalMediaType |
|
Σ | 0..1 | CodeableConcept |
|
|
Σ |
|
|
Media Collection View/Projection ( Example ) |
|
Σ | 0..1 |
Reference
(
Patient
|
|
|
Σ | 0..1 | Reference ( Practitioner ) |
|
|
Σ | 0..1 | string |
|
|
|
0..1 | positiveInt |
|
|
|
0..1 | positiveInt |
|
|
|
0..1 | positiveInt |
|
|
|
0..1 | unsignedInt |
|
|
1..1 | Attachment |
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<Media xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Identifier(s) for the image --></identifier> <type value="[code]"/><!-- 1..1 photo | video | audio --> <subtype><!-- 0..1 CodeableConcept The type of acquisition equipment/process --></subtype>
<</identifier><view><!-- 0..1 CodeableConcept Imaging view, e.g. Lateral or Antero-posterior --></view> <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device|Specimen) Who/What this Media is a record of --></subject> <operator><!-- 0..1 Reference(Practitioner) The person who generated the image --></operator><</view><deviceName value="[string]"/><!-- 0..1 Name of the device/manufacturer --> <height value="[positiveInt]"/><!--0..1 Height of the image in pixels (photo/video) --> <width value="[positiveInt]"/><!--
0..1 Width of the image in pixels (photo/video) --> <frames value="[positiveInt]"/><!--
0..1 Number of frames if > 1 (photo) --> <duration value="[unsignedInt]"/><!--
0..1 Length in seconds (audio / video) --> <content><!-- 1..1 Attachment Actual Media - reference or data --></content> </Media>
JSON
Template
JSON Template
{
"resourceType" : "Media",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifier(s) for the image
"type" : "<code>", // R! photo | video | audio
"subtype" : { CodeableConcept }, // The type of acquisition equipment/process
"
"view" : { CodeableConcept }, // Imaging view, e.g. Lateral or Antero-posterior
"subject" : { Reference(Patient|Practitioner|Group|Device|Specimen) }, // Who/What this Media is a record of
"operator" : { Reference(Practitioner) }, // The person who generated the image
"
"deviceName" : "<string>", // Name of the device/manufacturer
"height" : "<positiveInt>", // C? Height of the image in pixels (photo/video)
"width" : "<positiveInt>", // C? Width of the image in pixels (photo/video)
"frames" : "<positiveInt>", // C? Number of frames if > 1 (photo)
"duration" : "<unsignedInt>", // C? Length in seconds (audio / video)
"content" : { Attachment } // R! Actual Media - reference or data
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Required | DigitalMediaType |
|
|
|
Example |
|
|
|
|
Example |
|
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.
| Name | Type | Description | Paths |
| created | date |
|
Media.content.creation |
| identifier | token |
|
Media.identifier |
| operator | reference |
|
Media.operator
( Practitioner ) |
| patient | reference |
|
Media.subject
( Patient ) |
| subject | reference |
|
Media.subject
( Specimen |
| subtype | token |
|
Media.subtype |
| type | token |
|
Media.type |
| view | token |
|
Media.view |