HL7 Europe Imaging Study Report
0.1.0 - 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.0 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: Radiation Dose Observation

Official URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-radiation-dose-information Version: 0.1.0
Draft as of 2025-03-18 Computable Name: ImRadiationDoseObservation

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

A record for the radiation dose the subject has been exposed to during an imaging procedure.

This resource is a placeholder pending further refinement in this topic.

E.g. based on information from https://dicom.nema.org/medical/dicom/current/output/html/part16.html.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* ImFinding Measurements and simple assertions
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).
obs-8: bodyStructure SHALL only be present if Observation.bodySite is not present
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... security SΣ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language S 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set

ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SOΣ 0..1 ImAccessionNumberIdentifier Business Identifier for observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
... Slices for basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... basedOn:imorderaccession SΣ 0..1 Reference(Imaging Order) Fulfills plan, proposal or order
ele-1: All FHIR elements must have a @value or children
... Slices for partOf SΣ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) Part of referenced event
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... partOf:imagingstudy SOΣ 0..* Reference(ImagingStudy) Imaging study that produced this observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
.... partOf:procedure SOΣ 0..* Reference(Imaging Procedure) Procedure that produced this observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


ele-1: All FHIR elements must have a @value or children
... Slices for category S 1..1 CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ele-1: All FHIR elements must have a @value or children
.... category:imaging S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imaging
... code SΣC 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
..... coding:magiccode SΣ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP190649-6
...... display 1..1 string Representation defined by the system
Fixed Value: Radiation dose
... subject SΣ 0..1 Reference(Imaging Patient) Who and/or what the observation is about
ele-1: All FHIR elements must have a @value or children
... effective[x] SOΣ 0..1 Clinically relevant time/time-period for observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SOΣ 0..* Reference(Practitioner Role) Who is responsible for the observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
... value[x] SOΣC 0..1 Quantity Actual result
Binding: Radiation Dose Observation Unit ValueSet (extensible)
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
... note SO 0..* Annotation Comments about the observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
... method SO 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
... Slices for derivedFrom SΣ 0..* Reference(DocumentReference | ImagingStudy | ImagingSelection | QuestionnaireResponse | Observation | MolecularSequence | GenomicStudy) Related resource from which the observation is made
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... derivedFrom:imagingstudy SOΣ 0..* Reference(ImagingStudy) Imaging study that produced this observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
.... derivedFrom:imagingselection SOΣ 0..* Reference(Represents the part of an imaging study.) Series or image that produced this observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|5.0.0
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:imagingpreferredPattern: imaging
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.value[x]extensibleImRadiationDoseObservationUnitValueSet
http://hl7.eu/fhir/imaging/ValueSet/im-radiation-dose-observation-unit-vs
from this IG
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA 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()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
obs-8errorObservationbodyStructure SHALL only be present if Observation.bodySite is not present
: bodySite.exists() implies bodyStructure.empty()

 

Other representations of profile: CSV, Excel, Schematron