HL7 Europe Imaging Study Report
0.1.1-build - ci-build 150

HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.1-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging/ and changes regularly. See the Directory of published versions

Resource Profile: DiagnosticReport: Imaging Report

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImDiagnosticReport Version: 0.1.1-build
Standards status: Draft Maturity Level: 1 Computable Name: ImDiagnosticReport

Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).

DiagnosticReport profile for Imaging Reports. This document represents the report of an imaging study. It is the anchor resource that refers to all structured data as well as the Composition resource that contains the narrative text of the report.
The structure of the modelled has been aligned with the DiagnosticResource as defined by IHE-RAD-HL7IDR. As this specification has not been published yet, the relevant extensions have been included in this specification.

The DiagnosticReport has been designed in such a way that the relevant information can be easily found.

The table below shows the way the main content elements in a Radiology report are represented in this profile:

Report Section Report element DiagnosticReport Composition
header patient subject subject
  source organization performer[organization]  
  author resultsInterpreter[author]  
  attester performer[attester], performer[legal-attester]  
  custodian performer[organization]  
  code code type
  category category category
imaging study study resources study section[imaging-study].entry
  notes note.where(extension[annotationType].value → imagingstudy) section[imaging-study].extension[note]
order order resources extension[basedOn] section[order].entry
  notes note.where(extension[annotationType].value → order) section[order].extension[note]
history resources extension[patientHistory] section[history].entry
  notes note.where(extension[annotationType].value → history) section[patient-history].extension[note]
procedure resources extension[procedure] section[procedure].entry
  notes note.where(extension[annotationType].value → procedure) section[procedure].extension[note]
comparison resources extension[comparison] section[comparison].entry
  notes note.where(extension[annotationType].value → comparison) section[comparison].extension[note]
findings resources result section[findings].entry
    (key images are included as references from observations)  
  notes note.where(extension[annotationType].value → findings) section[findings].extension[note]
impressions resources extension[impression] section[impression].entry
  notes conclusion section[impression].extension[note]
recommendation resources extension[recommendation] section[recommendation].entry
  notes note.where(extension[annotationType].value → recommendation) section[recommendation].extension[note]
communication resources extension[communication] section[communication].entry
  notes note.where(extension[annotationType].value → communication) section[communication].extension[note]

The notes section has an optional annotation-type extension. When present it indicates that the note applies to the section identified in the Coding included in the extension.

This profile has been aligned with the IHE-IDR profile which is still under development, parts where we deviate are:

  • IDR places unstructured text in DiagnosticReport.text in this profile the note field is used. The section the note applies to is identified using the annotation-type extension.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport C 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
Constraints: dgr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:artifactVersion 0..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:comparison S 0..* Reference(ImagingStudy: General | ImagingSelection) Comparison studies
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
.... extension:patientHistory S 0..* Reference() Patient history items selected by radiologist
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
.... extension:procedure S 0..* Reference(Procedure: Imaging Acquisition) Imaging procedure
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
.... extension:finding S 0..* Reference(DocumentReference: Key Image | ImagingSelection: Key Image) Key image findings
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding
.... extension:impression S 0..* Reference(Observation: Imaging Finding | Condition | DocumentReference: Key Image | ImagingSelection: Key Image) Impression
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
.... extension:recommendation S 0..* Reference(CarePlan | ServiceRequest) Recommendations
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
.... extension:communication S 0..* Reference() Communications with other care providers
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication
... identifier Σ 1..* Identifier Report identifier
... Slices for basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession 0..* Reference(ServiceRequest: Imaging Order) What was requested
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier ΣC 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
... status ?!Σ 1..1 code Status of the Report
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... Slices for category Σ 1..* CodeableConcept Service category
Slice: Unordered, Open by value:$this
Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074
.... category:diagnostic-service Σ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (required)
... code Σ 1..1 CodeableConcept Type of Imaging Diagnostic Report
Binding: Radiology Report Types (preferred)
... subject Σ 0..1 Reference(Patient (EU core)) The subject of the report - usually, but not always, the patient
... 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 result interpreter
... result SC 0..* Reference(Observation: Imaging Finding) Findings
... study 0..* Reference(ImagingStudy: General) Study subject to this report
... composition C 1..1 Reference(Composition: Imaging Report) Imaging Diagnostic Report

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status|5.0.0
From the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections|5.0.0
From the FHIR Standard
DiagnosticReport.category:diagnostic-servicerequiredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredImImagingReportTypesEuVS
http://hl7.eu/fhir/imaging-r5/ValueSet/ImImagingReportTypesEuVS
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dgr-1errorDiagnosticReportWhen 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-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DiagnosticReport

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:artifactVersion 0..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:comparison S 0..* Reference(ImagingStudy: General | ImagingSelection) Comparison studies
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
.... extension:patientHistory S 0..* Reference() Patient history items selected by radiologist
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
.... extension:procedure S 0..* Reference(Procedure: Imaging Acquisition) Imaging procedure
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
.... extension:finding S 0..* Reference(DocumentReference: Key Image | ImagingSelection: Key Image) Key image findings
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding
.... extension:impression S 0..* Reference(Observation: Imaging Finding | Condition | DocumentReference: Key Image | ImagingSelection: Key Image) Impression
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
.... extension:recommendation S 0..* Reference(CarePlan | ServiceRequest) Recommendations
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
.... extension:communication S 0..* Reference() Communications with other care providers
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication
... identifier 1..* Identifier Report identifier
... Slices for basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession 0..* Reference(ServiceRequest: Imaging Order) What was requested
..... identifier 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
... Slices for category 1..* CodeableConcept Service category
Slice: Unordered, Open by value:$this
.... category:diagnostic-service 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (required)
... code 1..1 CodeableConcept Type of Imaging Diagnostic Report
Binding: Radiology Report Types (preferred)
... subject 0..1 Reference(Patient (EU core)) The subject of the report - usually, but not always, the patient
... 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 result interpreter
... result S 0..* Reference(Observation: Imaging Finding) Findings
... note
.... Slices for extension Content/Rules for all slices
..... extension:annotation-type 0..* (Complex) The type of annotation
URL: http://hl7.org/fhir/StructureDefinition/annotationType
...... value[x] 1..1 CodeableConcept Value of extension
Binding: Section codes used to label annotations. (preferred)
... study 0..* Reference(ImagingStudy: General) Study subject to this report
... media 0..0
... composition 1..1 Reference(Composition: Imaging Report) Imaging Diagnostic Report

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DiagnosticReport.category:diagnostic-servicerequiredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredImImagingReportTypesEuVS
http://hl7.eu/fhir/imaging-r5/ValueSet/ImImagingReportTypesEuVS
From this IG
DiagnosticReport.note.extension:annotation-type.value[x]preferredHl7EuImagingSectionValueSet
http://hl7.eu/fhir/imaging-r5/ValueSet/valueset-diagnosticreport-notes
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport C 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
Constraints: dgr-1
... 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
Additional BindingsPurpose
CommonLanguages Starter
... 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:artifactVersion 0..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:comparison S 0..* Reference(ImagingStudy: General | ImagingSelection) Comparison studies
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
.... extension:patientHistory S 0..* Reference() Patient history items selected by radiologist
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
.... extension:procedure S 0..* Reference(Procedure: Imaging Acquisition) Imaging procedure
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
.... extension:finding S 0..* Reference(DocumentReference: Key Image | ImagingSelection: Key Image) Key image findings
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding
.... extension:impression S 0..* Reference(Observation: Imaging Finding | Condition | DocumentReference: Key Image | ImagingSelection: Key Image) Impression
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
.... extension:recommendation S 0..* Reference(CarePlan | ServiceRequest) Recommendations
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
.... extension:communication S 0..* Reference() Communications with other care providers
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Report identifier
... Slices for basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession 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 1..1 ImAccessionNumberIdentifier 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 Σ 1..* CodeableConcept Service category
Slice: Unordered, Open by value:$this
Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074
.... category:diagnostic-service Σ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (required)
... code Σ 1..1 CodeableConcept Type of Imaging Diagnostic Report
Binding: Radiology Report Types (preferred)
... subject Σ 0..1 Reference(Patient (EU core)) The subject of the report - usually, but not always, the patient
... encounter Σ 0..1 Reference(Encounter) Health care event when test ordered
... effective[x] Σ 0..1 Clinically relevant time/time-period for report
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant DateTime this version was made
... 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 result interpreter
... specimen 0..* Reference(Specimen) Specimens this report is based on
... result SC 0..* Reference(Observation: Imaging Finding) Findings
... note 0..* Annotation Comments about the diagnostic report
.... 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
..... 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
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/annotationType"
...... value[x] 1..1 CodeableConcept Value of extension
Binding: Section codes used to label annotations. (preferred)
.... 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)
... study 0..* Reference(ImagingStudy: General) 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DiagnosticReport.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
DiagnosticReport.basedOn:imorderaccession.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|5.0.0
From the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status|5.0.0
From the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections|5.0.0
From the FHIR Standard
DiagnosticReport.category:diagnostic-servicerequiredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredImImagingReportTypesEuVS
http://hl7.eu/fhir/imaging-r5/ValueSet/ImImagingReportTypesEuVS
From this IG
DiagnosticReport.note.extension:annotation-type.value[x]preferredHl7EuImagingSectionValueSet
http://hl7.eu/fhir/imaging-r5/ValueSet/valueset-diagnosticreport-notes
From this IG
DiagnosticReport.supportingInfo.typeexampleHl7VSVSObservationType
http://terminology.hl7.org/ValueSet/v2-0936
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dgr-1errorDiagnosticReportWhen 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-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DiagnosticReport

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 8 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.basedOn
  • The element 1 is sliced based on the value of DiagnosticReport.category
  • The element 1 is sliced based on the value of DiagnosticReport.performer
  • The element 1 is sliced based on the value of DiagnosticReport.resultsInterpreter

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport C 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
Constraints: dgr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:artifactVersion 0..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:comparison S 0..* Reference(ImagingStudy: General | ImagingSelection) Comparison studies
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
.... extension:patientHistory S 0..* Reference() Patient history items selected by radiologist
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
.... extension:procedure S 0..* Reference(Procedure: Imaging Acquisition) Imaging procedure
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
.... extension:finding S 0..* Reference(DocumentReference: Key Image | ImagingSelection: Key Image) Key image findings
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding
.... extension:impression S 0..* Reference(Observation: Imaging Finding | Condition | DocumentReference: Key Image | ImagingSelection: Key Image) Impression
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
.... extension:recommendation S 0..* Reference(CarePlan | ServiceRequest) Recommendations
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
.... extension:communication S 0..* Reference() Communications with other care providers
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication
... identifier Σ 1..* Identifier Report identifier
... Slices for basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession 0..* Reference(ServiceRequest: Imaging Order) What was requested
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier ΣC 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
... status ?!Σ 1..1 code Status of the Report
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... Slices for category Σ 1..* CodeableConcept Service category
Slice: Unordered, Open by value:$this
Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074
.... category:diagnostic-service Σ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (required)
... code Σ 1..1 CodeableConcept Type of Imaging Diagnostic Report
Binding: Radiology Report Types (preferred)
... subject Σ 0..1 Reference(Patient (EU core)) The subject of the report - usually, but not always, the patient
... 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 result interpreter
... result SC 0..* Reference(Observation: Imaging Finding) Findings
... study 0..* Reference(ImagingStudy: General) Study subject to this report
... composition C 1..1 Reference(Composition: Imaging Report) Imaging Diagnostic Report

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status|5.0.0
From the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections|5.0.0
From the FHIR Standard
DiagnosticReport.category:diagnostic-servicerequiredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredImImagingReportTypesEuVS
http://hl7.eu/fhir/imaging-r5/ValueSet/ImImagingReportTypesEuVS
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dgr-1errorDiagnosticReportWhen 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-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from DiagnosticReport

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:artifactVersion 0..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:comparison S 0..* Reference(ImagingStudy: General | ImagingSelection) Comparison studies
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
.... extension:patientHistory S 0..* Reference() Patient history items selected by radiologist
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
.... extension:procedure S 0..* Reference(Procedure: Imaging Acquisition) Imaging procedure
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
.... extension:finding S 0..* Reference(DocumentReference: Key Image | ImagingSelection: Key Image) Key image findings
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding
.... extension:impression S 0..* Reference(Observation: Imaging Finding | Condition | DocumentReference: Key Image | ImagingSelection: Key Image) Impression
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
.... extension:recommendation S 0..* Reference(CarePlan | ServiceRequest) Recommendations
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
.... extension:communication S 0..* Reference() Communications with other care providers
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication
... identifier 1..* Identifier Report identifier
... Slices for basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession 0..* Reference(ServiceRequest: Imaging Order) What was requested
..... identifier 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
... Slices for category 1..* CodeableConcept Service category
Slice: Unordered, Open by value:$this
.... category:diagnostic-service 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (required)
... code 1..1 CodeableConcept Type of Imaging Diagnostic Report
Binding: Radiology Report Types (preferred)
... subject 0..1 Reference(Patient (EU core)) The subject of the report - usually, but not always, the patient
... 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 result interpreter
... result S 0..* Reference(Observation: Imaging Finding) Findings
... note
.... Slices for extension Content/Rules for all slices
..... extension:annotation-type 0..* (Complex) The type of annotation
URL: http://hl7.org/fhir/StructureDefinition/annotationType
...... value[x] 1..1 CodeableConcept Value of extension
Binding: Section codes used to label annotations. (preferred)
... study 0..* Reference(ImagingStudy: General) Study subject to this report
... media 0..0
... composition 1..1 Reference(Composition: Imaging Report) Imaging Diagnostic Report

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DiagnosticReport.category:diagnostic-servicerequiredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredImImagingReportTypesEuVS
http://hl7.eu/fhir/imaging-r5/ValueSet/ImImagingReportTypesEuVS
From this IG
DiagnosticReport.note.extension:annotation-type.value[x]preferredHl7EuImagingSectionValueSet
http://hl7.eu/fhir/imaging-r5/ValueSet/valueset-diagnosticreport-notes
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport C 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
Constraints: dgr-1
... 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
Additional BindingsPurpose
CommonLanguages Starter
... 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:artifactVersion 0..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
.... extension:comparison S 0..* Reference(ImagingStudy: General | ImagingSelection) Comparison studies
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRComparisonStudy
.... extension:patientHistory S 0..* Reference() Patient history items selected by radiologist
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRPatientHistory
.... extension:procedure S 0..* Reference(Procedure: Imaging Acquisition) Imaging procedure
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImagingProcedure
.... extension:finding S 0..* Reference(DocumentReference: Key Image | ImagingSelection: Key Image) Key image findings
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRFinding
.... extension:impression S 0..* Reference(Observation: Imaging Finding | Condition | DocumentReference: Key Image | ImagingSelection: Key Image) Impression
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRImpression
.... extension:recommendation S 0..* Reference(CarePlan | ServiceRequest) Recommendations
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRRecommendation
.... extension:communication S 0..* Reference() Communications with other care providers
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/HL7IDRCommunication
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Report identifier
... Slices for basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession 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 1..1 ImAccessionNumberIdentifier 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 Σ 1..* CodeableConcept Service category
Slice: Unordered, Open by value:$this
Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074
.... category:diagnostic-service Σ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (required)
... code Σ 1..1 CodeableConcept Type of Imaging Diagnostic Report
Binding: Radiology Report Types (preferred)
... subject Σ 0..1 Reference(Patient (EU core)) The subject of the report - usually, but not always, the patient
... encounter Σ 0..1 Reference(Encounter) Health care event when test ordered
... effective[x] Σ 0..1 Clinically relevant time/time-period for report
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant DateTime this version was made
... 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 result interpreter
... specimen 0..* Reference(Specimen) Specimens this report is based on
... result SC 0..* Reference(Observation: Imaging Finding) Findings
... note 0..* Annotation Comments about the diagnostic report
.... 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
..... 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
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/annotationType"
...... value[x] 1..1 CodeableConcept Value of extension
Binding: Section codes used to label annotations. (preferred)
.... 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)
... study 0..* Reference(ImagingStudy: General) 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DiagnosticReport.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
DiagnosticReport.basedOn:imorderaccession.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|5.0.0
From the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status|5.0.0
From the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections|5.0.0
From the FHIR Standard
DiagnosticReport.category:diagnostic-servicerequiredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredImImagingReportTypesEuVS
http://hl7.eu/fhir/imaging-r5/ValueSet/ImImagingReportTypesEuVS
From this IG
DiagnosticReport.note.extension:annotation-type.value[x]preferredHl7EuImagingSectionValueSet
http://hl7.eu/fhir/imaging-r5/ValueSet/valueset-diagnosticreport-notes
From this IG
DiagnosticReport.supportingInfo.typeexampleHl7VSVSObservationType
http://terminology.hl7.org/ValueSet/v2-0936
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dgr-1errorDiagnosticReportWhen 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-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DiagnosticReport

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 8 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.basedOn
  • The element 1 is sliced based on the value of DiagnosticReport.category
  • The element 1 is sliced based on the value of DiagnosticReport.performer
  • The element 1 is sliced based on the value of DiagnosticReport.resultsInterpreter

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron