# Media

Canonical page: https://docs.ovok.com/api/fhir/r4/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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Identifier(s) for the image |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | Procedure that caused this media to be created |
| <span id="element-part-of"></span>`partOf` | [Reference](/fhir-elements/complex/reference) | `0..*` | Part of referenced event |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | preparation \| in-progress \| not-done \| on-hold \| stopped \| completed \| entered-in-error \| unknown |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Classification of media as image, video, or audio |
| <span id="element-modality"></span>`modality` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | The type of acquisition equipment/process |
| <span id="element-view"></span>`view` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Imaging view, e.g. Lateral or Antero-posterior |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `0..1` | Who/What this Media is a record of |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Encounter associated with media |
| <span id="element-created-x"></span>`created[x]` | [dateTime](/fhir-elements/primitive/date-time), [Period](/fhir-elements/complex/period) | `0..1` | When Media was collected |
| <span id="element-issued"></span>`issued` | [instant](/fhir-elements/primitive/instant) | `0..1` | Date/Time this version was made available |
| <span id="element-operator"></span>`operator` | [Reference](/fhir-elements/complex/reference) | `0..1` | The person who generated the image |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Why was event performed? |
| <span id="element-body-site"></span>`bodySite` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Observed body part |
| <span id="element-device-name"></span>`deviceName` | [string](/fhir-elements/primitive/string) | `0..1` | Name of the device/manufacturer |
| <span id="element-device"></span>`device` | [Reference](/fhir-elements/complex/reference) | `0..1` | Observing Device |
| <span id="element-height"></span>`height` | [positiveInt](/fhir-elements/primitive/positive-int) | `0..1` | Height of the image in pixels (photo/video) |
| <span id="element-width"></span>`width` | [positiveInt](/fhir-elements/primitive/positive-int) | `0..1` | Width of the image in pixels (photo/video) |
| <span id="element-frames"></span>`frames` | [positiveInt](/fhir-elements/primitive/positive-int) | `0..1` | Number of frames if &gt; 1 (photo) |
| <span id="element-duration"></span>`duration` | [decimal](/fhir-elements/primitive/decimal) | `0..1` | Length in seconds (audio / video) |
| <span id="element-content"></span>`content` | [Attachment](/fhir-elements/complex/attachment) | `1..1` | Actual Media - reference or data |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Comments made about the media |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [Media](https://hl7.org/fhir/R4/media.html).  
Maturity: Trial Use 1 (FMM 1).
