FHIR Osiris Implementation Guide
1.1.0 - trial-implementation

Publication Build: This will be filled in by the publication tooling

## Extension: BasedOn - Detailed Descriptions

Draft as of 2025-04-03

Definitions for the basedOn extension.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Extension
Définition | Connection with the imaging module (ImagingStudy and ROI Segmentation) Optional Extension Element - found in all resources.
Short | Connection with the imaging moduleOptional Extensions Element
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension:imagingStudyRef
Nom de la slice | imagingStudyRef
Définition | Imaging Study to which the reference series (UID series) belong
Short | Imaging Study ReferenceAdditional content defined by implementations
Control | 0..1*
Type | Extension
Is Modifier | false
Must Support | true
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Extension.extension:imagingStudyRef.extension
Définition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Commentaires | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Résumé | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.extension:imagingStudyRef.url
Définition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Commentaires | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
Fixed Value | `imagingStudyRef`
8. Extension.extension:imagingStudyRef.value[x]
Définition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Type | Reference(Imaging Study), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Extension.extension:seriesUID
Nom de la slice | seriesUID
Définition | Series Instance UID of the planning image. Dicom Tag (0020,000E)
Short | UID ImageAdditional content defined by implementations
Control | 0..1*
Type | Extension
Is Modifier | false
Must Support | true
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Extension.extension:seriesUID.extension
Définition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Commentaires | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Résumé | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
14. Extension.extension:seriesUID.url
Définition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Commentaires | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
Fixed Value | `seriesUID`
16. Extension.extension:seriesUID.value[x]
Définition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Extension.extension:rtStructUID
Nom de la slice | rtStructUID
Définition | SOP reference Instance UID of RT Structure Set. Dicom Tag (0008,1155)
Short | UID RT Structure SetAdditional content defined by implementations
Control | 0..1*
Type | Extension
Is Modifier | false
Must Support | true
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Extension.extension:rtStructUID.extension
Définition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Commentaires | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Résumé | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. Extension.extension:rtStructUID.url
Définition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Commentaires | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
Fixed Value | `rtStructUID`
24. Extension.extension:rtStructUID.value[x]
Définition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Type | Reference(ROI segmentation), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Extension.url
Définition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Commentaires | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
Fixed Value | `https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/basedOn`
28. Extension.value[x]
Définition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..01
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension
Définition | Connection with the imaging module (ImagingStudy and ROI Segmentation)
Short | Connection with the imaging module
2. Extension.extension:imagingStudyRef
Nom de la slice | imagingStudyRef
Définition | Imaging Study to which the reference series (UID series) belong
Short | Imaging Study Reference
Control | 0..1
Must Support | true
4. Extension.extension:imagingStudyRef.extension
Control | 0..0
6. Extension.extension:imagingStudyRef.url
Fixed Value | `imagingStudyRef`
8. Extension.extension:imagingStudyRef.value[x]
Type | Reference(Imaging Study)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
10. Extension.extension:seriesUID
Nom de la slice | seriesUID
Définition | Series Instance UID of the planning image. Dicom Tag (0020,000E)
Short | UID Image
Control | 0..1
Must Support | true
12. Extension.extension:seriesUID.extension
Control | 0..0
14. Extension.extension:seriesUID.url
Fixed Value | `seriesUID`
16. Extension.extension:seriesUID.value[x]
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
18. Extension.extension:rtStructUID
Nom de la slice | rtStructUID
Définition | SOP reference Instance UID of RT Structure Set. Dicom Tag (0008,1155)
Short | UID RT Structure Set
Control | 0..1
Must Support | true
20. Extension.extension:rtStructUID.extension
Control | 0..0
22. Extension.extension:rtStructUID.url
Fixed Value | `rtStructUID`
24. Extension.extension:rtStructUID.value[x]
Type | Reference(ROI segmentation)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
26. Extension.url
Fixed Value | `https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/basedOn`
28. Extension.value[x]
Control | 0..0

Guidance on how to interpret the contents of this table can be found here

0. Extension
Définition | Connection with the imaging module (ImagingStudy and ROI Segmentation)
Short | Connection with the imaging module
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
2. Extension.id
Définition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
4. Extension.extension
Définition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Commentaires | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Résumé | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.extension:imagingStudyRef
Nom de la slice | imagingStudyRef
Définition | Imaging Study to which the reference series (UID series) belong
Short | Imaging Study Reference
Control | 0..1
Type | Extension
Is Modifier | false
Must Support | true
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Extension.extension:imagingStudyRef.id
Définition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
10. Extension.extension:imagingStudyRef.extension
Définition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. Extension.extension:imagingStudyRef.url
Définition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Commentaires | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
Fixed Value | `imagingStudyRef`
14. Extension.extension:imagingStudyRef.value[x]
Définition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Type | Reference(Imaging Study)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Extension.extension:seriesUID
Nom de la slice | seriesUID
Définition | Series Instance UID of the planning image. Dicom Tag (0020,000E)
Short | UID Image
Control | 0..1
Type | Extension
Is Modifier | false
Must Support | true
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Extension.extension:seriesUID.id
Définition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
20. Extension.extension:seriesUID.extension
Définition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. Extension.extension:seriesUID.url
Définition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Commentaires | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
Fixed Value | `seriesUID`
24. Extension.extension:seriesUID.value[x]
Définition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Extension.extension:rtStructUID
Nom de la slice | rtStructUID
Définition | SOP reference Instance UID of RT Structure Set. Dicom Tag (0008,1155)
Short | UID RT Structure Set
Control | 0..1
Type | Extension
Is Modifier | false
Must Support | true
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. Extension.extension:rtStructUID.id
Définition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
30. Extension.extension:rtStructUID.extension
Définition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. Extension.extension:rtStructUID.url
Définition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Commentaires | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
Fixed Value | `rtStructUID`
34. Extension.extension:rtStructUID.value[x]
Définition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Type | Reference(ROI segmentation)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Extension.url
Définition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Commentaires | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Résumé | false
Fixed Value | `https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/basedOn`
38. Extension.value[x]
Définition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..0
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Résumé | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)