Skip to main content

Media

Trial Use 1 Other

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

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Media
InteractionMethodPath
ReadGET/fhir/R4/Media/[id]
VreadGET/fhir/R4/Media/[id]/_history/[vid]
UpdatePUT/fhir/R4/Media/[id]
PatchPATCH/fhir/R4/Media/[id]
DeleteDELETE/fhir/R4/Media/[id]
CreatePOST/fhir/R4/Media
SearchGET/fhir/R4/Media
HistoryGET/fhir/R4/Media/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Identifier(s) for the image
basedOnReference0..*Procedure that caused this media to be created
partOfReference0..*Part of referenced event
statuscode1..1preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown modifier
typeCodeableConcept0..1Classification of media as image, video, or audio
modalityCodeableConcept0..1The type of acquisition equipment/process
viewCodeableConcept0..1Imaging view, e.g. Lateral or Antero-posterior
subjectReference0..1Who/What this Media is a record of
encounterReference0..1Encounter associated with media
created[x]dateTime / Period0..1When Media was collected
issuedinstant0..1Date/Time this version was made available
operatorReference0..1The person who generated the image
reasonCodeCodeableConcept0..*Why was event performed?
bodySiteCodeableConcept0..1Observed body part
deviceNamestring0..1Name of the device/manufacturer
deviceReference0..1Observing Device
heightpositiveInt0..1Height of the image in pixels (photo/video)
widthpositiveInt0..1Width of the image in pixels (photo/video)
framespositiveInt0..1Number of frames if > 1 (photo)
durationdecimal0..1Length in seconds (audio / video)
contentAttachment1..1Actual Media - reference or data
noteAnnotation0..*Comments made about the media

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
based-onstringhttp://hl7.org/fhir/SearchParameter/Media-based-on
createdstringhttp://hl7.org/fhir/SearchParameter/Media-created
devicestringhttp://hl7.org/fhir/SearchParameter/Media-device
encounterstringhttp://hl7.org/fhir/SearchParameter/Media-encounter
identifierstringhttp://hl7.org/fhir/SearchParameter/Media-identifier
modalitystringhttp://hl7.org/fhir/SearchParameter/Media-modality
operatorstringhttp://hl7.org/fhir/SearchParameter/Media-operator
patientstringhttp://hl7.org/fhir/SearchParameter/Media-patient
sitestringhttp://hl7.org/fhir/SearchParameter/Media-site
statusstringhttp://hl7.org/fhir/SearchParameter/Media-status
subjectstringhttp://hl7.org/fhir/SearchParameter/Media-subject
typestringhttp://hl7.org/fhir/SearchParameter/Media-type
viewstringhttp://hl7.org/fhir/SearchParameter/Media-view

Reference​

  • Official FHIR R4 spec: Media
  • Maturity: Trial Use 1 (FMM 1).