Search FHIR

FHIR Osiris Implementation Guide
1.1.0 - trial-implementation

This page is part of the OSIRIS FHIR Implementation Guide (v1.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: BasedOn - Detailed Descriptions

Draft as of 2025-04-03

Definitions for the basedOn extension.

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.

ShortConnection with the imaging moduleOptional Extensions Element
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-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 sliceimagingStudyRef
Définition

Imaging Study to which the reference series (UID series) belong

ShortImaging Study ReferenceAdditional content defined by implementations
Control0..1*
TypeExtension
Is Modifierfalse
Must Supporttrue
Résuméfalse
Invariantsele-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.

ShortExtensionAdditional 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.

Control0..0*
TypeExtension
Is Modifierfalse
Résuméfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis 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.

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Résuméfalse
    Fixed ValueimagingStudyRef
    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).

    ShortValue of extension
    Control0..1
    TypeReference(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] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Résuméfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Extension.extension:seriesUID
    Nom de la sliceseriesUID
    Définition

    Series Instance UID of the planning image. Dicom Tag (0020,000E)

    ShortUID ImageAdditional content defined by implementations
    Control0..1*
    TypeExtension
    Is Modifierfalse
    Must Supporttrue
    Résuméfalse
    Invariantsele-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.

    ShortExtensionAdditional 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.

    Control0..0*
    TypeExtension
    Is Modifierfalse
    Résuméfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis 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.

      Shortidentifies 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.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Résuméfalse
      Fixed ValueseriesUID
      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).

      ShortValue of extension
      Control0..1
      Typestring, 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Résuméfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Extension.extension:rtStructUID
      Nom de la slicertStructUID
      Définition

      SOP reference Instance UID of RT Structure Set. Dicom Tag (0008,1155)

      ShortUID RT Structure SetAdditional content defined by implementations
      Control0..1*
      TypeExtension
      Is Modifierfalse
      Must Supporttrue
      Résuméfalse
      Invariantsele-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.

      ShortExtensionAdditional 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.

      Control0..0*
      TypeExtension
      Is Modifierfalse
      Résuméfalse
      Alternate Namesextensions, user content
      Invariantsele-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())
      SlicingThis 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.

        Shortidentifies 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.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Résuméfalse
        Fixed ValuertStructUID
        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).

        ShortValue of extension
        Control0..1
        TypeReference(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] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Résuméfalse
        Invariantsele-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.

        Shortidentifies 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.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Résuméfalse
        Fixed Valuehttps://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).

        ShortValue of extension
        Control0..01
        TypeChoice 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 Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Résuméfalse
        Invariantsele-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)

        ShortConnection with the imaging module
        2. Extension.extension:imagingStudyRef
        Nom de la sliceimagingStudyRef
        Définition

        Imaging Study to which the reference series (UID series) belong

        ShortImaging Study Reference
        Control0..1
        Must Supporttrue
        4. Extension.extension:imagingStudyRef.extension
        Control0..0
        6. Extension.extension:imagingStudyRef.url
        Fixed ValueimagingStudyRef
        8. Extension.extension:imagingStudyRef.value[x]
        TypeReference(Imaging Study)
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        10. Extension.extension:seriesUID
        Nom de la sliceseriesUID
        Définition

        Series Instance UID of the planning image. Dicom Tag (0020,000E)

        ShortUID Image
        Control0..1
        Must Supporttrue
        12. Extension.extension:seriesUID.extension
        Control0..0
        14. Extension.extension:seriesUID.url
        Fixed ValueseriesUID
        16. Extension.extension:seriesUID.value[x]
        Typestring
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        18. Extension.extension:rtStructUID
        Nom de la slicertStructUID
        Définition

        SOP reference Instance UID of RT Structure Set. Dicom Tag (0008,1155)

        ShortUID RT Structure Set
        Control0..1
        Must Supporttrue
        20. Extension.extension:rtStructUID.extension
        Control0..0
        22. Extension.extension:rtStructUID.url
        Fixed ValuertStructUID
        24. Extension.extension:rtStructUID.value[x]
        TypeReference(ROI segmentation)
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        26. Extension.url
        Fixed Valuehttps://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/basedOn
        28. Extension.value[x]
        Control0..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)

        ShortConnection with the imaging module
        Control0..*
        This element is affected by the following invariants: ele-1
        Is Modifierfalse
        Invariantsele-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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn 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.

        ShortAdditional 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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Résuméfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        SlicingThis 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 sliceimagingStudyRef
          Définition

          Imaging Study to which the reference series (UID series) belong

          ShortImaging Study Reference
          Control0..1
          TypeExtension
          Is Modifierfalse
          Must Supporttrue
          Résuméfalse
          Invariantsele-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.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Résuméfalse
          10. Extension.extension:imagingStudyRef.extension
          Définition

          An Extension

          ShortExtension
          Control0..0
          TypeExtension
          Is Modifierfalse
          Résuméfalse
          Invariantsele-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())
          SlicingThis 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.

            Shortidentifies 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.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Résuméfalse
            Fixed ValueimagingStudyRef
            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).

            ShortValue of extension
            Control0..1
            TypeReference(Imaging Study)
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Résuméfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            16. Extension.extension:seriesUID
            Nom de la sliceseriesUID
            Définition

            Series Instance UID of the planning image. Dicom Tag (0020,000E)

            ShortUID Image
            Control0..1
            TypeExtension
            Is Modifierfalse
            Must Supporttrue
            Résuméfalse
            Invariantsele-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.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Résuméfalse
            20. Extension.extension:seriesUID.extension
            Définition

            An Extension

            ShortExtension
            Control0..0
            TypeExtension
            Is Modifierfalse
            Résuméfalse
            Invariantsele-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())
            SlicingThis 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.

              Shortidentifies 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.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Résuméfalse
              Fixed ValueseriesUID
              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).

              ShortValue of extension
              Control0..1
              Typestring
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Résuméfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              26. Extension.extension:rtStructUID
              Nom de la slicertStructUID
              Définition

              SOP reference Instance UID of RT Structure Set. Dicom Tag (0008,1155)

              ShortUID RT Structure Set
              Control0..1
              TypeExtension
              Is Modifierfalse
              Must Supporttrue
              Résuméfalse
              Invariantsele-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.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Résuméfalse
              30. Extension.extension:rtStructUID.extension
              Définition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifierfalse
              Résuméfalse
              Invariantsele-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())
              SlicingThis 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.

                Shortidentifies 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.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Résuméfalse
                Fixed ValuertStructUID
                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).

                ShortValue of extension
                Control0..1
                TypeReference(ROI segmentation)
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Résuméfalse
                Invariantsele-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.

                Shortidentifies 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.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Résuméfalse
                Fixed Valuehttps://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).

                ShortValue of extension
                Control0..0
                TypeChoice 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 Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Résuméfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))