Home
API reference
FHIR® API
FHIR® resources
Media
_search

Media _search

post/Media/_search
Page View

This resource stores multimedia attachments such as photos, documents, videos, or other binary files related to patient care. Each media entry contains the file content, type, creation date, and associated clinical context.

You can review or retrieve media information with FHIR® passthrough.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

_search

Query for media attachments for a patient.

Flexible FHIR queries, different query parameters

FHIR® queries are a flexible option with parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

We only note which query parameters are required if you’re querying a FHIR® server directly. Remember that Redox (i.e., data on demand) isn’t a FHIR® server, and your connection may not be either.

Query parameters will vary between sites. Work with your connection to find out which query parameters they require for a successful search.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Media/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'identifier=string' \
8
--data-urlencode 'type=string' \
9
--data-urlencode 'status=string' \
10
--data-urlencode 'encounter=string' \
11
--data-urlencode 'encounter.identifier=string' \
12
--data-urlencode 'created=string'

Request Body Schema

  • patient
    Array of string

    Who/What this Media is a record of.

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • identifier
    Array of string

    Identifier(s) for the image

  • type
    Array of string

    Classification of media as image, video, or audio

  • status
    Array of string

    preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

  • encounter
    Array of string

    Encounter associated with media

  • encounter.identifier
    Array of string

    Identifier(s) by which this encounter is known

  • created
    Array of string

    When Media was collected

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "Media",
9
        "id": "RedoxMediaExample",
10
        "status": "completed",
11
        "type": {
12
          "coding": [
13
            {
14
              "code": "photo",
15
              "system": "http://terminology.hl7.org/CodeSystem/media-type",
16
              "display": "Photo"
17
            }
18
          ]
19
        },
20
        "subject": {
21
          "reference": "Patient/RedoxPatientExampleTimothy"
22
        },
23
        "encounter": {
24
          "reference": "Encounter/RedoxEncounterExample"
25
        },
26
        "createdDateTime": "2021-12-17T20:33:22.422Z",
27
        "operator": {
28
          "reference": "Practitioner/RedoxPractitionerExamplePat"
29
        },
30
        "bodySite": {
31
          "coding": [
32
            {
33
              "code": "368209003",
34
              "system": "http://snomed.info/sct",
35
              "display": "Right arm"
36
            }
37
          ]
38
        },
39
        "content": {
40
          "contentType": "image/jpeg",
41
          "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
42
        }
43
      },
44
      "search": {
45
        "mode": "match"
46
      }
47
    }
48
  ]
49
}

    Response to a Media search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of Media or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      A photo or video or audio recording acquired or used in healthcare.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: Media
      • status
        required, string

        The current state of the {{title}}.

        Possible Values: preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, unknown
      • content
        required, object

        The actual content of the media - inline or by direct reference to the media source file.

        • contentType
          string

          Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

        • data
          string

          The actual data of the attachment - a sequence of bytes, base64 encoded.

      • id
        string

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • identifier
        Array of object

        Identifiers 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.

        • extension
          Array of Boolean, String, CodeableConcept, Coding

          May be used to represent additional information that is not part of the basic definition of the element. 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.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • type
        object

        A code that classifies whether the media is an image, video or audio recording or some other media category.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • modality
        object

        Details 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.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • view
        object

        The name of the imaging view e.g. Lateral or Antero-posterior (AP).

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • subject
        object

        Who/What this Media is a record of.

        Must be a resource of type Patient.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • encounter
        object

        The encounter that establishes the context for this media.

        Must be a resource of type Encounter.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • operator
        object

        The person who administered the collection of the image.

        Must be a resource of type Practitioner.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • bodySite
        object

        Indicates the site on the subject's body where the observation was made (i.e. the target site).

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • note
        Array of object

        Comments made about the media by the performer, subject or other participants.

        • text
          required, string

          The text of the annotation in markdown format.

      • createdDateTime
        string

        The date and time(s) at which the media was collected.

        Only one of createdDateTime, createdPeriod may be present.

      • createdPeriod
        object

        The date and time(s) at which the media was collected.

        Only one of createdDateTime, createdPeriod may be present.

        • start
          string

          The start of the period. The boundary is inclusive.

        • end
          string

          The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the Media as matching the search parameters

        Value: match

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.