Media

ResourceClinical · DiagnosticsTrial useMaturity 1

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

13 of 13 parameters tested

Structure

Show inherited elements (8)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Identifier(s) for the image
basedOnΣ	0..*	Reference(ServiceRequest | CarePlan)	Procedure that caused this media to be created
partOfΣ	0..*	Reference(Resource)	Part of referenced event
statusRequired?!Σ	1..1	code	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknownBinding (required): event-status
typeΣ	0..1	CodeableConcept	Classification of media as image, video, or audioBinding (extensible): media-type
modalityΣ	0..1	CodeableConcept	The type of acquisition equipment/processBinding (example): media-modality
viewΣ	0..1	CodeableConcept	Imaging view, e.g. Lateral or Antero-posteriorBinding (example): media-view
subjectΣ	0..1	Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location)	Who/What this Media is a record of
encounterΣ	0..1	Reference(Encounter)	Encounter associated with media
created[x]Σ	0..1	dateTime | Period	When Media was collected
issuedΣ	0..1	instant	Date/Time this version was made available
operatorΣ	0..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	The person who generated the image
reasonCodeΣ	0..*	CodeableConcept	Why was event performed?Binding (example): procedure-reason
bodySiteΣ	0..1	CodeableConcept	Observed body partBinding (example): body-site
deviceNameΣ	0..1	string	Name of the device/manufacturer
deviceΣ	0..1	Reference(Device | DeviceMetric | Device)	Observing Device
heightΣ	0..1	positiveInt	Height of the image in pixels (photo/video)
widthΣ	0..1	positiveInt	Width of the image in pixels (photo/video)
framesΣ	0..1	positiveInt	Number of frames if > 1 (photo)
durationΣ	0..1	decimal	Length in seconds (audio / video)
contentRequiredΣ	1..1	Attachment	Actual Media - reference or data
note	0..*	Annotation	Comments made about the media

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Media?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
based-on	reference	Procedure that caused this media to be created Media.basedOn
created	date	When Media was collected Media.created
device	reference	Observing Device Media.device
encounter	reference	Encounter associated with media Media.encounter
identifier	token	Identifier(s) for the image Media.identifier
modality	token	The type of acquisition equipment/process Media.modality
operator	reference	The person who generated the image Media.operator
patient	reference	Who/What this Media is a record of Media.subject.where(resolve() is Patient)
site	token	Observed body part Media.bodySite
status	token	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Media.status
subject	reference	Who/What this Media is a record of Media.subject
type	token	Classification of media as image, video, or audio Media.type
view	token	Imaging view, e.g. Lateral or Antero-posterior Media.view

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition