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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() | |||||
---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||
![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() |
OΣ | 0..* | Identifier | Unique identifier ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() |
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
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | markdown | Textual description of the substance, comments ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | dateTime | When no longer valid to use ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | SimpleQuantity | Amount of substance in the package ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | Composition information about the substance ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Ratio | Optional amount (concentration) ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | ||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | ||||||||
![]() ![]() ![]() ![]() ![]() |
OΣ | 0..1 | Reference(Substance) | A component of the substance ele-1: All FHIR elements must have a @value or children
| |||||
![]() |
Path | Conformance | ValueSet | URI |
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|5.0.0 from the FHIR Standard | |
Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | |
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Substance | 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 | Substance | 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 | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Substance
Name | Flags | Card. | Type | Description & Constraints![]() | |||||
---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Substance | A homogeneous material with a definite composition | ||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() ![]() |
OΣ | 0..* | Identifier | Unique identifier
| |||||
![]() ![]() ![]() |
?!Σ | 1..1 | boolean | Is this an instance of a substance or a kind of one | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | |||||
![]() ![]() ![]() |
OΣ | 1..1 | CodeableReference(SubstanceDefinition) | What substance this is Binding: SubstanceCode (example): Substance codes.
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | markdown | Textual description of the substance, comments
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | dateTime | When no longer valid to use
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | SimpleQuantity | Amount of substance in the package
| |||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | Composition information about the substance
| |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Ratio | Optional amount (concentration)
| |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | A component of the substance Slice: Unordered, Open by type:$this Binding: SubstanceCode (example): Substance Ingredient codes. | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | ||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | ||||||||
![]() ![]() ![]() ![]() ![]() |
OΣ | 0..1 | Reference(Substance) | A component of the substance
| |||||
![]() |
Path | Conformance | ValueSet | URI |
Substance.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|5.0.0 from the FHIR Standard | |
Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-category from the FHIR Standard | |
Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | |
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Substance | 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 | Substance | 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 | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | |||||
---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||
![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() |
OΣ | 0..* | Identifier | Unique identifier ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() |
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
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | markdown | Textual description of the substance, comments ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | dateTime | When no longer valid to use ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | SimpleQuantity | Amount of substance in the package ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | Composition information about the substance ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Ratio | Optional amount (concentration) ele-1: All FHIR elements must have a @value or children
| |||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | ||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | ||||||||
![]() ![]() ![]() ![]() ![]() |
OΣ | 0..1 | Reference(Substance) | A component of the substance ele-1: All FHIR elements must have a @value or children
| |||||
![]() |
Path | Conformance | ValueSet | URI |
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|5.0.0 from the FHIR Standard | |
Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | |
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Substance | 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 | Substance | 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 | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Substance
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Substance | A homogeneous material with a definite composition | |||||
![]() ![]() ![]() |
O | 0..* | Identifier | Unique identifier
| ||||
![]() ![]() ![]() |
O | 1..1 | CodeableReference(SubstanceDefinition) | What substance this is
| ||||
![]() ![]() ![]() |
O | 0..1 | markdown | Textual description of the substance, comments
| ||||
![]() ![]() ![]() |
O | 0..1 | dateTime | When no longer valid to use
| ||||
![]() ![]() ![]() |
O | 0..1 | SimpleQuantity | Amount of substance in the package
| ||||
![]() ![]() ![]() |
O | 0..* | BackboneElement | Composition information about the substance
| ||||
![]() ![]() ![]() ![]() |
O | 0..1 | Ratio | Optional amount (concentration)
| ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept, Reference(Substance) | A component of the substance Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | Reference(Substance) | A component of the substance
| ||||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | |||||
---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Substance | A homogeneous material with a definite composition | ||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() ![]() |
OΣ | 0..* | Identifier | Unique identifier
| |||||
![]() ![]() ![]() |
?!Σ | 1..1 | boolean | Is this an instance of a substance or a kind of one | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | |||||
![]() ![]() ![]() |
OΣ | 1..1 | CodeableReference(SubstanceDefinition) | What substance this is Binding: SubstanceCode (example): Substance codes.
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | markdown | Textual description of the substance, comments
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | dateTime | When no longer valid to use
| |||||
![]() ![]() ![]() |
OΣ | 0..1 | SimpleQuantity | Amount of substance in the package
| |||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | Composition information about the substance
| |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Ratio | Optional amount (concentration)
| |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | A component of the substance Slice: Unordered, Open by type:$this Binding: SubstanceCode (example): Substance Ingredient codes. | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | ||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | ||||||||
![]() ![]() ![]() ![]() ![]() |
OΣ | 0..1 | Reference(Substance) | A component of the substance
| |||||
![]() |
Path | Conformance | ValueSet | URI |
Substance.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|5.0.0 from the FHIR Standard | |
Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-category from the FHIR Standard | |
Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | |
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Substance | 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 | Substance | 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 | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Other representations of profile: CSV, Excel, Schematron