EU Imaging Report R5
1.0.0-ballot - ci-build
150
EU Imaging Report R5
1.0.0-ballot - ci-build
150
EU Imaging Report R5, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-r5/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImaging | Version: 1.0.0-ballot | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: ImagingStudyEuImaging | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
This profile represents an imaging study instance.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ImagingStudy |
C | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) Constraints: im-imagingstudy-01 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 Slices for identifier |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by profile:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:studyInstanceUid |
0..1 | StudyInstanceUidIdentifierEuImaging | Study Instance UID | |
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | |
 subject |
1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study | |
 Slices for basedOn |
0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  basedOn:ServiceRequestOrderEuImagingaccession |
0..* | Reference(ServiceRequest: Imaging Order) | Request fulfilled | |
 reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
  identifier |
C | 0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.status | Base | required | Imaging Study Status | 📍5.0.0 | FHIR Std. |
| 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' |
identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')
|
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) Constraints: im-imagingstudy-01 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |
| Slices for identifier |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by profile:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:studyInstanceUid |
0..1 | StudyInstanceUidIdentifierEuImaging | Study Instance UID | |
| subject |
1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study | |
| Slices for basedOn |
0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| basedOn:ServiceRequestOrderEuImagingaccession |
0..* | Reference(ServiceRequest: Imaging Order) | Request fulfilled | |
| identifier |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |
 series |
||||
| Slices for performer |
0..* | BackboneElement | Who performed the series Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 performer:All Slices |
Content/Rules for all slices | |||
 function |
0..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) | |
| performer:performer |
0..1 | BackboneElement | The practitioner/device/organization that performed the imaging. | |
 function |
1..1 | CodeableConcept | Type of performance Required Pattern: At least the following | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| actor |
1..1 | Reference(PractitionerRole (EU core) | Device | Organization (EU core)) | Who performed the series | |
| performer:device |
0..1 | BackboneElement | The device that did the imaging. | |
| function |
1..1 | CodeableConcept | Type of performance Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |
| actor |
1..1 | Reference(Device: Imaging Device) | Who performed the series | |
| performer:custodian |
0..1 | BackboneElement | The custodian of the imaging study. | |
| function |
1..1 | CodeableConcept | Type of performance Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |
| actor |
1..1 | Reference(Organization (EU core)) | Who performed the series | |
| performer:organization |
0..1 | BackboneElement | The organization representing the location where the imaging was performed. | |
| function |
1..1 | CodeableConcept | Type of performance Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: LOC | |
| actor |
1..1 | Reference(Organization (EU core)) | Who performed the series | |
| instance |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 extension:instance-description |
0..1 | string | Extension: Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImagingInstanceDescription | |
| extension:number-of-frames |
0..1 | integer | Extension: Number of Frames URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/NumberOfFrames | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.series.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' |
identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) Constraints: im-imagingstudy-01 | ||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by profile:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:studyInstanceUid |
0..1 | StudyInstanceUidIdentifierEuImaging | Study Instance UID | |||||
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | |||||
| modality |
0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance. | |||||
| subject |
1..1 | Reference(Patient (EU core) | Device) | 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 | |||||
| Slices for basedOn |
0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| basedOn:ServiceRequestOrderEuImagingaccession |
0..* | Reference(ServiceRequest: Imaging Order) | Request fulfilled | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
C | 0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | ||||
| display |
C | 0..1 | string | Text alternative for the resource | ||||
| partOf |
0..* | Reference(Procedure) | Part of referenced event | |||||
| referrer |
0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | |||||
| 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 | |||||
| procedure |
0..* | CodeableReference(PlanDefinition | ActivityDefinition) | The performed procedure or code Binding: LOINC loinc-rsna-radiology-playbook (preferred): Use of RadLex is preferred | |||||
| location |
0..1 | Reference(Location) | Where ImagingStudy occurred | |||||
| reason |
0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the study was requested / performed Binding: ProcedureReasonCodes (example): The reason for the study. | |||||
| 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 | CodeableConcept | The modality used for this series Binding: Modality (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 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| laterality |
0..1 | CodeableConcept | 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 | |||||
| Slices for performer |
0..* | BackboneElement | Who performed the series Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| performer:All Slices |
Content/Rules for all slices | |||||||
| 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: ValueSet: Imaging Study Performer Type Value Set (extensible) | |||||
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | |||||
| performer:performer |
0..1 | BackboneElement | The practitioner/device/organization that performed the imaging. | |||||
| 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 |
1..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
1..1 | Reference(PractitionerRole (EU core) | Device | Organization (EU core)) | Who performed the series | |||||
| performer:device |
0..1 | BackboneElement | The device that did the imaging. | |||||
| 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 |
1..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
1..1 | Reference(Device: Imaging Device) | Who performed the series | |||||
| performer:custodian |
0..1 | BackboneElement | The custodian of the imaging study. | |||||
| 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 |
1..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
1..1 | Reference(Organization (EU core)) | Who performed the series | |||||
| performer:organization |
0..1 | BackboneElement | The organization representing the location where the imaging was performed. | |||||
| 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 |
1..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: LOC | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
1..1 | Reference(Organization (EU core)) | Who performed the series | |||||
| instance |
0..* | BackboneElement | A single SOP instance from the series | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:instance-description |
0..1 | string | Extension: Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImagingInstanceDescription | |||||
| extension:number-of-frames |
0..1 | integer | Extension: Number of Frames URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/NumberOfFrames | |||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ImagingStudy.status | Base | required | Imaging Study Status | 📍5.0.0 | FHIR Std. |
| ImagingStudy.modality | Base | extensible | Modality | 📦2025.3.20250714 | DICOM v2025c |
| ImagingStudy.basedOn:ServiceRequestOrderEuImagingaccession.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| ImagingStudy.procedure | Base | preferred |
LOINC/RSNA Radiology Playbook
|
∅ | tx.fhir.org |
| ImagingStudy.reason | Base | example | Procedure Reason Codes | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.modality | Base | extensible | Modality | 📦2025.3.20250714 | DICOM v2025c |
| ImagingStudy.series.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.laterality | Base | example | Laterality | 📦2025.3.20250714 | DICOM v2025c |
| ImagingStudy.series.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| ImagingStudy.series.performer:performer.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.performer:device.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.performer:custodian.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.performer:organization.function | Base | extensible | ImagingStudy series performer function | 📍5.0.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 |
| 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' |
identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')
|
This structure is derived from ImagingStudy
Summary
Mandatory: 0 element(4 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) Constraints: im-imagingstudy-01 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by profile:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:studyInstanceUid |
0..1 | StudyInstanceUidIdentifierEuImaging | Study Instance UID | |
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | |
| subject |
1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study | |
| Slices for basedOn |
0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| basedOn:ServiceRequestOrderEuImagingaccession |
0..* | Reference(ServiceRequest: Imaging Order) | Request fulfilled | |
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
C | 0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.status | Base | required | Imaging Study Status | 📍5.0.0 | FHIR Std. |
| 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' |
identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')
|
Differential View
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) Constraints: im-imagingstudy-01 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |
| Slices for identifier |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by profile:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:studyInstanceUid |
0..1 | StudyInstanceUidIdentifierEuImaging | Study Instance UID | |
| subject |
1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study | |
| Slices for basedOn |
0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| basedOn:ServiceRequestOrderEuImagingaccession |
0..* | Reference(ServiceRequest: Imaging Order) | Request fulfilled | |
| identifier |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |
| series |
||||
| Slices for performer |
0..* | BackboneElement | Who performed the series Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| performer:All Slices |
Content/Rules for all slices | |||
| function |
0..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) | |
| performer:performer |
0..1 | BackboneElement | The practitioner/device/organization that performed the imaging. | |
| function |
1..1 | CodeableConcept | Type of performance Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| actor |
1..1 | Reference(PractitionerRole (EU core) | Device | Organization (EU core)) | Who performed the series | |
| performer:device |
0..1 | BackboneElement | The device that did the imaging. | |
| function |
1..1 | CodeableConcept | Type of performance Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |
| actor |
1..1 | Reference(Device: Imaging Device) | Who performed the series | |
| performer:custodian |
0..1 | BackboneElement | The custodian of the imaging study. | |
| function |
1..1 | CodeableConcept | Type of performance Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |
| actor |
1..1 | Reference(Organization (EU core)) | Who performed the series | |
| performer:organization |
0..1 | BackboneElement | The organization representing the location where the imaging was performed. | |
| function |
1..1 | CodeableConcept | Type of performance Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: LOC | |
| actor |
1..1 | Reference(Organization (EU core)) | Who performed the series | |
| instance |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:instance-description |
0..1 | string | Extension: Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImagingInstanceDescription | |
| extension:number-of-frames |
0..1 | integer | Extension: Number of Frames URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/NumberOfFrames | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.series.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' |
identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) Constraints: im-imagingstudy-01 | ||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by profile:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:studyInstanceUid |
0..1 | StudyInstanceUidIdentifierEuImaging | Study Instance UID | |||||
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | |||||
| modality |
0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance. | |||||
| subject |
1..1 | Reference(Patient (EU core) | Device) | 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 | |||||
| Slices for basedOn |
0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| basedOn:ServiceRequestOrderEuImagingaccession |
0..* | Reference(ServiceRequest: Imaging Order) | Request fulfilled | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
C | 0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | ||||
| display |
C | 0..1 | string | Text alternative for the resource | ||||
| partOf |
0..* | Reference(Procedure) | Part of referenced event | |||||
| referrer |
0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | |||||
| 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 | |||||
| procedure |
0..* | CodeableReference(PlanDefinition | ActivityDefinition) | The performed procedure or code Binding: LOINC loinc-rsna-radiology-playbook (preferred): Use of RadLex is preferred | |||||
| location |
0..1 | Reference(Location) | Where ImagingStudy occurred | |||||
| reason |
0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the study was requested / performed Binding: ProcedureReasonCodes (example): The reason for the study. | |||||
| 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 | CodeableConcept | The modality used for this series Binding: Modality (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 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| laterality |
0..1 | CodeableConcept | 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 | |||||
| Slices for performer |
0..* | BackboneElement | Who performed the series Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| performer:All Slices |
Content/Rules for all slices | |||||||
| 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: ValueSet: Imaging Study Performer Type Value Set (extensible) | |||||
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | |||||
| performer:performer |
0..1 | BackboneElement | The practitioner/device/organization that performed the imaging. | |||||
| 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 |
1..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
1..1 | Reference(PractitionerRole (EU core) | Device | Organization (EU core)) | Who performed the series | |||||
| performer:device |
0..1 | BackboneElement | The device that did the imaging. | |||||
| 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 |
1..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
1..1 | Reference(Device: Imaging Device) | Who performed the series | |||||
| performer:custodian |
0..1 | BackboneElement | The custodian of the imaging study. | |||||
| 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 |
1..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
1..1 | Reference(Organization (EU core)) | Who performed the series | |||||
| performer:organization |
0..1 | BackboneElement | The organization representing the location where the imaging was performed. | |||||
| 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 |
1..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: LOC | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
1..1 | Reference(Organization (EU core)) | Who performed the series | |||||
| instance |
0..* | BackboneElement | A single SOP instance from the series | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:instance-description |
0..1 | string | Extension: Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImagingInstanceDescription | |||||
| extension:number-of-frames |
0..1 | integer | Extension: Number of Frames URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/NumberOfFrames | |||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ImagingStudy.status | Base | required | Imaging Study Status | 📍5.0.0 | FHIR Std. |
| ImagingStudy.modality | Base | extensible | Modality | 📦2025.3.20250714 | DICOM v2025c |
| ImagingStudy.basedOn:ServiceRequestOrderEuImagingaccession.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| ImagingStudy.procedure | Base | preferred |
LOINC/RSNA Radiology Playbook
|
∅ | tx.fhir.org |
| ImagingStudy.reason | Base | example | Procedure Reason Codes | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.modality | Base | extensible | Modality | 📦2025.3.20250714 | DICOM v2025c |
| ImagingStudy.series.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.laterality | Base | example | Laterality | 📦2025.3.20250714 | DICOM v2025c |
| ImagingStudy.series.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| ImagingStudy.series.performer:performer.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.performer:device.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.performer:custodian.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.performer:organization.function | Base | extensible | ImagingStudy series performer function | 📍5.0.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 |
| 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' |
identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')
|
This structure is derived from ImagingStudy
Summary
Mandatory: 0 element(4 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.imaging-r5#1.0.0-ballot based on FHIR 5.0.0.
Generated
2026-10-13
