ImagingStudy - FHIR Resource (r4)


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

Validate an ImagingStudy FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
basedOntrueReference# "basedOn" : [{ Reference(CarePlan|ServiceRequest|Appointment|
descriptionfalsestring# Institution-generated description
encounterfalseReference# Encounter with which this imaging study is associated
endpointtrueReference# Study access endpoint
identifiertrueIdentifier# Identifiers for the whole study
interpretertrueReference# Who interpreted images
locationfalseReference# Where ImagingStudy occurred
modalitytrueCoding# All series modality if actual acquisition modalities
notetrueAnnotation# User-defined comments
numberOfInstancesfalseunsignedInt# Number of Study Related Instances
numberOfSeriesfalseunsignedInt# Number of Study Related Series
procedureCodetrueCodeableConcept# The performed procedure code
procedureReferencefalseReference# The performed Procedure reference
reasonCodetrueCodeableConcept# Why the study was requested
reasonReferencetrueReference# "reasonReference" : [{ Reference(Condition|Observation|Media|
referrerfalseReference# Referring physician
seriestrueData Type# Each study has one or more series of instances
startedfalsedateTime# When the study was started
statusfalsecode# registered | available | cancelled | entered-in-error | unknown
subjectfalseReference# Who or what is the subject of the study

ImagingStudy Example

{
  "resourceType": "ImagingStudy",
  "id": "example",
  "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>"
  },
  "identifier": [
    {
      "system": "urn:dicom:uid",
      "value": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"
    }
  ],
  "status": "available",
  "subject": {
    "reference": "Patient/dicom"
  },
  "started": "2011-01-01T11:01:20+03:00",
  "numberOfSeries": 1,
  "numberOfInstances": 1,
  "series": [
    {
      "uid": "2.16.124.113543.6003.2588828330.45298.17418.2723805630",
      "number": 3,
      "modality": {
        "system": "http://dicom.nema.org/resources/ontology/DCM",
        "code": "CT"
      },
      "description": "CT Surview 180",
      "numberOfInstances": 1,
      "bodySite": {
        "system": "http://snomed.info/sct",
        "code": "67734004",
        "display": "Upper Trunk Structure"
      },
      "instance": [
        {
          "uid": "2.16.124.113543.6003.189642796.63084.16748.2599092903",
          "sopClass": {
            "system": "urn:ietf:rfc:3986",
            "code": "urn:oid:1.2.840.10008.5.1.4.1.1.2"
          },
          "number": 1
        }
      ]
    }
  ]
}

ImagingStudy Structure

{
  "resourceType" : "ImagingStudy",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Identifiers for the whole study
  "status" : "<code>", // R!  registered | available | cancelled | entered-in-error | unknown
  "modality" : [{ Coding }], // All series modality if actual acquisition modalities 
  "subject" : { Reference(Patient|Device|Group) }, // R!  Who or what is the subject of the study
  "encounter" : { Reference(Encounter) }, // Encounter with which this imaging study is associated
  "started" : "<dateTime>", // When the study was started
  "basedOn" : [{ Reference(CarePlan|ServiceRequest|Appointment|
   AppointmentResponse|Task) }], // Request fulfilled
  "referrer" : { Reference(Practitioner|PractitionerRole) }, // Referring physician
  "interpreter" : [{ Reference(Practitioner|PractitionerRole) }], // 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 
  "location" : { Reference(Location) }, // Where ImagingStudy occurred
  "reasonCode" : [{ CodeableConcept }], // Why the study was requested
  "reasonReference" : [{ Reference(Condition|Observation|Media|
   DiagnosticReport|DocumentReference) }], // Why was study performed
  "note" : [{ Annotation }], // User-defined comments
  "description" : "<string>", // Institution-generated description
  "series" : [{ // Each study has one or more series of instances
    "uid" : "<id>", // R!  DICOM Series Instance UID for the 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
    "endpoint" : [{ Reference(Endpoint) }], // Series access endpoint
    "bodySite" : { Coding }, // Body part examined
    "laterality" : { Coding }, // Body part laterality
    "specimen" : [{ Reference(Specimen) }], // Specimen imaged
    "started" : "<dateTime>", // When the series started
    "performer" : [{ // Who performed the series
      "function" : { CodeableConcept }, // Type of performance
      "actor" : { Reference(Practitioner|PractitionerRole|Organization|CareTeam|
     Patient|Device|RelatedPerson) } // R!  Who performed the series
    }],
    "instance" : [{ // A single SOP instance from the series
      "uid" : "<id>", // R!  DICOM SOP Instance UID
      "sopClass" : { Coding }, // R!  DICOM class type 
      "number" : "<unsignedInt>", // The number of this instance in the series
      "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/r4/ImagingStudy?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
basedonreferencebasedOn
bodysitetextseries.bodySite
dicom-classtextseries.instance.sopClass
encounterreferenceencounter
endpointreferenceendpoint
identifiertextidentifier
instancetextseries.instance.uid
interpreterreferenceinterpreter
modalitytextseries.modality
patientreferencesubject.where
performerreferenceseries.performer.actor
reasontextreasonCode
referrerreferencereferrer
seriestextseries.uid
starteddatestarted
statustextstatus
subjectreferencesubject