HL7 Europe Imaging Report R5
0.2.1-ballot - ci-build
150
HL7 Europe Imaging Report R5
0.2.1-ballot - ci-build
150
HL7 Europe Imaging Report R5, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.1-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging-r5/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/imaging-study-obligation-eu-imaging | Version: 0.2.1-ballot | ||||
| Computable Name: ImagingStudyObligationEuImaging | |||||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
Obligations for ImagingStudy: General
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..* | ImagingStudyEuImaging | 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 | ||||||||
| language |
O | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||
   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 |
Σ | 1..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by value:system | ||||||||
| identifier:studyInstanceUid |
OΣ | 1..1 | StudyInstanceUidIdentifierEuImaging | Identifiers for the whole study
| ||||||||
| status |
?!OΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
| ||||||||
 modality |
OΣ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
 subject |
OΣ | 1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
OΣ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| ||||||||
| Slices for basedOn |
OΣ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by type:$this
| ||||||||
 basedOn:ServiceRequestOrderEuImagingaccession |
Σ | 0..1 | Reference(ServiceRequest: Imaging Order) | Request fulfilled | ||||||||
  reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
 identifier |
ΣC | 1..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | ||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||
| description |
OΣ | 0..1 | string | Institution-generated description
| ||||||||
 series |
OΣ | 0..* | BackboneElement | Each study has one or more series of instances
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| uid |
OΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| ||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||
| modality |
OΣ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Series Related Instances
| ||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Series access endpoint
| ||||||||
| bodySite |
OΣ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
| ||||||||
| specimen |
OΣ | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
Σ | 0..* | BackboneElement | Who performed the series Slice: Unordered, Open by value:function | ||||||||
  performer:All Slices |
Content/Rules for all slices | |||||||||||
  modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | ||||||||
| performer:performer |
OΣ | 0..1 | BackboneElement | The practitioner/device/organization that preformed the imaging.
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
 function |
Σ | 1..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 0..1 | BackboneElement | The device that did the imaging.
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
Σ | 1..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 0..1 | BackboneElement | The custodian of the report.
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
Σ | 1..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 0..1 | BackboneElement | The organization representing the location where the imaging was performed.
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
Σ | 1..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
O | 0..* | BackboneElement | A single SOP instance from the series
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:instance-description |
O | 0..1 | string | Extension: Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImagingInstanceDescription
| ||||||||
| extension:number-of-frames |
O | 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 |
O | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| ||||||||
| sopClass |
O | 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 |
O | 0..1 | unsignedInt | The number of this instance in the series Example General: 1
| ||||||||
| 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.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.performer:performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:device.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:custodian.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:organization.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| 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:')
|
| Name | Imaging Report provider | Imaging Report Consumer |
|---|---|---|
| ImagingStudy |
||
| language |
|
|
| Slices for identifier |
||
| identifier:studyInstanceUid |
|
|
| status |
|
|
| modality |
|
|
| subject |
|
|
| encounter |
|
|
| started |
|
|
| basedOn |
|
|
| endpoint |
|
|
| numberOfSeries |
|
|
| numberOfInstances |
|
|
| description |
|
|
| series |
|
|
| uid |
|
|
| number |
|
|
| modality |
|
|
| description |
|
|
| numberOfInstances |
|
|
| endpoint |
|
|
| bodySite |
|
|
| specimen |
|
|
| started |
|
|
| Slices for performer |
||
| performer:performer |
|
|
| performer:device |
|
|
| performer:custodian |
|
|
| performer:organization |
|
|
| instance |
|
|
| Slices for extension |
||
| extension:instance-description |
|
|
| extension:number-of-frames |
|
|
| uid |
|
|
| sopClass |
|
|
| number |
|
|
| Documentation for this format | ||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImagingStudyEuImaging | 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 |
O | 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 | |||||||||
| 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 |
Σ | 1..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by value:system | ||||||||
| identifier:studyInstanceUid |
OΣ | 1..1 | StudyInstanceUidIdentifierEuImaging | Identifiers for the whole study
| ||||||||
| status |
?!OΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
| ||||||||
| modality |
OΣ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
OΣ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| ||||||||
| Slices for basedOn |
OΣ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by type:$this
| ||||||||
| basedOn:ServiceRequestOrderEuImagingaccession |
Σ | 0..1 | 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 | 1..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 |
OΣ | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
OΣ | 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 |
OΣ | 0..1 | string | Institution-generated description
| ||||||||
| series |
OΣ | 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 |
OΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| ||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||
| modality |
OΣ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Series Related Instances
| ||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Series access endpoint
| ||||||||
| bodySite |
OΣ | 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 |
OΣ | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
Σ | 0..* | BackboneElement | Who performed the series Slice: Unordered, Open by value:function | ||||||||
| 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 |
OΣ | 0..1 | BackboneElement | The practitioner/device/organization that preformed 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: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 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: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 0..1 | BackboneElement | The custodian of the report.
| ||||||||
| 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: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 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: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
O | 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 | |||||||||
| extension:instance-description |
O | 0..1 | string | Extension: Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImagingInstanceDescription
| ||||||||
| extension:number-of-frames |
O | 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 |
O | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| ||||||||
| sopClass |
O | 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 |
O | 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 | ||||||||||||
| Name | Imaging Report provider | Imaging Report Consumer |
|---|---|---|
| ImagingStudy |
||
| language |
|
|
| Slices for extension |
||
| Slices for identifier |
||
| identifier:studyInstanceUid |
|
|
| status |
|
|
| modality |
|
|
| subject |
|
|
| encounter |
|
|
| started |
|
|
| Slices for basedOn |
|
|
| endpoint |
|
|
| numberOfSeries |
|
|
| numberOfInstances |
|
|
| description |
|
|
| series |
|
|
| uid |
|
|
| number |
|
|
| modality |
|
|
| description |
|
|
| numberOfInstances |
|
|
| endpoint |
|
|
| bodySite |
|
|
| specimen |
|
|
| started |
|
|
| Slices for performer |
||
| performer:performer |
|
|
| performer:device |
|
|
| performer:custodian |
|
|
| performer:organization |
|
|
| instance |
|
|
| Slices for extension |
||
| extension:instance-description |
|
|
| extension:number-of-frames |
|
|
| uid |
|
|
| sopClass |
|
|
| number |
|
|
| 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 | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:device.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:custodian.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:organization.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| 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:')
|
| Name | Imaging Report provider | Imaging Report Consumer |
|---|---|---|
| ImagingStudy |
||
| language |
|
|
| Slices for extension |
||
| Slices for identifier |
||
| identifier:studyInstanceUid |
|
|
| status |
|
|
| modality |
|
|
| subject |
|
|
| encounter |
|
|
| started |
|
|
| Slices for basedOn |
|
|
| endpoint |
|
|
| numberOfSeries |
|
|
| numberOfInstances |
|
|
| description |
|
|
| series |
|
|
| uid |
|
|
| number |
|
|
| modality |
|
|
| description |
|
|
| numberOfInstances |
|
|
| endpoint |
|
|
| bodySite |
|
|
| specimen |
|
|
| started |
|
|
| Slices for performer |
||
| performer:performer |
|
|
| performer:device |
|
|
| performer:custodian |
|
|
| performer:organization |
|
|
| instance |
|
|
| Slices for extension |
||
| extension:instance-description |
|
|
| extension:number-of-frames |
|
|
| uid |
|
|
| sopClass |
|
|
| number |
|
|
| Documentation for this format | ||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImagingStudyEuImaging | 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 | ||||||||
| language |
O | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| 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 |
Σ | 1..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by value:system | ||||||||
| identifier:studyInstanceUid |
OΣ | 1..1 | StudyInstanceUidIdentifierEuImaging | Identifiers for the whole study
| ||||||||
| status |
?!OΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
| ||||||||
| modality |
OΣ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
OΣ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| ||||||||
| Slices for basedOn |
OΣ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by type:$this
| ||||||||
| basedOn:ServiceRequestOrderEuImagingaccession |
Σ | 0..1 | Reference(ServiceRequest: Imaging Order) | Request fulfilled | ||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| identifier |
ΣC | 1..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | ||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||
| description |
OΣ | 0..1 | string | Institution-generated description
| ||||||||
| series |
OΣ | 0..* | BackboneElement | Each study has one or more series of instances
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| uid |
OΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| ||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||
| modality |
OΣ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Series Related Instances
| ||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Series access endpoint
| ||||||||
| bodySite |
OΣ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
| ||||||||
| specimen |
OΣ | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
Σ | 0..* | BackboneElement | Who performed the series Slice: Unordered, Open by value:function | ||||||||
| performer:All Slices |
Content/Rules for all slices | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | ||||||||
| performer:performer |
OΣ | 0..1 | BackboneElement | The practitioner/device/organization that preformed the imaging.
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
Σ | 1..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 0..1 | BackboneElement | The device that did the imaging.
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
Σ | 1..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 0..1 | BackboneElement | The custodian of the report.
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
Σ | 1..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 0..1 | BackboneElement | The organization representing the location where the imaging was performed.
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
Σ | 1..1 | CodeableConcept | Type of performance Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
O | 0..* | BackboneElement | A single SOP instance from the series
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:instance-description |
O | 0..1 | string | Extension: Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImagingInstanceDescription
| ||||||||
| extension:number-of-frames |
O | 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 |
O | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| ||||||||
| sopClass |
O | 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 |
O | 0..1 | unsignedInt | The number of this instance in the series Example General: 1
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Imaging Report provider | Imaging Report Consumer |
|---|---|---|
| ImagingStudy |
||
| language |
|
|
| Slices for extension |
||
| Slices for identifier |
||
| identifier:studyInstanceUid |
|
|
| status |
|
|
| modality |
|
|
| subject |
|
|
| encounter |
|
|
| started |
|
|
| Slices for basedOn |
|
|
| endpoint |
|
|
| numberOfSeries |
|
|
| numberOfInstances |
|
|
| description |
|
|
| series |
|
|
| uid |
|
|
| number |
|
|
| modality |
|
|
| description |
|
|
| numberOfInstances |
|
|
| endpoint |
|
|
| bodySite |
|
|
| specimen |
|
|
| started |
|
|
| Slices for performer |
||
| performer:performer |
|
|
| performer:device |
|
|
| performer:custodian |
|
|
| performer:organization |
|
|
| instance |
|
|
| Slices for extension |
||
| extension:instance-description |
|
|
| extension:number-of-frames |
|
|
| uid |
|
|
| sopClass |
|
|
| number |
|
|
| 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.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.performer:performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:device.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:custodian.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:organization.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| 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:')
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
0..* | ImagingStudyEuImaging | A set of images produced in single study (one or more series of references images) | |||||||||
| language |
O | 0..1 | code | Language of the resource content
| ||||||||
| Slices for identifier |
Content/Rules for all slices | |||||||||||
| identifier:studyInstanceUid |
O | 1..1 | StudyInstanceUidIdentifierEuImaging | Identifiers for the whole study
| ||||||||
| status |
O | 1..1 | code | registered | available | cancelled | entered-in-error | unknown
| ||||||||
| modality |
O | 0..* | CodeableConcept | All of the distinct values for series' modalities
| ||||||||
| subject |
O | 1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
O | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
O | 0..1 | dateTime | When the study was started
| ||||||||
| basedOn |
O | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled
| ||||||||
| endpoint |
O | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||
| numberOfSeries |
O | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
O | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||
| description |
O | 0..1 | string | Institution-generated description
| ||||||||
| series |
O | 0..* | BackboneElement | Each study has one or more series of instances
| ||||||||
| uid |
O | 1..1 | id | DICOM Series Instance UID for the series
| ||||||||
| number |
O | 0..1 | unsignedInt | Numeric identifier of this series
| ||||||||
| modality |
O | 1..1 | CodeableConcept | The modality used for this series
| ||||||||
| description |
O | 0..1 | string | A short human readable summary of the series
| ||||||||
| numberOfInstances |
O | 0..1 | unsignedInt | Number of Series Related Instances
| ||||||||
| endpoint |
O | 0..* | Reference(Endpoint) | Series access endpoint
| ||||||||
| bodySite |
O | 0..1 | CodeableReference(BodyStructure) | Body part examined
| ||||||||
| specimen |
O | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
O | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
Content/Rules for all slices | |||||||||||
| performer:performer |
O | 0..1 | BackboneElement | The practitioner/device/organization that preformed the imaging.
| ||||||||
| performer:device |
O | 0..1 | BackboneElement | The device that did the imaging.
| ||||||||
| performer:custodian |
O | 0..1 | BackboneElement | The custodian of the report.
| ||||||||
| performer:organization |
O | 0..1 | BackboneElement | The organization representing the location where the imaging was performed.
| ||||||||
| instance |
O | 0..* | BackboneElement | A single SOP instance from the series
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:instance-description |
O | 0..1 | ImagingStudyEuImagingInstanceDescription | Extension: Instance Description
| ||||||||
| extension:number-of-frames |
O | 0..1 | NumberOfFrames | Extension: Number of Frames
| ||||||||
| uid |
O | 1..1 | id | DICOM SOP Instance UID
| ||||||||
| sopClass |
O | 1..1 | Coding | DICOM class type
| ||||||||
| number |
O | 0..1 | unsignedInt | The number of this instance in the series
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Imaging Report provider | Imaging Report Consumer |
|---|---|---|
| ImagingStudy |
||
| language |
|
|
| Slices for identifier |
||
| identifier:studyInstanceUid |
|
|
| status |
|
|
| modality |
|
|
| subject |
|
|
| encounter |
|
|
| started |
|
|
| basedOn |
|
|
| endpoint |
|
|
| numberOfSeries |
|
|
| numberOfInstances |
|
|
| description |
|
|
| series |
|
|
| uid |
|
|
| number |
|
|
| modality |
|
|
| description |
|
|
| numberOfInstances |
|
|
| endpoint |
|
|
| bodySite |
|
|
| specimen |
|
|
| started |
|
|
| Slices for performer |
||
| performer:performer |
|
|
| performer:device |
|
|
| performer:custodian |
|
|
| performer:organization |
|
|
| instance |
|
|
| Slices for extension |
||
| extension:instance-description |
|
|
| extension:number-of-frames |
|
|
| uid |
|
|
| sopClass |
|
|
| number |
|
|
| Documentation for this format | ||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImagingStudyEuImaging | 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 |
O | 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 | |||||||||
| 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 |
Σ | 1..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by value:system | ||||||||
| identifier:studyInstanceUid |
OΣ | 1..1 | StudyInstanceUidIdentifierEuImaging | Identifiers for the whole study
| ||||||||
| status |
?!OΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
| ||||||||
| modality |
OΣ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU core) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
OΣ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| ||||||||
| Slices for basedOn |
OΣ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by type:$this
| ||||||||
| basedOn:ServiceRequestOrderEuImagingaccession |
Σ | 0..1 | 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 | 1..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 |
OΣ | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
OΣ | 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 |
OΣ | 0..1 | string | Institution-generated description
| ||||||||
| series |
OΣ | 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 |
OΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| ||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||
| modality |
OΣ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Series Related Instances
| ||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Series access endpoint
| ||||||||
| bodySite |
OΣ | 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 |
OΣ | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
Σ | 0..* | BackboneElement | Who performed the series Slice: Unordered, Open by value:function | ||||||||
| 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 |
OΣ | 0..1 | BackboneElement | The practitioner/device/organization that preformed 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: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 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: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 0..1 | BackboneElement | The custodian of the report.
| ||||||||
| 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: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
OΣ | 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: ValueSet: Imaging Study Performer Type Value Set (extensible) 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 |
O | 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 | |||||||||
| extension:instance-description |
O | 0..1 | string | Extension: Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImagingStudyEuImagingInstanceDescription
| ||||||||
| extension:number-of-frames |
O | 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 |
O | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| ||||||||
| sopClass |
O | 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 |
O | 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 | ||||||||||||
| Name | Imaging Report provider | Imaging Report Consumer |
|---|---|---|
| ImagingStudy |
||
| language |
|
|
| Slices for extension |
||
| Slices for identifier |
||
| identifier:studyInstanceUid |
|
|
| status |
|
|
| modality |
|
|
| subject |
|
|
| encounter |
|
|
| started |
|
|
| Slices for basedOn |
|
|
| endpoint |
|
|
| numberOfSeries |
|
|
| numberOfInstances |
|
|
| description |
|
|
| series |
|
|
| uid |
|
|
| number |
|
|
| modality |
|
|
| description |
|
|
| numberOfInstances |
|
|
| endpoint |
|
|
| bodySite |
|
|
| specimen |
|
|
| started |
|
|
| Slices for performer |
||
| performer:performer |
|
|
| performer:device |
|
|
| performer:custodian |
|
|
| performer:organization |
|
|
| instance |
|
|
| Slices for extension |
||
| extension:instance-description |
|
|
| extension:number-of-frames |
|
|
| uid |
|
|
| sopClass |
|
|
| number |
|
|
| 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 | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:device.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:custodian.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| ImagingStudy.series.performer:organization.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦0.2.1-ballot | This IG |
| 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:')
|
| Name | Imaging Report provider | Imaging Report Consumer |
|---|---|---|
| ImagingStudy |
||
| language |
|
|
| Slices for extension |
||
| Slices for identifier |
||
| identifier:studyInstanceUid |
|
|
| status |
|
|
| modality |
|
|
| subject |
|
|
| encounter |
|
|
| started |
|
|
| Slices for basedOn |
|
|
| endpoint |
|
|
| numberOfSeries |
|
|
| numberOfInstances |
|
|
| description |
|
|
| series |
|
|
| uid |
|
|
| number |
|
|
| modality |
|
|
| description |
|
|
| numberOfInstances |
|
|
| endpoint |
|
|
| bodySite |
|
|
| specimen |
|
|
| started |
|
|
| Slices for performer |
||
| performer:performer |
|
|
| performer:device |
|
|
| performer:custodian |
|
|
| performer:organization |
|
|
| instance |
|
|
| Slices for extension |
||
| extension:instance-description |
|
|
| extension:number-of-frames |
|
|
| uid |
|
|
| sopClass |
|
|
| number |
|
|
| Documentation for this format | ||
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.imaging-r5#0.2.1-ballot based on FHIR 5.0.0.
Generated
2026-03-02
