ImagingStudy - FHIR Resource (stu3)


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

Validate an ImagingStudy FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
accessionfalseIdentifier# Related workflow identifier ("Accession Number")
availabilityfalsecode# ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
basedOntrueReference# Request fulfilled
contextfalseReference# Originating context
descriptionfalsestring# Institution-generated description
endpointtrueReference# Study access endpoint
identifiertrueIdentifier# Other identifiers for the study
interpretertrueReference# Who interpreted images
modalityListtrueCoding# All series modality if actual acquisition modalities
numberOfInstancesfalseunsignedInt# Number of Study Related Instances
numberOfSeriesfalseunsignedInt# Number of Study Related Series
patientfalseReference# Who the images are of
procedureCodetrueCodeableConcept# The performed procedure code
procedureReferencetrueReference# The performed Procedure reference
reasonfalseCodeableConcept# Why the study was requested
referrerfalseReference# Referring physician
seriestrueData Type# Each study has one or more series of instances
startedfalsedateTime# When the study was started
uidfalseoid# Formal DICOM identifier for the study

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 the like so:

https://api.1up.health/fhir/stu3/ImagingStudy?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
accessiontextaccession
basedonreferencebasedOn
bodysitetextseries.bodySite
contextreferencecontext
dicom-classuriseries.instance.sopClass
endpointreferenceendpoint, series.endpoint
identifiertextidentifier
modalitytextseries.modality
patientreferencepatient
performerreferenceseries.performer
reasontextreason
seriesuriseries.uid
starteddatestarted
studyuriuid
uiduriseries.instance.uid