ImagingStudy - FHIR Resource (r4)
This ImagingStudy Resource uses the FHIR API standard for access and structure.
Validate an ImagingStudy FHIR Resource (r4)
ImagingStudy Attributes
AttributeField is listTypeDescription
Description: Identifiers for the whole study
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "urn:dicom:uid",
"value": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"
}
]Learn more about the (ImagingStudy) identifier FHIR attribute
Description: registered | available | cancelled | entered-in-error | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "available"Learn more about the (ImagingStudy) status FHIR attribute
Description: All series modality if actual acquisition modalities
FHIR Version: r4
Attribute Type : Coding
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"modality": Learn more about the (ImagingStudy) modality FHIR attribute
Description: Who or what is the subject of the study
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/dicom"
}Learn more about the (ImagingStudy) subject FHIR attribute
Description: Encounter with which this imaging study is associated
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": Learn more about the (ImagingStudy) encounter FHIR attribute
Description: When the study was started
FHIR Version: r4
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: "basedOn" : [{ Reference(CarePlan|ServiceRequest|Appointment|
FHIR Version: r4
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: Referring physician
FHIR Version: r4
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: Who interpreted images
FHIR Version: r4
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: Study access endpoint
FHIR Version: r4
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: Number of Study Related Series
FHIR Version: r4
Attribute Type : unsignedInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"numberOfSeries": 1Learn more about the (ImagingStudy) numberOfSeries FHIR attribute
Description: Number of Study Related Instances
FHIR Version: r4
Attribute Type : unsignedInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"numberOfInstances": 1Learn more about the (ImagingStudy) numberOfInstances FHIR attribute
Description: The performed Procedure reference
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"procedureReference": Learn more about the (ImagingStudy) procedureReference FHIR attribute
Description: The performed procedure code
FHIR Version: r4
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: Where ImagingStudy occurred
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (ImagingStudy) location FHIR attribute
Description: Why the study was requested
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": Learn more about the (ImagingStudy) reasonCode FHIR attribute
Description: "reasonReference" : [{ Reference(Condition|Observation|Media|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (ImagingStudy) reasonReference FHIR attribute
Description: User-defined comments
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (ImagingStudy) note FHIR attribute
Description: Institution-generated description
FHIR Version: r4
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: Each study has one or more series of instances
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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
}
]
}
]Learn more about the (ImagingStudy) series FHIR attribute
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
basedon | reference | basedOn |
bodysite | text | series.bodySite |
dicom-class | text | series.instance.sopClass |
encounter | reference | encounter |
endpoint | reference | endpoint |
identifier | text | identifier |
instance | text | series.instance.uid |
interpreter | reference | interpreter |
modality | text | series.modality |
patient | reference | subject.where |
performer | reference | series.performer.actor |
reason | text | reasonCode |
referrer | reference | referrer |
series | text | series.uid |
started | date | started |
status | text | status |
subject | reference | subject |
