Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_ImagingStudy_R4B

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-ImagingStudy Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_ImagingStudy_R4B

This cross-version profile allows R5 ImagingStudy content to be represented via FHIR R4B ImagingStudy resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(4.3.0) 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:partOf 0..* Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure) R5: Part of referenced event (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.partOf
Constraints: ext-1
.... extension:reason 0..* CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport | Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media) R5: Why the study was requested / performed additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.reason
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... subject Σ 1..1 Reference(Patient | Device | Group) Who or what is the subject of the study

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required ImagingStudyStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImagingStudy.implicitRules, ImagingStudy.extension, ImagingStudy.extension:partOf, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.status, ImagingStudy.subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImagingStudy.extension, ImagingStudy.extension:partOf, ImagingStudy.extension:reason, ImagingStudy.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(4.3.0) A set of images produced in single study (one or more series of references images)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:partOf 0..* Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure) R5: Part of referenced event (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.partOf
.... extension:reason 0..* CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport | Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media) R5: Why the study was requested / performed additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.reason
... modality
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:modality 0..* CodeableConcept R5: All of the distinct values for series' modalities additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.modality
Binding: R5DicomCid33ModalityForR4B (0.1.0) (extensible): Type of acquired data in the instance.
... series
.... modality
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:modality 0..1 CodeableConcept R5: The modality used for this series additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.modality
Binding: R5DicomCid33ModalityForR4B (0.1.0) (extensible): Type of acquired data in the instance.
.... bodySite
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:bodySite 0..1 CodeableReference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B(0.1.0) | BodyStructure) R5: bodySite additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.bodySite
.... laterality
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:laterality 0..1 CodeableConcept R5: laterality additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.laterality
.... performer
..... actor
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:actor 0..1 Reference(Resource) R5: actor
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(4.3.0) 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): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:partOf 0..* Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure) R5: Part of referenced event (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.partOf
Constraints: ext-1
.... extension:reason 0..* CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport | Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media) R5: Why the study was requested / performed additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.reason
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifiers for the whole study
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality Σ 0..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:modality 0..* CodeableConcept R5: All of the distinct values for series' modalities additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.modality
Binding: R5DicomCid33ModalityForR4B (0.1.0) (extensible): Type of acquired data in the instance.
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... subject Σ 1..1 Reference(Patient | Device | Group) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
... started Σ 0..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 Σ 0..* Reference(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): Use of RadLex is preferred
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:modality 1..1 CodeableConcept R5: The modality used for this series additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.modality
Binding: R5DicomCid33ModalityForR4B (0.1.0) (extensible): Type of acquired data in the instance.
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... 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): SNOMED CT Body site concepts
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:bodySite 0..1 CodeableReference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B(0.1.0) | BodyStructure) R5: bodySite additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.bodySite
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... laterality Σ 0..1 Coding Body part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:laterality 0..1 CodeableConcept R5: laterality additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.laterality
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:actor 0..1 Reference(Resource) R5: actor
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.language Base preferred Common Languages 📍4.3.0 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📍4.3.0 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.procedureCode Base extensible http://www.rsna.org/RadLex_Playbook.aspx Not State Unknown
ImagingStudy.reasonCode Base example Procedure Reason Codes 📍4.3.0 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​bodySite Base example SNOMED CT Body Structures 📍4.3.0 FHIR Std.
ImagingStudy.series.​laterality Base example Laterality 📍4.3.0 FHIR Std.
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📍4.3.0 FHIR Std.
ImagingStudy.series.​performer.actor.type Base extensible ResourceType 📍4.3.0 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning ImagingStudy.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error ImagingStudy.meta, ImagingStudy.implicitRules, ImagingStudy.language, ImagingStudy.text, ImagingStudy.extension, ImagingStudy.extension:partOf, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.identifier, ImagingStudy.status, ImagingStudy.modality, ImagingStudy.modality.extension, ImagingStudy.modality.extension:modality, ImagingStudy.modality.system, ImagingStudy.modality.version, ImagingStudy.modality.code, ImagingStudy.modality.display, ImagingStudy.modality.userSelected, ImagingStudy.subject, ImagingStudy.encounter, ImagingStudy.started, ImagingStudy.basedOn, ImagingStudy.referrer, ImagingStudy.interpreter, ImagingStudy.endpoint, ImagingStudy.numberOfSeries, ImagingStudy.numberOfInstances, ImagingStudy.procedureReference, ImagingStudy.procedureCode, ImagingStudy.location, ImagingStudy.reasonCode, ImagingStudy.reasonReference, ImagingStudy.note, ImagingStudy.description, ImagingStudy.series, ImagingStudy.series.extension, ImagingStudy.series.modifierExtension, ImagingStudy.series.uid, ImagingStudy.series.number, ImagingStudy.series.modality, ImagingStudy.series.modality.extension, ImagingStudy.series.modality.extension:modality, ImagingStudy.series.modality.system, ImagingStudy.series.modality.version, ImagingStudy.series.modality.code, ImagingStudy.series.modality.display, ImagingStudy.series.modality.userSelected, ImagingStudy.series.description, ImagingStudy.series.numberOfInstances, ImagingStudy.series.endpoint, ImagingStudy.series.bodySite, ImagingStudy.series.bodySite.extension, ImagingStudy.series.bodySite.extension:bodySite, ImagingStudy.series.bodySite.system, ImagingStudy.series.bodySite.version, ImagingStudy.series.bodySite.code, ImagingStudy.series.bodySite.display, ImagingStudy.series.bodySite.userSelected, ImagingStudy.series.laterality, ImagingStudy.series.laterality.extension, ImagingStudy.series.laterality.extension:laterality, ImagingStudy.series.laterality.system, ImagingStudy.series.laterality.version, ImagingStudy.series.laterality.code, ImagingStudy.series.laterality.display, ImagingStudy.series.laterality.userSelected, ImagingStudy.series.specimen, ImagingStudy.series.started, ImagingStudy.series.performer, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.performer.function, ImagingStudy.series.performer.actor, ImagingStudy.series.performer.actor.extension, ImagingStudy.series.performer.actor.extension:actor, ImagingStudy.series.performer.actor.reference, ImagingStudy.series.performer.actor.type, ImagingStudy.series.performer.actor.identifier, ImagingStudy.series.performer.actor.display, ImagingStudy.series.instance, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension, ImagingStudy.series.instance.uid, ImagingStudy.series.instance.sopClass, ImagingStudy.series.instance.number, ImagingStudy.series.instance.title All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImagingStudy.extension, ImagingStudy.extension:partOf, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.modality.extension, ImagingStudy.modality.extension:modality, ImagingStudy.series.extension, ImagingStudy.series.modifierExtension, ImagingStudy.series.modality.extension, ImagingStudy.series.modality.extension:modality, ImagingStudy.series.bodySite.extension, ImagingStudy.series.bodySite.extension:bodySite, ImagingStudy.series.laterality.extension, ImagingStudy.series.laterality.extension:laterality, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.performer.actor.extension, ImagingStudy.series.performer.actor.extension:actor, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(4.3.0) 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:partOf 0..* Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure) R5: Part of referenced event (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.partOf
Constraints: ext-1
.... extension:reason 0..* CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport | Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media) R5: Why the study was requested / performed additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.reason
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... subject Σ 1..1 Reference(Patient | Device | Group) Who or what is the subject of the study

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required ImagingStudyStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImagingStudy.implicitRules, ImagingStudy.extension, ImagingStudy.extension:partOf, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.status, ImagingStudy.subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImagingStudy.extension, ImagingStudy.extension:partOf, ImagingStudy.extension:reason, ImagingStudy.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(4.3.0) A set of images produced in single study (one or more series of references images)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:partOf 0..* Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure) R5: Part of referenced event (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.partOf
.... extension:reason 0..* CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport | Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media) R5: Why the study was requested / performed additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.reason
... modality
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:modality 0..* CodeableConcept R5: All of the distinct values for series' modalities additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.modality
Binding: R5DicomCid33ModalityForR4B (0.1.0) (extensible): Type of acquired data in the instance.
... series
.... modality
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:modality 0..1 CodeableConcept R5: The modality used for this series additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.modality
Binding: R5DicomCid33ModalityForR4B (0.1.0) (extensible): Type of acquired data in the instance.
.... bodySite
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:bodySite 0..1 CodeableReference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B(0.1.0) | BodyStructure) R5: bodySite additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.bodySite
.... laterality
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:laterality 0..1 CodeableConcept R5: laterality additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.laterality
.... performer
..... actor
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:actor 0..1 Reference(Resource) R5: actor
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(4.3.0) 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): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:partOf 0..* Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure) R5: Part of referenced event (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.partOf
Constraints: ext-1
.... extension:reason 0..* CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport | Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media) R5: Why the study was requested / performed additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.reason
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifiers for the whole study
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality Σ 0..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:modality 0..* CodeableConcept R5: All of the distinct values for series' modalities additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.modality
Binding: R5DicomCid33ModalityForR4B (0.1.0) (extensible): Type of acquired data in the instance.
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... subject Σ 1..1 Reference(Patient | Device | Group) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
... started Σ 0..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 Σ 0..* Reference(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): Use of RadLex is preferred
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:modality 1..1 CodeableConcept R5: The modality used for this series additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.modality
Binding: R5DicomCid33ModalityForR4B (0.1.0) (extensible): Type of acquired data in the instance.
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... 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): SNOMED CT Body site concepts
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:bodySite 0..1 CodeableReference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B(0.1.0) | BodyStructure) R5: bodySite additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.bodySite
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... laterality Σ 0..1 Coding Body part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:laterality 0..1 CodeableConcept R5: laterality additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ImagingStudy.series.laterality
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:actor 0..1 Reference(Resource) R5: actor
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.language Base preferred Common Languages 📍4.3.0 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📍4.3.0 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.procedureCode Base extensible http://www.rsna.org/RadLex_Playbook.aspx Not State Unknown
ImagingStudy.reasonCode Base example Procedure Reason Codes 📍4.3.0 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​bodySite Base example SNOMED CT Body Structures 📍4.3.0 FHIR Std.
ImagingStudy.series.​laterality Base example Laterality 📍4.3.0 FHIR Std.
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📍4.3.0 FHIR Std.
ImagingStudy.series.​performer.actor.type Base extensible ResourceType 📍4.3.0 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning ImagingStudy.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error ImagingStudy.meta, ImagingStudy.implicitRules, ImagingStudy.language, ImagingStudy.text, ImagingStudy.extension, ImagingStudy.extension:partOf, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.identifier, ImagingStudy.status, ImagingStudy.modality, ImagingStudy.modality.extension, ImagingStudy.modality.extension:modality, ImagingStudy.modality.system, ImagingStudy.modality.version, ImagingStudy.modality.code, ImagingStudy.modality.display, ImagingStudy.modality.userSelected, ImagingStudy.subject, ImagingStudy.encounter, ImagingStudy.started, ImagingStudy.basedOn, ImagingStudy.referrer, ImagingStudy.interpreter, ImagingStudy.endpoint, ImagingStudy.numberOfSeries, ImagingStudy.numberOfInstances, ImagingStudy.procedureReference, ImagingStudy.procedureCode, ImagingStudy.location, ImagingStudy.reasonCode, ImagingStudy.reasonReference, ImagingStudy.note, ImagingStudy.description, ImagingStudy.series, ImagingStudy.series.extension, ImagingStudy.series.modifierExtension, ImagingStudy.series.uid, ImagingStudy.series.number, ImagingStudy.series.modality, ImagingStudy.series.modality.extension, ImagingStudy.series.modality.extension:modality, ImagingStudy.series.modality.system, ImagingStudy.series.modality.version, ImagingStudy.series.modality.code, ImagingStudy.series.modality.display, ImagingStudy.series.modality.userSelected, ImagingStudy.series.description, ImagingStudy.series.numberOfInstances, ImagingStudy.series.endpoint, ImagingStudy.series.bodySite, ImagingStudy.series.bodySite.extension, ImagingStudy.series.bodySite.extension:bodySite, ImagingStudy.series.bodySite.system, ImagingStudy.series.bodySite.version, ImagingStudy.series.bodySite.code, ImagingStudy.series.bodySite.display, ImagingStudy.series.bodySite.userSelected, ImagingStudy.series.laterality, ImagingStudy.series.laterality.extension, ImagingStudy.series.laterality.extension:laterality, ImagingStudy.series.laterality.system, ImagingStudy.series.laterality.version, ImagingStudy.series.laterality.code, ImagingStudy.series.laterality.display, ImagingStudy.series.laterality.userSelected, ImagingStudy.series.specimen, ImagingStudy.series.started, ImagingStudy.series.performer, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.performer.function, ImagingStudy.series.performer.actor, ImagingStudy.series.performer.actor.extension, ImagingStudy.series.performer.actor.extension:actor, ImagingStudy.series.performer.actor.reference, ImagingStudy.series.performer.actor.type, ImagingStudy.series.performer.actor.identifier, ImagingStudy.series.performer.actor.display, ImagingStudy.series.instance, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension, ImagingStudy.series.instance.uid, ImagingStudy.series.instance.sopClass, ImagingStudy.series.instance.number, ImagingStudy.series.instance.title All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImagingStudy.extension, ImagingStudy.extension:partOf, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.modality.extension, ImagingStudy.modality.extension:modality, ImagingStudy.series.extension, ImagingStudy.series.modifierExtension, ImagingStudy.series.modality.extension, ImagingStudy.series.modality.extension:modality, ImagingStudy.series.bodySite.extension, ImagingStudy.series.bodySite.extension:bodySite, ImagingStudy.series.laterality.extension, ImagingStudy.series.laterality.extension:laterality, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.performer.actor.extension, ImagingStudy.series.performer.actor.extension:actor, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron