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/diagnostic-report-obligation-eu-imaging | Version: 1.0.0-ballot | ||||
| Draft as of 2026-10-21 | Computable Name: DiagnosticReportObligationEuImaging | ||||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
Obligations for DiagnosticReport: Imaging Report
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:  | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  DiagnosticReport |
C | 0..* | DiagnosticReportEuImaging | Diagnostic Report EU core Constraints: dgr-1, eu-imaging-dr-status-replacement, eu-imaging-dr-status-retraction, eu-imaging-dr-status-no-addendum | ||||||||
  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
| |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||
   extension:DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |||||||||
   extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |||||||||
  value[x] |
1..1 | Reference(Composition (EU core)) | Value of extension | |||||||||
| extension:note |
0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" | |||||||||
  value[x] |
1..1 | Annotation | Value of extension | |||||||||
 Slices for extension |
Content/Rules for all slices | |||||||||||
 extension:annotation-type |
0..* | (Complex) | The type of annotation URL: http://hl7.org/fhir/StructureDefinition/annotationType | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/annotationType" | |||||||||
| value[x] |
1..1 | CodeableConcept | Type of note Binding: hl7VS-commentType (example) | |||||||||
 text |
1..1 | markdown | The annotation - text content (as markdown) | |||||||||
 extension:artifactVersion |
0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version
| |||||||||
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study this report reports on. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |||||||||
| extension:comparison |
0..* | Reference(ImagingStudy: Reported Study | ImagingSelection: General) | Extension: HL7IDR DiagnosticReport Comparison Study URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
| |||||||||
| extension:patientHistory |
0..* | Reference() | Extension: HL7IDR Patient History URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
| |||||||||
| extension:procedure |
0..* | Reference(Procedure: Imaging Acquisition | AdverseEvent | Observation: Radiation Dose) | Extension: HL7IDR Imaging Procedure URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
| |||||||||
| extension:finding |
0..* | Reference(Observation: Imaging Finding | ImagingSelection: Key Image | DocumentReference: Key Image | DocumentReference) | Key image findings URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding | |||||||||
| extension:impression |
0..* | Reference(Observation: Imaging Finding | Condition | ImagingSelection: Key Image | DocumentReference: Key Image) | Extension: HL7IDR Impression URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
| |||||||||
| extension:recommendation |
0..* | Reference(CarePlan | ServiceRequest) | Extension: HL7IDR Recommendation URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
| |||||||||
| extension:communication |
0..* | Reference() | Communications with other care providers URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication | |||||||||
 extension:informationRecipient |
0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | CareTeam | Group) | Composition: Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
| |||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier |
1..* | Identifier | Report identifier
| |||||||||
| Slices for basedOn |
0..* | Reference(ServiceRequest) | What was requested Slice: Unordered, Open by type:$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) | What was requested
| |||||||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| status |
1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
| |||||||||
| Slices for category |
2..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| category:diagnostic-service |
0..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (required)
| |||||||||
| category:imaging-report |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern:
| |||||||||
| category:imaging |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern: | |||||||||
| code |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report Binding: ValueSet: Radiology Report Types (preferred) | |||||||||
| subject |
1..1 | Reference(Patient (EU core)) | Who and/or what this report is about
| |||||||||
| Slices for effective[x] |
0..1 | Clinically relevant time/time-period for report. Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| effective[x]:effectivePeriod |
0..1 | Period | Clinically relevant time/time-period for report.
| |||||||||
| issued |
0..1 | instant | Date and time of report issuance
| |||||||||
| Slices for performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. Slice: Unordered, Open by profile:$this | |||||||||
| performer:organization |
0..* | Reference(Organization (EU core)) | The organization producer of this report
| |||||||||
| Slices for resultsInterpreter |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter Slice: Unordered, Open by profile:resolve() | |||||||||
| resultsInterpreter:author |
0..* | Reference(PractitionerRole (EU core)) | Primary interpreter of results
| |||||||||
| result |
C | 1..* | Reference(Observation: Imaging Finding | Observation: Narrative Report) | Findings
| ||||||||
| note |
0..* | Annotation | Comments about the diagnostic report
| |||||||||
| media |
0..* | BackboneElement | Additional data (like images, diagrams or documents) associated with this report
| |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| link |
1..1 | Reference(DocumentReference) | Reference to the image or data | |||||||||
| composition |
C | 1..1 | Reference(Composition: Imaging Report) | Imaging Diagnostic Report
| ||||||||
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended)
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.extension:note.value[x].extension:annotation-type.value[x] | Base | example | hl7VS-commentType | 📦3.0.0 | THO v7.1 |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category:diagnostic-service | Base | required | Diagnostic Service Section Codes | 📦5.0.0 | FHIR Std. |
| DiagnosticReport.category:imaging-report | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category:imaging | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | ValueSet: Radiology Report Types | 📦1.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` |
composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))
|
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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 | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | 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())
|
| eu-imaging-dr-status-no-addendum | error | DiagnosticReport | DiagnosticReport.status SHALL NOT be 'appended' or 'corrected'; content added or corrected after final issuance is represented as a complete replacement with status 'amended'. |
status != 'appended' and status != 'corrected'
|
| eu-imaging-dr-status-replacement | error | DiagnosticReport | DiagnosticReport.status SHALL be 'amended' if and only if the referenced Composition replaces a prior report and has status 'final'. |
(status = 'amended') = composition.resolve().where(status = 'final' and relatesTo.where(type = 'replaces').exists()).exists()
|
| eu-imaging-dr-status-retraction | error | DiagnosticReport | DiagnosticReport.status SHALL be 'entered-in-error' if and only if the referenced Composition retracts a prior report by replacing it with status 'entered-in-error'. |
(status = 'entered-in-error') = composition.resolve().where(status = 'entered-in-error' and relatesTo.where(type = 'replaces').exists()).exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DiagnosticReportEuImaging
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReportEuImaging | Diagnostic Report EU core | |||||||
 language |
0..1 | code | Language of the resource content
| |||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:artifactVersion |
0..1 | ArtifactVersion(5.3.0-ballot) | Business version of the artifact
| |||||||
| extension:comparison |
0..* | HL7IDRComparisonStudiesExt | Extension: HL7IDR DiagnosticReport Comparison Study
| |||||||
| extension:patientHistory |
0..* | HL7IDRPatientHistoryExt | Extension: HL7IDR Patient History
| |||||||
| extension:procedure |
0..* | HL7IDRImagingProcedureExt | Extension: HL7IDR Imaging Procedure
| |||||||
| extension:impression |
0..* | HL7IDRImpressionExt | Extension: HL7IDR Impression
| |||||||
| extension:recommendation |
0..* | HL7IDRRecommendationExt | Extension: HL7IDR Recommendation
| |||||||
| extension:informationRecipient |
0..* | InformationRecipient | Composition: Information recipient
| |||||||
| identifier |
1..* | Identifier | Report identifier
| |||||||
| Slices for basedOn |
Content/Rules for all slices | |||||||||
| basedOn:ServiceRequestOrderEuImagingaccession |
0..* | Reference(ServiceRequest: Imaging Order) | What was requested
| |||||||
| status |
1..1 | code | Status of the Report
| |||||||
| Slices for category |
Content/Rules for all slices | |||||||||
| category:diagnostic-service |
0..1 | CodeableConcept | Service category
| |||||||
| category:imaging-report |
1..1 | CodeableConcept | Service category
| |||||||
| subject |
1..1 | Reference(Patient (EU core)) | Who and/or what this report is about
| |||||||
| Slices for effective[x] |
0..1 | dateTime, Period | Clinically relevant time/time-period for report. Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |||||||
| effective[x]:effectivePeriod |
0..1 | Period | Clinically relevant time/time-period for report.
| |||||||
| issued |
0..1 | instant | Date and time of report issuance
| |||||||
| Slices for performer |
Content/Rules for all slices | |||||||||
| performer:organization |
0..* | Reference(Organization (EU core)) | The organization producer of this report
| |||||||
| Slices for resultsInterpreter |
Content/Rules for all slices | |||||||||
| resultsInterpreter:author |
0..* | Reference(PractitionerRole (EU core)) | Primary interpreter of results
| |||||||
| result |
1..* | Reference(Observation: Imaging Finding | Observation: Narrative Report) | Findings
| |||||||
| note |
0..* | Annotation | Comments about the diagnostic report
| |||||||
| media |
0..* | BackboneElement | Additional data (like images, diagrams or documents) associated with this report
| |||||||
| composition |
1..1 | Reference(Composition: Imaging Report) | Imaging Diagnostic Report
| |||||||
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended)
| |||||||
| Documentation for this format | ||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | DiagnosticReportEuImaging | Diagnostic Report EU core Constraints: dgr-1, eu-imaging-dr-status-replacement, eu-imaging-dr-status-retraction, eu-imaging-dr-status-no-addendum | ||||||||
| 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 | |||||||||
| extension:DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |||||||||
| value[x] |
1..1 | Reference(Composition (EU core)) | Value of extension | |||||||||
| extension:note |
0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" | |||||||||
| value[x] |
1..1 | Annotation | Value of extension | |||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:annotation-type |
0..* | (Complex) | The type of annotation URL: http://hl7.org/fhir/StructureDefinition/annotationType | |||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/annotationType" | |||||||||
| value[x] |
1..1 | CodeableConcept | Type of note Binding: hl7VS-commentType (example) | |||||||||
 author[x] |
0..1 | Individual responsible for the annotation | ||||||||||
| authorReference |
Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||||||||||
| authorString |
string | |||||||||||
| time |
0..1 | dateTime | When the annotation was made | |||||||||
| text |
1..1 | markdown | The annotation - text content (as markdown) | |||||||||
| extension:artifactVersion |
0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version
| |||||||||
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study this report reports on. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |||||||||
| extension:comparison |
0..* | Reference(ImagingStudy: Reported Study | ImagingSelection: General) | Extension: HL7IDR DiagnosticReport Comparison Study URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
| |||||||||
| extension:patientHistory |
0..* | Reference() | Extension: HL7IDR Patient History URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
| |||||||||
| extension:procedure |
0..* | Reference(Procedure: Imaging Acquisition | AdverseEvent | Observation: Radiation Dose) | Extension: HL7IDR Imaging Procedure URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
| |||||||||
| extension:finding |
0..* | Reference(Observation: Imaging Finding | ImagingSelection: Key Image | DocumentReference: Key Image | DocumentReference) | Key image findings URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding | |||||||||
| extension:impression |
0..* | Reference(Observation: Imaging Finding | Condition | ImagingSelection: Key Image | DocumentReference: Key Image) | Extension: HL7IDR Impression URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
| |||||||||
| extension:recommendation |
0..* | Reference(CarePlan | ServiceRequest) | Extension: HL7IDR Recommendation URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
| |||||||||
| extension:communication |
0..* | Reference() | Communications with other care providers URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication | |||||||||
| extension:informationRecipient |
0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | CareTeam | Group) | Composition: Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
| |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier |
1..* | Identifier | Report identifier
| |||||||||
| Slices for basedOn |
0..* | Reference(ServiceRequest) | What was requested Slice: Unordered, Open by type:$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) | What was requested
| |||||||||
| 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 | ||||||||
| status |
1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
| |||||||||
| Slices for category |
2..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| category:diagnostic-service |
0..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (required)
| |||||||||
| category:imaging-report |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern:
| |||||||||
| category:imaging |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern: | |||||||||
| code |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report Binding: ValueSet: Radiology Report Types (preferred) | |||||||||
| subject |
1..1 | Reference(Patient (EU core)) | Who and/or what this report is about
| |||||||||
| encounter |
0..1 | Reference(Encounter) | The healthcare event which this Diagnostic Report is about (when test ordered). | |||||||||
| Slices for effective[x] |
0..1 | Clinically relevant time/time-period for report. Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| effective[x]:effectivePeriod |
0..1 | Period | Clinically relevant time/time-period for report.
| |||||||||
| issued |
0..1 | instant | Date and time of report issuance
| |||||||||
| Slices for performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. Slice: Unordered, Open by profile:$this | |||||||||
| performer:organization |
0..* | Reference(Organization (EU core)) | The organization producer of this report
| |||||||||
| Slices for resultsInterpreter |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter Slice: Unordered, Open by profile:resolve() | |||||||||
| resultsInterpreter:author |
0..* | Reference(PractitionerRole (EU core)) | Primary interpreter of results
| |||||||||
| specimen |
0..* | Reference(Specimen) | Specimens this report is based on. | |||||||||
| result |
C | 1..* | Reference(Observation: Imaging Finding | Observation: Narrative Report) | Findings
| ||||||||
| note |
0..* | Annotation | Comments about the diagnostic report
| |||||||||
| study |
0..* | Reference(ImagingStudy: Reported Study) | Study subject to this report | |||||||||
| supportingInfo |
0..* | BackboneElement | Additional information supporting the diagnostic 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 | |||||||||
| type |
1..1 | CodeableConcept | Supporting information role code Binding: hl7VS-VS-observationType (example): The code value for the role of the supporting information in the diagnostic report. | |||||||||
| reference |
1..1 | Reference(Procedure | Observation | DiagnosticReport | Citation) | Supporting information reference | |||||||||
| media |
0..* | BackboneElement | Additional data (like images, diagrams or documents) associated with this 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 | |||||||||
| comment |
0..1 | string | Comment about the image or data (e.g. explanation) | |||||||||
| link |
1..1 | Reference(DocumentReference) | Reference to the image or data | |||||||||
| composition |
C | 1..1 | Reference(Composition: Imaging Report) | Imaging Diagnostic Report
| ||||||||
| conclusion |
0..1 | markdown | Clinical conclusion (interpretation) of test results | |||||||||
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): SNOMED CT Clinical Findings | |||||||||
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended)
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.extension:note.value[x].extension:annotation-type.value[x] | Base | example | hl7VS-commentType | 📦3.0.0 | THO v7.1 |
| DiagnosticReport.basedOn:ServiceRequestOrderEuImagingaccession.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category:diagnostic-service | Base | required | Diagnostic Service Section Codes | 📦5.0.0 | FHIR Std. |
| DiagnosticReport.category:imaging-report | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category:imaging | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | ValueSet: Radiology Report Types | 📦1.0.0-ballot | This IG |
| DiagnosticReport.supportingInfo.type | Base | example | hl7VS-VS-observationType | 📦3.0.0 | THO v7.1 |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` |
composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))
|
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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 | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | 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())
|
| eu-imaging-dr-status-no-addendum | error | DiagnosticReport | DiagnosticReport.status SHALL NOT be 'appended' or 'corrected'; content added or corrected after final issuance is represented as a complete replacement with status 'amended'. |
status != 'appended' and status != 'corrected'
|
| eu-imaging-dr-status-replacement | error | DiagnosticReport | DiagnosticReport.status SHALL be 'amended' if and only if the referenced Composition replaces a prior report and has status 'final'. |
(status = 'amended') = composition.resolve().where(status = 'final' and relatesTo.where(type = 'replaces').exists()).exists()
|
| eu-imaging-dr-status-retraction | error | DiagnosticReport | DiagnosticReport.status SHALL be 'entered-in-error' if and only if the referenced Composition retracts a prior report by replacing it with status 'entered-in-error'. |
(status = 'entered-in-error') = composition.resolve().where(status = 'entered-in-error' and relatesTo.where(type = 'replaces').exists()).exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DiagnosticReportEuImaging
Summary
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | DiagnosticReportEuImaging | Diagnostic Report EU core Constraints: dgr-1, eu-imaging-dr-status-replacement, eu-imaging-dr-status-retraction, eu-imaging-dr-status-no-addendum | ||||||||
| 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
| |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |||||||||
| value[x] |
1..1 | Reference(Composition (EU core)) | Value of extension | |||||||||
| extension:note |
0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" | |||||||||
| value[x] |
1..1 | Annotation | Value of extension | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:annotation-type |
0..* | (Complex) | The type of annotation URL: http://hl7.org/fhir/StructureDefinition/annotationType | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/annotationType" | |||||||||
| value[x] |
1..1 | CodeableConcept | Type of note Binding: hl7VS-commentType (example) | |||||||||
| text |
1..1 | markdown | The annotation - text content (as markdown) | |||||||||
| extension:artifactVersion |
0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version
| |||||||||
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study this report reports on. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |||||||||
| extension:comparison |
0..* | Reference(ImagingStudy: Reported Study | ImagingSelection: General) | Extension: HL7IDR DiagnosticReport Comparison Study URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
| |||||||||
| extension:patientHistory |
0..* | Reference() | Extension: HL7IDR Patient History URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
| |||||||||
| extension:procedure |
0..* | Reference(Procedure: Imaging Acquisition | AdverseEvent | Observation: Radiation Dose) | Extension: HL7IDR Imaging Procedure URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
| |||||||||
| extension:finding |
0..* | Reference(Observation: Imaging Finding | ImagingSelection: Key Image | DocumentReference: Key Image | DocumentReference) | Key image findings URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding | |||||||||
| extension:impression |
0..* | Reference(Observation: Imaging Finding | Condition | ImagingSelection: Key Image | DocumentReference: Key Image) | Extension: HL7IDR Impression URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
| |||||||||
| extension:recommendation |
0..* | Reference(CarePlan | ServiceRequest) | Extension: HL7IDR Recommendation URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
| |||||||||
| extension:communication |
0..* | Reference() | Communications with other care providers URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication | |||||||||
| extension:informationRecipient |
0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | CareTeam | Group) | Composition: Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
| |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier |
1..* | Identifier | Report identifier
| |||||||||
| Slices for basedOn |
0..* | Reference(ServiceRequest) | What was requested Slice: Unordered, Open by type:$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) | What was requested
| |||||||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| status |
1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
| |||||||||
| Slices for category |
2..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| category:diagnostic-service |
0..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (required)
| |||||||||
| category:imaging-report |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern:
| |||||||||
| category:imaging |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern: | |||||||||
| code |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report Binding: ValueSet: Radiology Report Types (preferred) | |||||||||
| subject |
1..1 | Reference(Patient (EU core)) | Who and/or what this report is about
| |||||||||
| Slices for effective[x] |
0..1 | Clinically relevant time/time-period for report. Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| effective[x]:effectivePeriod |
0..1 | Period | Clinically relevant time/time-period for report.
| |||||||||
| issued |
0..1 | instant | Date and time of report issuance
| |||||||||
| Slices for performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. Slice: Unordered, Open by profile:$this | |||||||||
| performer:organization |
0..* | Reference(Organization (EU core)) | The organization producer of this report
| |||||||||
| Slices for resultsInterpreter |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter Slice: Unordered, Open by profile:resolve() | |||||||||
| resultsInterpreter:author |
0..* | Reference(PractitionerRole (EU core)) | Primary interpreter of results
| |||||||||
| result |
C | 1..* | Reference(Observation: Imaging Finding | Observation: Narrative Report) | Findings
| ||||||||
| note |
0..* | Annotation | Comments about the diagnostic report
| |||||||||
| media |
0..* | BackboneElement | Additional data (like images, diagrams or documents) associated with this report
| |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| link |
1..1 | Reference(DocumentReference) | Reference to the image or data | |||||||||
| composition |
C | 1..1 | Reference(Composition: Imaging Report) | Imaging Diagnostic Report
| ||||||||
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended)
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.extension:note.value[x].extension:annotation-type.value[x] | Base | example | hl7VS-commentType | 📦3.0.0 | THO v7.1 |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category:diagnostic-service | Base | required | Diagnostic Service Section Codes | 📦5.0.0 | FHIR Std. |
| DiagnosticReport.category:imaging-report | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category:imaging | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | ValueSet: Radiology Report Types | 📦1.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` |
composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))
|
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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 | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | 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())
|
| eu-imaging-dr-status-no-addendum | error | DiagnosticReport | DiagnosticReport.status SHALL NOT be 'appended' or 'corrected'; content added or corrected after final issuance is represented as a complete replacement with status 'amended'. |
status != 'appended' and status != 'corrected'
|
| eu-imaging-dr-status-replacement | error | DiagnosticReport | DiagnosticReport.status SHALL be 'amended' if and only if the referenced Composition replaces a prior report and has status 'final'. |
(status = 'amended') = composition.resolve().where(status = 'final' and relatesTo.where(type = 'replaces').exists()).exists()
|
| eu-imaging-dr-status-retraction | error | DiagnosticReport | DiagnosticReport.status SHALL be 'entered-in-error' if and only if the referenced Composition retracts a prior report by replacing it with status 'entered-in-error'. |
(status = 'entered-in-error') = composition.resolve().where(status = 'entered-in-error' and relatesTo.where(type = 'replaces').exists()).exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from DiagnosticReportEuImaging
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReportEuImaging | Diagnostic Report EU core | |||||||
| language |
0..1 | code | Language of the resource content
| |||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:artifactVersion |
0..1 | ArtifactVersion(5.3.0-ballot) | Business version of the artifact
| |||||||
| extension:comparison |
0..* | HL7IDRComparisonStudiesExt | Extension: HL7IDR DiagnosticReport Comparison Study
| |||||||
| extension:patientHistory |
0..* | HL7IDRPatientHistoryExt | Extension: HL7IDR Patient History
| |||||||
| extension:procedure |
0..* | HL7IDRImagingProcedureExt | Extension: HL7IDR Imaging Procedure
| |||||||
| extension:impression |
0..* | HL7IDRImpressionExt | Extension: HL7IDR Impression
| |||||||
| extension:recommendation |
0..* | HL7IDRRecommendationExt | Extension: HL7IDR Recommendation
| |||||||
| extension:informationRecipient |
0..* | InformationRecipient | Composition: Information recipient
| |||||||
| identifier |
1..* | Identifier | Report identifier
| |||||||
| Slices for basedOn |
Content/Rules for all slices | |||||||||
| basedOn:ServiceRequestOrderEuImagingaccession |
0..* | Reference(ServiceRequest: Imaging Order) | What was requested
| |||||||
| status |
1..1 | code | Status of the Report
| |||||||
| Slices for category |
Content/Rules for all slices | |||||||||
| category:diagnostic-service |
0..1 | CodeableConcept | Service category
| |||||||
| category:imaging-report |
1..1 | CodeableConcept | Service category
| |||||||
| subject |
1..1 | Reference(Patient (EU core)) | Who and/or what this report is about
| |||||||
| Slices for effective[x] |
0..1 | dateTime, Period | Clinically relevant time/time-period for report. Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |||||||
| effective[x]:effectivePeriod |
0..1 | Period | Clinically relevant time/time-period for report.
| |||||||
| issued |
0..1 | instant | Date and time of report issuance
| |||||||
| Slices for performer |
Content/Rules for all slices | |||||||||
| performer:organization |
0..* | Reference(Organization (EU core)) | The organization producer of this report
| |||||||
| Slices for resultsInterpreter |
Content/Rules for all slices | |||||||||
| resultsInterpreter:author |
0..* | Reference(PractitionerRole (EU core)) | Primary interpreter of results
| |||||||
| result |
1..* | Reference(Observation: Imaging Finding | Observation: Narrative Report) | Findings
| |||||||
| note |
0..* | Annotation | Comments about the diagnostic report
| |||||||
| media |
0..* | BackboneElement | Additional data (like images, diagrams or documents) associated with this report
| |||||||
| composition |
1..1 | Reference(Composition: Imaging Report) | Imaging Diagnostic Report
| |||||||
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended)
| |||||||
| Documentation for this format | ||||||||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | DiagnosticReportEuImaging | Diagnostic Report EU core Constraints: dgr-1, eu-imaging-dr-status-replacement, eu-imaging-dr-status-retraction, eu-imaging-dr-status-no-addendum | ||||||||
| 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 | |||||||||
| extension:DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |||||||||
| value[x] |
1..1 | Reference(Composition (EU core)) | Value of extension | |||||||||
| extension:note |
0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" | |||||||||
| value[x] |
1..1 | Annotation | Value of extension | |||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:annotation-type |
0..* | (Complex) | The type of annotation URL: http://hl7.org/fhir/StructureDefinition/annotationType | |||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/annotationType" | |||||||||
| value[x] |
1..1 | CodeableConcept | Type of note Binding: hl7VS-commentType (example) | |||||||||
| author[x] |
0..1 | Individual responsible for the annotation | ||||||||||
| authorReference |
Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||||||||||
| authorString |
string | |||||||||||
| time |
0..1 | dateTime | When the annotation was made | |||||||||
| text |
1..1 | markdown | The annotation - text content (as markdown) | |||||||||
| extension:artifactVersion |
0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version
| |||||||||
| extension:anatomical-region |
0..* | CodeableConcept | The anatomical regions covered by the study this report reports on. URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/AnatomicalRegionExtension Binding: ValueSet: Anatomical Region (required) | |||||||||
| extension:comparison |
0..* | Reference(ImagingStudy: Reported Study | ImagingSelection: General) | Extension: HL7IDR DiagnosticReport Comparison Study URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
| |||||||||
| extension:patientHistory |
0..* | Reference() | Extension: HL7IDR Patient History URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
| |||||||||
| extension:procedure |
0..* | Reference(Procedure: Imaging Acquisition | AdverseEvent | Observation: Radiation Dose) | Extension: HL7IDR Imaging Procedure URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
| |||||||||
| extension:finding |
0..* | Reference(Observation: Imaging Finding | ImagingSelection: Key Image | DocumentReference: Key Image | DocumentReference) | Key image findings URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding | |||||||||
| extension:impression |
0..* | Reference(Observation: Imaging Finding | Condition | ImagingSelection: Key Image | DocumentReference: Key Image) | Extension: HL7IDR Impression URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
| |||||||||
| extension:recommendation |
0..* | Reference(CarePlan | ServiceRequest) | Extension: HL7IDR Recommendation URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
| |||||||||
| extension:communication |
0..* | Reference() | Communications with other care providers URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication | |||||||||
| extension:informationRecipient |
0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | CareTeam | Group) | Composition: Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
| |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier |
1..* | Identifier | Report identifier
| |||||||||
| Slices for basedOn |
0..* | Reference(ServiceRequest) | What was requested Slice: Unordered, Open by type:$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) | What was requested
| |||||||||
| 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 | ||||||||
| status |
1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
| |||||||||
| Slices for category |
2..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| category:diagnostic-service |
0..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (required)
| |||||||||
| category:imaging-report |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern:
| |||||||||
| category:imaging |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern: | |||||||||
| code |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report Binding: ValueSet: Radiology Report Types (preferred) | |||||||||
| subject |
1..1 | Reference(Patient (EU core)) | Who and/or what this report is about
| |||||||||
| encounter |
0..1 | Reference(Encounter) | The healthcare event which this Diagnostic Report is about (when test ordered). | |||||||||
| Slices for effective[x] |
0..1 | Clinically relevant time/time-period for report. Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| effective[x]:effectivePeriod |
0..1 | Period | Clinically relevant time/time-period for report.
| |||||||||
| issued |
0..1 | instant | Date and time of report issuance
| |||||||||
| Slices for performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. Slice: Unordered, Open by profile:$this | |||||||||
| performer:organization |
0..* | Reference(Organization (EU core)) | The organization producer of this report
| |||||||||
| Slices for resultsInterpreter |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter Slice: Unordered, Open by profile:resolve() | |||||||||
| resultsInterpreter:author |
0..* | Reference(PractitionerRole (EU core)) | Primary interpreter of results
| |||||||||
| specimen |
0..* | Reference(Specimen) | Specimens this report is based on. | |||||||||
| result |
C | 1..* | Reference(Observation: Imaging Finding | Observation: Narrative Report) | Findings
| ||||||||
| note |
0..* | Annotation | Comments about the diagnostic report
| |||||||||
| study |
0..* | Reference(ImagingStudy: Reported Study) | Study subject to this report | |||||||||
| supportingInfo |
0..* | BackboneElement | Additional information supporting the diagnostic 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 | |||||||||
| type |
1..1 | CodeableConcept | Supporting information role code Binding: hl7VS-VS-observationType (example): The code value for the role of the supporting information in the diagnostic report. | |||||||||
| reference |
1..1 | Reference(Procedure | Observation | DiagnosticReport | Citation) | Supporting information reference | |||||||||
| media |
0..* | BackboneElement | Additional data (like images, diagrams or documents) associated with this 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 | |||||||||
| comment |
0..1 | string | Comment about the image or data (e.g. explanation) | |||||||||
| link |
1..1 | Reference(DocumentReference) | Reference to the image or data | |||||||||
| composition |
C | 1..1 | Reference(Composition: Imaging Report) | Imaging Diagnostic Report
| ||||||||
| conclusion |
0..1 | markdown | Clinical conclusion (interpretation) of test results | |||||||||
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): SNOMED CT Clinical Findings | |||||||||
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended)
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.extension:note.value[x].extension:annotation-type.value[x] | Base | example | hl7VS-commentType | 📦3.0.0 | THO v7.1 |
| DiagnosticReport.basedOn:ServiceRequestOrderEuImagingaccession.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category:diagnostic-service | Base | required | Diagnostic Service Section Codes | 📦5.0.0 | FHIR Std. |
| DiagnosticReport.category:imaging-report | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category:imaging | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | ValueSet: Radiology Report Types | 📦1.0.0-ballot | This IG |
| DiagnosticReport.supportingInfo.type | Base | example | hl7VS-VS-observationType | 📦3.0.0 | THO v7.1 |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` |
composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))
|
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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 | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | 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())
|
| eu-imaging-dr-status-no-addendum | error | DiagnosticReport | DiagnosticReport.status SHALL NOT be 'appended' or 'corrected'; content added or corrected after final issuance is represented as a complete replacement with status 'amended'. |
status != 'appended' and status != 'corrected'
|
| eu-imaging-dr-status-replacement | error | DiagnosticReport | DiagnosticReport.status SHALL be 'amended' if and only if the referenced Composition replaces a prior report and has status 'final'. |
(status = 'amended') = composition.resolve().where(status = 'final' and relatesTo.where(type = 'replaces').exists()).exists()
|
| eu-imaging-dr-status-retraction | error | DiagnosticReport | DiagnosticReport.status SHALL be 'entered-in-error' if and only if the referenced Composition retracts a prior report by replacing it with status 'entered-in-error'. |
(status = 'entered-in-error') = composition.resolve().where(status = 'entered-in-error' and relatesTo.where(type = 'replaces').exists()).exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DiagnosticReportEuImaging
Summary
Slices
This structure defines the following Slices:
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-21
