ImagingStudy - FHIR Resource (stu3)

This ImagingStudy Resource uses the FHIR API standard for access and structure.

Validate an ImagingStudy FHIR Resource (stu3)

ImagingStudy Attributes

AttributeField is listTypeDescription

Description: Study access endpoint

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"endpoint":

Learn more about the (ImagingStudy) endpoint FHIR attribute

Description: Who the images are of

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"patient": {
  "reference": "Patient/dicom"
}

Learn more about the (ImagingStudy) patient FHIR attribute

Description: Formal DICOM identifier for the study

FHIR Version: stu3

Attribute Type : oid

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"uid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"

Learn more about the (ImagingStudy) uid FHIR attribute

Description: All series modality if actual acquisition modalities

FHIR Version: stu3

Attribute Type : Coding

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"modalityList":

Learn more about the (ImagingStudy) modalityList FHIR attribute

Description: When the study was started

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"started": "2011-01-01T11:01:20+03:00"

Learn more about the (ImagingStudy) started FHIR attribute

Description: Referring physician

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"referrer":

Learn more about the (ImagingStudy) referrer FHIR attribute

Description: The performed Procedure reference

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"procedureReference":

Learn more about the (ImagingStudy) procedureReference FHIR attribute

Description: Related workflow identifier ("Accession Number")

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"accession":

Learn more about the (ImagingStudy) accession FHIR attribute

Description: Request fulfilled

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"basedOn":

Learn more about the (ImagingStudy) basedOn FHIR attribute

Description: Number of Study Related Instances

FHIR Version: stu3

Attribute Type : unsignedInt

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"numberOfInstances": 1

Learn more about the (ImagingStudy) numberOfInstances FHIR attribute

Description: The performed procedure code

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"procedureCode":

Learn more about the (ImagingStudy) procedureCode FHIR attribute

Description: Why the study was requested

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reason":

Learn more about the (ImagingStudy) reason FHIR attribute

Description: Number of Study Related Series

FHIR Version: stu3

Attribute Type : unsignedInt

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"numberOfSeries": 1

Learn more about the (ImagingStudy) numberOfSeries FHIR attribute

Description: Originating context

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"context":

Learn more about the (ImagingStudy) context FHIR attribute

Description: Each study has one or more series of instances

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"series": [
  {
    "description": "CT Surview 180",
    "numberOfInstances": 1,
    "number": 3,
    "instance": [
      {
        "sopClass": "urn:oid:1.2.840.10008.5.1.4.1.1.2",
        "uid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903",
        "number": 1
      }
    ],
    "bodySite": {
      "code": "67734004",
      "system": "http://snomed.info/sct",
      "display": "Upper Trunk Structure"
    },
    "modality": {
      "code": "CT",
      "system": "http://dicom.nema.org/resources/ontology/DCM"
    },
    "uid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630"
  }
]

Learn more about the (ImagingStudy) series FHIR attribute

Description: Who interpreted images

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"interpreter":

Learn more about the (ImagingStudy) interpreter FHIR attribute

Description: Other identifiers for the study

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (ImagingStudy) identifier FHIR attribute

Description: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"availability":

Learn more about the (ImagingStudy) availability FHIR attribute

Description: Institution-generated description

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description":

Learn more about the (ImagingStudy) description FHIR attribute

ImagingStudy Example

{
  "patient": {
    "reference": "Patient/dicom"
  },
  "uid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045",
  "resourceType": "ImagingStudy",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">CT Chest.  John Smith (MRN: 09236). Accession: W12342398. Performed: 2011-01-01. 3 series, 12 images.</div>"
  },
  "numberOfInstances": 1,
  "started": "2011-01-01T11:01:20+03:00",
  "numberOfSeries": 1,
  "series": [
    {
      "description": "CT Surview 180",
      "numberOfInstances": 1,
      "number": 3,
      "instance": [
        {
          "sopClass": "urn:oid:1.2.840.10008.5.1.4.1.1.2",
          "uid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903",
          "number": 1
        }
      ],
      "bodySite": {
        "code": "67734004",
        "system": "http://snomed.info/sct",
        "display": "Upper Trunk Structure"
      },
      "modality": {
        "code": "CT",
        "system": "http://dicom.nema.org/resources/ontology/DCM"
      },
      "uid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630"
    }
  ],
  "id": "example"
}

ImagingStudy Structure


  
{
  "resourceType" : "ImagingStudy",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "uid" : "<oid>", // R!  Formal DICOM identifier for the study
  "accession" : { Identifier }, // Related workflow identifier ("Accession Number")
  "identifier" : [{ Identifier }], // Other identifiers for the study
  "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
  "modalityList" : [{ Coding }], // All series modality if actual acquisition modalities
  "patient" : { Reference(Patient) }, // R!  Who the images are of
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Originating context
  "started" : "<dateTime>", // When the study was started
  "basedOn" : [{ Reference(ReferralRequest|CarePlan|ProcedureRequest) }], // Request fulfilled
  "referrer" : { Reference(Practitioner) }, // Referring physician
  "interpreter" : [{ Reference(Practitioner) }], // Who interpreted images
  "endpoint" : [{ Reference(Endpoint) }], // Study access endpoint
  "numberOfSeries" : "<unsignedInt>", // Number of Study Related Series
  "numberOfInstances" : "<unsignedInt>", // Number of Study Related Instances
  "procedureReference" : [{ Reference(Procedure) }], // The performed Procedure reference
  "procedureCode" : [{ CodeableConcept }], // The performed procedure code
  "reason" : { CodeableConcept }, // Why the study was requested
  "description" : "<string>", // Institution-generated description
  "series" : [{ // Each study has one or more series of instances
    "uid" : "<oid>", // R!  Formal DICOM identifier for this series
    "number" : "<unsignedInt>", // Numeric identifier of this series
    "modality" : { Coding }, // R!  The modality of the instances in the series
    "description" : "<string>", // A short human readable summary of the series
    "numberOfInstances" : "<unsignedInt>", // Number of Series Related Instances
    "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
    "endpoint" : [{ Reference(Endpoint) }], // Series access endpoint
    "bodySite" : { Coding }, // Body part examined
    "laterality" : { Coding }, // Body part laterality
    "started" : "<dateTime>", // When the series started
    "performer" : [{ Reference(Practitioner) }], // Who performed the series
    "instance" : [{ // A single SOP instance from the series
      "uid" : "<oid>", // R!  Formal DICOM identifier for this instance
      "number" : "<unsignedInt>", // The number of this instance in the series
      "sopClass" : "<oid>", // R!  DICOM class type
      "title" : "<string>" // Description of instance
    }]
  }]
}

ImagingStudy Search Parameters

The following search parameters can be used to query ImagingStudy resources. Just submit them like so:

https://api.1up.health/fhir/stu3/ImagingStudy?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`accession`	`text`	`accession`
`basedon`	`reference`	`basedOn`
`bodysite`	`text`	`series.bodySite`
`context`	`reference`	`context`
`dicom-class`	`uri`	`series.instance.sopClass`
`endpoint`	`reference`	`endpoint, series.endpoint`
`identifier`	`text`	`identifier`
`modality`	`text`	`series.modality`
`patient`	`reference`	`patient`
`performer`	`reference`	`series.performer`
`reason`	`text`	`reason`
`series`	`uri`	`series.uid`
`started`	`date`	`started`
`study`	`uri`	`uid`
`uid`	`uri`	`series.instance.uid`