ImagingStudy read

get/ImagingStudy/{id}
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.

read

Review translated DICOM content in a specific ImagingStudy resource.

To use the read interaction, you must know the related FHIR® resource ID. To retrieve translated DICOM content, you must search for the storage location with the _search interaction first.

Review tips for imaging searches.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/ImagingStudy/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

  • id
    required, string

    ImagingStudy identifier

Response fields and example

Completed Family Member History
json
1
{}

    A profile on the ImagingStudy resource that conforms to Redox requirements.

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