This page is part of the IHE Interactive Multimedia Report (IMR) (v1.1.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: IMR ImagingStudy

IHE Interactive Multimedia Report (IMR) profile on ImagingStudy

Usage:

• Use this Resource Profile: IMR Store Multimedia Report Bundle
• Examples for this Resource Profile: ImagingStudy/ex-ImagingStudy-Comparison and ImagingStudy/ex-ImagingStudy

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ImagingStudy

Name	Flags	Card.	Type	Description & Constraints
ImagingStudy		0..*	ImagingStudy	A set of images produced in single study (one or more series of references images)
Slices for identifier		1..*	Identifier	Identifiers for the whole study Slice: Unordered, Open by pattern:system
identifier:studyUID	S	1..1	Identifier	Identifiers for the whole study
system		1..1	uri	The namespace for the identifier value Required Pattern: urn:dicom:uid
value	S	1..1	string	The value that is unique
modality		1..*	Coding	All series modality if actual acquisition modalities
subject		1..1	Reference(Patient)	Who or what is the subject of the study
started	S	1..1	dateTime	When the study was started
endpoint		1..*	Reference(Imaging Study Endpoint)	Study access endpoint
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ImagingStudy		0..*	ImagingStudy	A set of images produced in single study (one or more series of references images)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	Identifiers for the whole study Slice: Unordered, Open by pattern:system
identifier:studyUID	SΣ	1..1	Identifier	Identifiers for the whole study
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: urn:dicom:uid
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	1..1	code	registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
modality	Σ	1..*	Coding	All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
subject	Σ	1..1	Reference(Patient)	Who or what is the subject of the study
started	SΣ	1..1	dateTime	When the study was started Example General: 2011-01-01T11:01:20+03:00
endpoint	Σ	1..*	Reference(Imaging Study Endpoint)	Study access endpoint
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ImagingStudy.identifier:studyUID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
ImagingStudy.status	required	ImagingStudyStatus http://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1 from the FHIR Standard
ImagingStudy.modality	extensible	AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html from http://tx.fhir.org/r4

Name	Flags	Card.	Type	Description & Constraints
ImagingStudy		0..*	ImagingStudy	A set of images produced in single study (one or more series of references images)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	Identifiers for the whole study Slice: Unordered, Open by pattern:system
identifier:studyUID	SΣ	1..1	Identifier	Identifiers for the whole study
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: urn:dicom:uid
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!Σ	1..1	code	registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
modality	Σ	1..*	Coding	All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
subject	Σ	1..1	Reference(Patient)	Who or what is the subject of the study
encounter	Σ	0..1	Reference(Encounter)	Encounter with which this imaging study is associated
started	SΣ	1..1	dateTime	When the study was started Example General: 2011-01-01T11:01:20+03:00
basedOn	Σ	0..*	Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task)	Request fulfilled
referrer	Σ	0..1	Reference(Practitioner | PractitionerRole)	Referring physician
interpreter	Σ	0..*	Reference(Practitioner | PractitionerRole)	Who interpreted images
endpoint	Σ	1..*	Reference(Imaging Study Endpoint)	Study access endpoint
numberOfSeries	Σ	0..1	unsignedInt	Number of Study Related Series
numberOfInstances	Σ	0..1	unsignedInt	Number of Study Related Instances
procedureReference	Σ	0..1	Reference(Procedure)	The performed Procedure reference
procedureCode	Σ	0..*	CodeableConcept	The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
location	Σ	0..1	Reference(Location)	Where ImagingStudy occurred
reasonCode	Σ	0..*	CodeableConcept	Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
reasonReference	Σ	0..*	Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)	Why was study performed
note	Σ	0..*	Annotation	User-defined comments
description	Σ	0..1	string	Institution-generated description
series	Σ	0..*	BackboneElement	Each study has one or more series of instances
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
uid	Σ	1..1	id	DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
number	Σ	0..1	unsignedInt	Numeric identifier of this series Example General: 3
modality	Σ	1..1	Coding	The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
description	Σ	0..1	string	A short human readable summary of the series Example General: CT Surview 180
numberOfInstances	Σ	0..1	unsignedInt	Number of Series Related Instances
endpoint	Σ	0..*	Reference(Endpoint)	Series access endpoint
bodySite	Σ	0..1	Coding	Body part examined Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
laterality	Σ	0..1	Coding	Body part laterality Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).
specimen	Σ	0..*	Reference(Specimen)	Specimen imaged
started	Σ	0..1	dateTime	When the series started
performer	Σ	0..*	BackboneElement	Who performed the series
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	Who performed the series
instance		0..*	BackboneElement	A single SOP instance from the series
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
uid		1..1	id	DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
sopClass		1..1	Coding	DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.
number		0..1	unsignedInt	The number of this instance in the series Example General: 1
title		0..1	string	Description of instance
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ImagingStudy.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
ImagingStudy.identifier:studyUID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
ImagingStudy.identifier:studyUID.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
ImagingStudy.status	required	ImagingStudyStatus http://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1 from the FHIR Standard
ImagingStudy.modality	extensible	AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html from http://tx.fhir.org/r4
ImagingStudy.procedureCode	extensible	http://www.rsna.org/RadLex_Playbook.aspx http://www.rsna.org/RadLex_Playbook.aspx
ImagingStudy.reasonCode	example	ProcedureReasonCodes http://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard
ImagingStudy.series.modality	extensible	AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html from http://tx.fhir.org/r4
ImagingStudy.series.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
ImagingStudy.series.laterality	example	Laterality http://hl7.org/fhir/ValueSet/bodysite-laterality from the FHIR Standard
ImagingStudy.series.performer.function	extensible	ImagingStudySeriesPerformerFunction http://hl7.org/fhir/ValueSet/series-performer-function from the FHIR Standard
ImagingStudy.series.instance.sopClass	extensible	http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1

This structure is derived from ImagingStudy

Summary

Mandatory: 7 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Imaging Study Endpoint (https://profiles.ihe.net/RAD/IMR/StructureDefinition/imaging-study-endpoint)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of ImagingStudy.identifier

Differential View

This structure is derived from ImagingStudy

Name	Flags	Card.	Type	Description & Constraints
ImagingStudy		0..*	ImagingStudy	A set of images produced in single study (one or more series of references images)
Slices for identifier		1..*	Identifier	Identifiers for the whole study Slice: Unordered, Open by pattern:system
identifier:studyUID	S	1..1	Identifier	Identifiers for the whole study
system		1..1	uri	The namespace for the identifier value Required Pattern: urn:dicom:uid
value	S	1..1	string	The value that is unique
modality		1..*	Coding	All series modality if actual acquisition modalities
subject		1..1	Reference(Patient)	Who or what is the subject of the study
started	S	1..1	dateTime	When the study was started
endpoint		1..*	Reference(Imaging Study Endpoint)	Study access endpoint
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ImagingStudy		0..*	ImagingStudy	A set of images produced in single study (one or more series of references images)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	Identifiers for the whole study Slice: Unordered, Open by pattern:system
identifier:studyUID	SΣ	1..1	Identifier	Identifiers for the whole study
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: urn:dicom:uid
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	1..1	code	registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
modality	Σ	1..*	Coding	All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
subject	Σ	1..1	Reference(Patient)	Who or what is the subject of the study
started	SΣ	1..1	dateTime	When the study was started Example General: 2011-01-01T11:01:20+03:00
endpoint	Σ	1..*	Reference(Imaging Study Endpoint)	Study access endpoint
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ImagingStudy.identifier:studyUID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
ImagingStudy.status	required	ImagingStudyStatus http://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1 from the FHIR Standard
ImagingStudy.modality	extensible	AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html from http://tx.fhir.org/r4

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ImagingStudy		0..*	ImagingStudy	A set of images produced in single study (one or more series of references images)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	Identifiers for the whole study Slice: Unordered, Open by pattern:system
identifier:studyUID	SΣ	1..1	Identifier	Identifiers for the whole study
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: urn:dicom:uid
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!Σ	1..1	code	registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
modality	Σ	1..*	Coding	All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
subject	Σ	1..1	Reference(Patient)	Who or what is the subject of the study
encounter	Σ	0..1	Reference(Encounter)	Encounter with which this imaging study is associated
started	SΣ	1..1	dateTime	When the study was started Example General: 2011-01-01T11:01:20+03:00
basedOn	Σ	0..*	Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task)	Request fulfilled
referrer	Σ	0..1	Reference(Practitioner | PractitionerRole)	Referring physician
interpreter	Σ	0..*	Reference(Practitioner | PractitionerRole)	Who interpreted images
endpoint	Σ	1..*	Reference(Imaging Study Endpoint)	Study access endpoint
numberOfSeries	Σ	0..1	unsignedInt	Number of Study Related Series
numberOfInstances	Σ	0..1	unsignedInt	Number of Study Related Instances
procedureReference	Σ	0..1	Reference(Procedure)	The performed Procedure reference
procedureCode	Σ	0..*	CodeableConcept	The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
location	Σ	0..1	Reference(Location)	Where ImagingStudy occurred
reasonCode	Σ	0..*	CodeableConcept	Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
reasonReference	Σ	0..*	Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)	Why was study performed
note	Σ	0..*	Annotation	User-defined comments
description	Σ	0..1	string	Institution-generated description
series	Σ	0..*	BackboneElement	Each study has one or more series of instances
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
uid	Σ	1..1	id	DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
number	Σ	0..1	unsignedInt	Numeric identifier of this series Example General: 3
modality	Σ	1..1	Coding	The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
description	Σ	0..1	string	A short human readable summary of the series Example General: CT Surview 180
numberOfInstances	Σ	0..1	unsignedInt	Number of Series Related Instances
endpoint	Σ	0..*	Reference(Endpoint)	Series access endpoint
bodySite	Σ	0..1	Coding	Body part examined Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
laterality	Σ	0..1	Coding	Body part laterality Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).
specimen	Σ	0..*	Reference(Specimen)	Specimen imaged
started	Σ	0..1	dateTime	When the series started
performer	Σ	0..*	BackboneElement	Who performed the series
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	Who performed the series
instance		0..*	BackboneElement	A single SOP instance from the series
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
uid		1..1	id	DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
sopClass		1..1	Coding	DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.
number		0..1	unsignedInt	The number of this instance in the series Example General: 1
title		0..1	string	Description of instance
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ImagingStudy.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
ImagingStudy.identifier:studyUID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
ImagingStudy.identifier:studyUID.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
ImagingStudy.status	required	ImagingStudyStatus http://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1 from the FHIR Standard
ImagingStudy.modality	extensible	AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html from http://tx.fhir.org/r4
ImagingStudy.procedureCode	extensible	http://www.rsna.org/RadLex_Playbook.aspx http://www.rsna.org/RadLex_Playbook.aspx
ImagingStudy.reasonCode	example	ProcedureReasonCodes http://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard
ImagingStudy.series.modality	extensible	AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html from http://tx.fhir.org/r4
ImagingStudy.series.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
ImagingStudy.series.laterality	example	Laterality http://hl7.org/fhir/ValueSet/bodysite-laterality from the FHIR Standard
ImagingStudy.series.performer.function	extensible	ImagingStudySeriesPerformerFunction http://hl7.org/fhir/ValueSet/series-performer-function from the FHIR Standard
ImagingStudy.series.instance.sopClass	extensible	http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1

This structure is derived from ImagingStudy

Summary

Mandatory: 7 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Imaging Study Endpoint (https://profiles.ihe.net/RAD/IMR/StructureDefinition/imaging-study-endpoint)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of ImagingStudy.identifier

Other representations of profile: CSV, Excel, Schematron