Skip to main content

Media

PropertyValue
Publisher
NameMedia
URLhttp://hl7.org/fhir/StructureDefinition/Media
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Media0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
Media.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Media.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Media.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Media.language0..1codeThe base language in which the resource is written.
Media.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Media.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Media.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Media.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Media.identifier0..*IdentifierIdentifiers 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.
Media.basedOn0..*ReferenceA procedure that is fulfilled in whole or in part by the creation of this media.
Media.partOf0..*ReferenceA larger event of which this particular event is a component or step.
Media.status1..1codeThe current state of the {{title}}.
Media.type0..1CodeableConceptA code that classifies whether the media is an image, video or audio recording or some other media category.
Media.modality0..1CodeableConceptDetails 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.
Media.view0..1CodeableConceptThe name of the imaging view e.g. Lateral or Antero-posterior (AP).
Media.subject0..1ReferenceWho/What this Media is a record of.
Media.encounter0..1ReferenceThe encounter that establishes the context for this media.
Media.created[x]0..1dateTimeThe date and time(s) at which the media was collected.
Media.issued0..1instantThe date and time this version of the media was made available to providers, typically after having been reviewed.
Media.operator0..1ReferenceThe person who administered the collection of the image.
Media.reasonCode0..*CodeableConceptDescribes why the event occurred in coded or textual form.
Media.bodySite0..1CodeableConceptIndicates the site on the subject's body where the observation was made (i.e. the target site).
Media.deviceName0..1stringThe name of the device / manufacturer of the device that was used to make the recording.
Media.device0..1ReferenceThe device used to collect the media.
Media.height0..1positiveIntHeight of the image in pixels (photo/video).
Media.width0..1positiveIntWidth of the image in pixels (photo/video).
Media.frames0..1positiveIntThe 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.
Media.duration0..1decimalThe duration of the recording in seconds - for audio and video.
Media.content1..1AttachmentThe actual content of the media - inline or by direct reference to the media source file.
Media.note0..*AnnotationComments made about the media by the performer, subject or other participants.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
based-onreferenceProcedure that caused this media to be createdMedia.basedOn
createddateWhen Media was collectedMedia.created
devicereferenceObserving DeviceMedia.device
encounterreferenceEncounter associated with mediaMedia.encounter
identifiertokenIdentifier(s) for the imageMedia.identifier
modalitytokenThe type of acquisition equipment/processMedia.modality
operatorreferenceThe person who generated the imageMedia.operator
patientreferenceWho/What this Media is a record ofMedia.subject.where(resolve() is Patient)
sitetokenObserved body partMedia.bodySite
statustokenpreparation / in-progress / not-done / on-hold / stopped / completed / entered-in-error / unknownMedia.status
subjectreferenceWho/What this Media is a record ofMedia.subject
typetokenClassification of media as image, video, or audioMedia.type
viewtokenImaging view, e.g. Lateral or Antero-posteriorMedia.view