Media
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Media/[id] |
| Vread | GET | /fhir/R4/Media/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Media/[id] |
| Patch | PATCH | /fhir/R4/Media/[id] |
| Delete | DELETE | /fhir/R4/Media/[id] |
| Create | POST | /fhir/R4/Media |
| Search | GET | /fhir/R4/Media |
| History | GET | /fhir/R4/Media/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Identifier(s) for the image |
basedOn | Reference | 0..* | Procedure that caused this media to be created |
partOf | Reference | 0..* | Part of referenced event |
status | code | 1..1 | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
type | CodeableConcept | 0..1 | Classification of media as image, video, or audio |
modality | CodeableConcept | 0..1 | The type of acquisition equipment/process |
view | CodeableConcept | 0..1 | Imaging view, e.g. Lateral or Antero-posterior |
subject | Reference | 0..1 | Who/What this Media is a record of |
encounter | Reference | 0..1 | Encounter associated with media |
created[x] | dateTime, Period | 0..1 | When Media was collected |
issued | instant | 0..1 | Date/Time this version was made available |
operator | Reference | 0..1 | The person who generated the image |
reasonCode | CodeableConcept | 0..* | Why was event performed? |
bodySite | CodeableConcept | 0..1 | Observed body part |
deviceName | string | 0..1 | Name of the device/manufacturer |
device | Reference | 0..1 | Observing Device |
height | positiveInt | 0..1 | Height of the image in pixels (photo/video) |
width | positiveInt | 0..1 | Width of the image in pixels (photo/video) |
frames | positiveInt | 0..1 | Number of frames if > 1 (photo) |
duration | decimal | 0..1 | Length in seconds (audio / video) |
content | Attachment | 1..1 | Actual Media - reference or data |
note | Annotation | 0..* | Comments made about the media |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
based-on | reference | Procedure that caused this media to be created |
created | date | When Media was collected |
device | reference | Observing Device |
encounter | reference | Encounter associated with media |
identifier | token | Identifier(s) for the image |
modality | token | The type of acquisition equipment/process |
operator | reference | The person who generated the image |
patient | reference | Who/What this Media is a record of |
site | token | Observed body part |
status | token | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
subject | reference | Who/What this Media is a record of |
type | token | Classification of media as image, video, or audio |
view | token | Imaging view, e.g. Lateral or Antero-posterior |
Reference
Official FHIR R4 spec: Media.
Maturity: Trial Use 1 (FMM 1).