ImagingStudy - FHIR Resource (dstu2)
This ImagingStudy Resource uses the FHIR API standard for access and structure.
Validate an ImagingStudy FHIR Resource (dstu2)
ImagingStudy Attributes
AttributeField is listTypeDescription
Description: Who the images are of
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": Learn more about the (ImagingStudy) patient FHIR attribute
Description: Institution-generated description
FHIR Version: dstu2
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
Description: When the study was started
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"started": Learn more about the (ImagingStudy) started FHIR attribute
Description: Referring physician (0008,0090)
FHIR Version: dstu2
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: Number of Study Related Series
FHIR Version: dstu2
Attribute Type : unsignedInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"numberOfSeries": Learn more about the (ImagingStudy) numberOfSeries FHIR attribute
Description: Related workflow identifier ("Accession Number")
FHIR Version: dstu2
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: Number of Study Related Instances
FHIR Version: dstu2
Attribute Type : unsignedInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"numberOfInstances": Learn more about the (ImagingStudy) numberOfInstances FHIR attribute
Description: Order(s) that caused this study to be performed
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"order": Learn more about the (ImagingStudy) order FHIR attribute
Description: All series modality if actual acquisition modalities
FHIR Version: dstu2
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: Retrieve URI
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (ImagingStudy) url FHIR attribute
Description: Each study has one or more series of instances
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"series": Learn more about the (ImagingStudy) series FHIR attribute
Description: Who interpreted images
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
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: dstu2
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 (0008,0056)
FHIR Version: dstu2
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: Type of procedure performed
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"procedure": Learn more about the (ImagingStudy) procedure FHIR attribute
Description: Formal identifier for the study
FHIR Version: dstu2
Attribute Type : oid
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"uid": Learn more about the (ImagingStudy) uid FHIR attribute
ImagingStudy Structure
{
"resourceType" : "ImagingStudy",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"started" : "<dateTime>", // When the study was started
"patient" : { Reference(Patient) }, // R! Who the images are of
"uid" : "<oid>", // R! Formal identifier for the study
"accession" : { Identifier }, // Related workflow identifier ("Accession Number")
"identifier" : [{ Identifier }], // Other identifiers for the study
"order" : [{ Reference(DiagnosticOrder) }], // Order(s) that caused this study to be performed
"modalityList" : [{ Coding }], // All series modality if actual acquisition modalities
"referrer" : { Reference(Practitioner) }, // Referring physician (0008,0090)
"availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)
"url" : "<uri>", // Retrieve URI
"numberOfSeries" : "<unsignedInt>", // R! Number of Study Related Series
"numberOfInstances" : "<unsignedInt>", // R! Number of Study Related Instances
"procedure" : [{ Reference(Procedure) }], // Type of procedure performed
"interpreter" : { Reference(Practitioner) }, // Who interpreted images
"description" : "<string>", // Institution-generated description
"series" : [{ // Each study has one or more series of instances
"number" : "<unsignedInt>", // Numeric identifier of this series
"modality" : { Coding }, // R! The modality of the instances in the series
"uid" : "<oid>", // R! Formal identifier for this series
"description" : "<string>", // A description of the series
"numberOfInstances" : "<unsignedInt>", // R! Number of Series Related Instances
"availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
"url" : "<uri>", // Location of the referenced instance(s)
"bodySite" : { Coding }, // Body part examined
"laterality" : { Coding }, // Body part laterality
"started" : "<dateTime>", // When the series started
"instance" : [{ // A single SOP instance from the series
"number" : "<unsignedInt>", // The number of this instance in the series
"uid" : "<oid>", // R! Formal identifier for this instance
"sopClass" : "<oid>", // R! DICOM class type
"type" : "<string>", // Type of instance (image etc.)
"title" : "<string>", // Description of instance
"content" : [{ Attachment }] // Content of the 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/dstu2/ImagingStudy?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
accession | text | accession |
bodysite | text | series.bodySite |
dicom-class | uri | series.instance.sopClass |
modality | text | series.modality |
order | reference | order |
patient | reference | patient |
series | uri | series.uid |
started | date | started |
study | uri | uid |
uid | uri | series.instance.uid |
