HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

This page is part of the HL7 Europe Imaging Study Report (v0.1.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Report obligations for EuSubstance

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/Report-EuSubstance Version: 0.1.0-ballot
Draft as of 2025-05-14 Computable Name: Report_EuSubstance

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

Report obligations for EuSubstance

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
.. Substance 0..* Substance A homogeneous material with a definite composition
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
... 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
... contained 0..* Resource Contained, inline Resources
... 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
... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.


ele-1: All FHIR elements must have a @value or children
... code OΣ 1..1 CodeableReference(SubstanceDefinition) What substance this is
Binding: SubstanceCode (example): Substance codes.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... description OΣ 0..1 markdown Textual description of the substance, comments
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... expiry OΣ 0..1 dateTime When no longer valid to use
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... quantity OΣ 0..1 SimpleQuantity Amount of substance in the package
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... ingredient OΣ 0..* BackboneElement Composition information about the substance
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... quantity OΣ 0..1 Ratio Optional amount (concentration)
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for substance[x] Σ 1..1 A component of the substance
Slice: Unordered, Open by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.


ele-1: All FHIR elements must have a @value or children
..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)
..... substance[x]:substanceReference OΣ 0..1 Reference(Substance) A component of the substance
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|5.0.0
from the FHIR Standard
Substance.codeexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
Substance.ingredient.substance[x]exampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA 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 Substance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... identifier O 0..* Identifier Unique identifier
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... code O 1..1 CodeableReference(SubstanceDefinition) What substance this is
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... description O 0..1 markdown Textual description of the substance, comments
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... quantity O 0..1 SimpleQuantity Amount of substance in the package
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... ingredient O 0..* BackboneElement Composition information about the substance
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... quantity O 0..1 Ratio Optional amount (concentration)
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for substance[x] 1..1 CodeableConcept, Reference(Substance) A component of the substance
Slice: Unordered, Open by type:$this
..... substance[x]:substanceReference O 0..1 Reference(Substance) A component of the substance
ObligationsActor
SHALL:populate-if-known Imaging study report provider

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier OΣ 0..* Identifier Unique identifier
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... category Σ 0..* CodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code OΣ 1..1 CodeableReference(SubstanceDefinition) What substance this is
Binding: SubstanceCode (example): Substance codes.

ObligationsActor
SHALL:populate-if-known Imaging study report provider
... description OΣ 0..1 markdown Textual description of the substance, comments
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... expiry OΣ 0..1 dateTime When no longer valid to use
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... quantity OΣ 0..1 SimpleQuantity Amount of substance in the package
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... ingredient OΣ 0..* BackboneElement Composition information about the substance
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... 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
.... quantity OΣ 0..1 Ratio Optional amount (concentration)
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for substance[x] Σ 1..1 A component of the substance
Slice: Unordered, Open by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.

..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)
..... substance[x]:substanceReference OΣ 0..1 Reference(Substance) A component of the substance
ObligationsActor
SHALL:populate-if-known Imaging study report provider

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|5.0.0
from the FHIR Standard
Substance.categoryextensibleSubstanceCategoryCodes
http://hl7.org/fhir/ValueSet/substance-category
from the FHIR Standard
Substance.codeexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
Substance.ingredient.substance[x]exampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA 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 Substance

Summary

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Substance.ingredient.substance[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
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
... 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
... contained 0..* Resource Contained, inline Resources
... 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
... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.


ele-1: All FHIR elements must have a @value or children
... code OΣ 1..1 CodeableReference(SubstanceDefinition) What substance this is
Binding: SubstanceCode (example): Substance codes.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... description OΣ 0..1 markdown Textual description of the substance, comments
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... expiry OΣ 0..1 dateTime When no longer valid to use
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... quantity OΣ 0..1 SimpleQuantity Amount of substance in the package
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... ingredient OΣ 0..* BackboneElement Composition information about the substance
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... quantity OΣ 0..1 Ratio Optional amount (concentration)
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for substance[x] Σ 1..1 A component of the substance
Slice: Unordered, Open by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.


ele-1: All FHIR elements must have a @value or children
..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)
..... substance[x]:substanceReference OΣ 0..1 Reference(Substance) A component of the substance
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Imaging study report provider

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|5.0.0
from the FHIR Standard
Substance.codeexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
Substance.ingredient.substance[x]exampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA 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 Substance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... identifier O 0..* Identifier Unique identifier
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... code O 1..1 CodeableReference(SubstanceDefinition) What substance this is
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... description O 0..1 markdown Textual description of the substance, comments
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... quantity O 0..1 SimpleQuantity Amount of substance in the package
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... ingredient O 0..* BackboneElement Composition information about the substance
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... quantity O 0..1 Ratio Optional amount (concentration)
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for substance[x] 1..1 CodeableConcept, Reference(Substance) A component of the substance
Slice: Unordered, Open by type:$this
..... substance[x]:substanceReference O 0..1 Reference(Substance) A component of the substance
ObligationsActor
SHALL:populate-if-known Imaging study report provider

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier OΣ 0..* Identifier Unique identifier
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... category Σ 0..* CodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code OΣ 1..1 CodeableReference(SubstanceDefinition) What substance this is
Binding: SubstanceCode (example): Substance codes.

ObligationsActor
SHALL:populate-if-known Imaging study report provider
... description OΣ 0..1 markdown Textual description of the substance, comments
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... expiry OΣ 0..1 dateTime When no longer valid to use
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... quantity OΣ 0..1 SimpleQuantity Amount of substance in the package
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... ingredient OΣ 0..* BackboneElement Composition information about the substance
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... 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
.... quantity OΣ 0..1 Ratio Optional amount (concentration)
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for substance[x] Σ 1..1 A component of the substance
Slice: Unordered, Open by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.

..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)
..... substance[x]:substanceReference OΣ 0..1 Reference(Substance) A component of the substance
ObligationsActor
SHALL:populate-if-known Imaging study report provider

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|5.0.0
from the FHIR Standard
Substance.categoryextensibleSubstanceCategoryCodes
http://hl7.org/fhir/ValueSet/substance-category
from the FHIR Standard
Substance.codeexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
Substance.ingredient.substance[x]exampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA 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 Substance

Summary

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Substance.ingredient.substance[x]

 

Other representations of profile: CSV, Excel, Schematron