Home
API reference
FHIR® API
FHIR® resources
ImagingStudy
_search

ImagingStudy _search

post/ImagingStudy/_search
Page View

This resource contains content from a Digital Imaging and Communications in Medicine (DICOM) study.

Since this resource type represents medical images and related data that adhere to DICOM standards, the resource entries and elements map to DICOM attributes. A series comprises one type of imaging, while a study may have one or more series of different types within a resource. Learn more about translating DICOM to FHIR®.

You can review DICOM content or retrieve its storage location.

_search

Query for the storage location of a patient's imaging results. Review tips for imaging searches.

Data on demand requirements

For data on demand searches, you must include at least one of these query parameters:

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/ImagingStudy/_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 'modality=string' \
9
--data-urlencode 'instance=string' \
10
--data-urlencode 'series=string' \
11
--data-urlencode 'started=string' \
12
--data-urlencode 'status=string'

Request Body Schema

  • patient
    Array of string

    The patient that is the subject of the imaging study.

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • identifier
    Array of string

    Identifiers for the Study, such as DICOM Study Instance UID and Accession number

  • modality
    Array of string

    Modality (machine type) for the Study.

  • instance
    Array of string

    SOP Instance UID for an instance. This finds studies based on the ids of instances contained within.

  • series
    Array of string

    DICOM Series Instance UID for a series. This finds studies based on the ids of series contained within.

  • started
    Array of string

    Time and date when the study was started.

  • status
    Array of string

    The status of the study.

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": "ImagingStudy",
9
        "id": "example-x-ray",
10
        "identifier": [
11
          {
12
            "use": "official",
13
            "system": "urn:dicom:uid",
14
            "value": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.9"
15
          },
16
          {
17
            "use": "usual",
18
            "value": "81248247421",
19
            "type": {
20
              "coding": [
21
                {
22
                  "code": "ACSN",
23
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
24
                }
25
              ],
26
              "text": "Accession Number"
27
            }
28
          }
29
        ],
30
        "status": "available",
31
        "modality": [
32
          {
33
            "code": "DX",
34
            "system": "http://dicom.nema.org/resources/ontology/DCM"
35
          }
36
        ],
37
        "subject": {
38
          "reference": "Patient/RedoxPatientExampleTimothy"
39
        },
40
        "started": "2022-01-01T11:01:20+03:00",
41
        "numberOfSeries": 1,
42
        "numberOfInstances": 2,
43
        "procedureCode": [
44
          {
45
            "coding": [
46
              {
47
                "code": "RPID2589",
48
                "system": "http://www.radlex.org",
49
                "display": "XR Wrist 3+ Views"
50
              }
51
            ]
52
          }
53
        ],
54
        "series": [
55
          {
56
            "uid": "2.16.124.113543.6003.1154777499.30246.19789.3503430045.1",
57
            "number": 3,
58
            "modality": {
59
              "code": "DX",
60
              "system": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html"
61
            },
62
            "description": "XR Wrist 3+ Views",
63
            "numberOfInstances": 2,
64
            "instance": [
65
              {
66
                "uid": "2.16.124.113543.6003.1154777499.30246.19789.3503430045.1.1",
67
                "sopClass": {
68
                  "code": "urn:oid:1.2.840.10008.5.1.4.1.1.2",
69
                  "system": "urn:ietf:rfc:3986"
70
                },
71
                "number": 1,
72
                "title": "PA VIEW"
73
              },
74
              {
75
                "uid": "2.16.124.113543.6003.1154777499.30246.19789.3503430045.1.2",
76
                "sopClass": {
77
                  "code": "urn:oid:1.2.840.10008.5.1.4.1.1.2",
78
                  "system": "urn:ietf:rfc:3986"
79
                },
80
                "number": 2,
81
                "title": "LL VIEW"
82
              }
83
            ]
84
          }
85
        ]
86
      },
87
      "search": {
88
        "mode": "match"
89
      }
90
    }
91
  ]
92
}

    Response to a ImagingStudy 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 ImagingStudy or Other

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

    • resource
      required, object

      Representation of the content produced in a DICOM imaging study.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: ImagingStudy
      • status
        required, string

        The current state of the ImagingStudy.

        Possible Values: registered, available, cancelled, entered-in-error, unknown
      • subject
        required, object

        The subject, typically a patient, of the imaging study.

        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.

      • 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 for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.

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

      • modality
        Array of object

        A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).

        • 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).

      • started
        string

        Date and time the study started.

      • referrer
        object

        The requesting/referring physician.

        Must reference one of the following types of resources:

        • PractitionerRole
        • 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.

      • endpoint
        Array of object

        The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.

        Must be a resource of type Endpoint.

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

      • numberOfSeries
        number

        Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.

      • numberOfInstances
        number

        Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

      • procedureCode
        Array of object

        The code for the performed procedure type.

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

      • location
        object

        The principal physical location where the ImagingStudy was performed.

        Must be a resource of type Location.

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

      • reasonCode
        Array of object

        Description of clinical condition indicating why the ImagingStudy was requested.

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

      • description
        string

        The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.

      • series
        Array of object

        Each study has one or more series of images or other content.

        • uid
          required, string

          The DICOM Series Instance UID for the series.

        • modality
          required, object

          The modality of this series sequence.

          • 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).

        • number
          number

          The numeric identifier of this series in the study.

        • description
          string

          A description of the series.

        • numberOfInstances
          number

          Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

        • started
          string

          The date and time the series was started.

        • performer
          Array of object

          Indicates who or what performed the series and how they were involved.

          • actor
            required, object

            Indicates who or what performed the series.

            Must reference one of the following types of resources:

            • PractitionerRole
            • Practitioner
            • Organization
            • 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.

          • function
            object

            Distinguishes the type of involvement of the performer in the series.

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

        • instance
          Array of object

          A single SOP instance within the series, e.g. an image, or presentation state.

          • uid
            required, string

            The DICOM SOP Instance UID for this image or other DICOM content.

          • sopClass
            required, object

            DICOM instance type.

            • 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).

          • number
            number

            The number of instance in the series.

          • title
            string

            The description of the instance.

    • search
      required, object

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

      • mode
        required, string

        Identifies the ImagingStudy as matching the search parameters

        Value: match