FHIR Osiris Implementation Guide
2.1.0 - ci-build
FHIR Osiris Implementation Guide
2.1.0 - ci-build
FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2024-03-21 |
Definitions for the basedOn extension.
Guidance on how to interpret the contents of this table can be found here
| 0. Extension | |
| Definition | Connection with the imaging module (ImagingStudy and ROI Segmentation) |
| Short | Connection with the imaging module |
| 2. Extension.extension:imagingStudyRef | |
| Slice Name | imagingStudyRef |
| Definition | 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 | See Choice of Data Types for further information about how to use [x] |
| 10. Extension.extension:seriesUID | |
| Slice Name | seriesUID |
| Definition | 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 | See Choice of Data Types for 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 | |
| Slice Name | rtStructUID |
| Definition | 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 | See Choice of Data Types for further information about how to use [x] |
| 26. Extension.url | |
| Fixed Value | https://build.fhir.org/ig/arkhn/arkhn-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 | |
| Definition | 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 |
| 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.extension:imagingStudyRef | |
| Slice Name | imagingStudyRef |
| Definition | Imaging Study to which the reference series (UID series) belong |
| Short | Imaging Study ReferenceAdditional content defined by implementations |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Must Support | true |
| 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 | |
| Definition | 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 |
| Comments | 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* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| 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 are unordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.extension:imagingStudyRef.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | imagingStudyRef |
| 8. Extension.extension:imagingStudyRef.value[x] | |
| Definition | 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 This element is affected by the following invariants: ele-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 | See Choice of Data Types for further information about how to use [x] |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Extension.extension:seriesUID | |
| Slice Name | seriesUID |
| Definition | Series Instance UID of the planning image. Dicom Tag (0020,000E) |
| Short | UID ImageAdditional content defined by implementations |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Must Support | true |
| 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 | |
| Definition | 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 |
| Comments | 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* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| 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 are unordered and Open, and can be differentiated using the following discriminators: |
| 14. Extension.extension:seriesUID.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | seriesUID |
| 16. Extension.extension:seriesUID.value[x] | |
| Definition | 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 This element is affected by the following invariants: ele-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 | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Extension.extension:rtStructUID | |
| Slice Name | rtStructUID |
| Definition | SOP reference Instance UID of RT Structure Set. Dicom Tag (0008,1155) |
| Short | UID RT Structure SetAdditional content defined by implementations |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Must Support | true |
| 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 | |
| Definition | 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 |
| Comments | 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* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| 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 are unordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.extension:rtStructUID.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | rtStructUID |
| 24. Extension.extension:rtStructUID.value[x] | |
| Definition | 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 This element is affected by the following invariants: ele-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 | See Choice of Data Types for further information about how to use [x] |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/basedOn |
| 28. Extension.value[x] | |
| Definition | 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 This element is affected by the following invariants: ele-1 |
| 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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 | |
| Definition | 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 |
| 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 | |
| Definition | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| 4. Extension.extension | |
| Definition | 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 |
| Comments | 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..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Standards Status | Normative (from Normative) |
| 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 are unordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.extension:imagingStudyRef | |
| Slice Name | imagingStudyRef |
| Definition | Imaging Study to which the reference series (UID series) belong |
| Short | Imaging Study Reference |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Must Support | true |
| 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 | |
| Definition | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| 10. Extension.extension:imagingStudyRef.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 This element is affected by the following invariants: ele-1 |
| Type | Extension |
| 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 are unordered and Open, and can be differentiated using the following discriminators: |
| 12. Extension.extension:imagingStudyRef.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | imagingStudyRef |
| 14. Extension.extension:imagingStudyRef.value[x] | |
| Definition | 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 This element is affected by the following invariants: ele-1 |
| Type | Reference(Imaging Study) |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Extension.extension:seriesUID | |
| Slice Name | seriesUID |
| Definition | Series Instance UID of the planning image. Dicom Tag (0020,000E) |
| Short | UID Image |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Must Support | true |
| 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 | |
| Definition | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| 20. Extension.extension:seriesUID.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 This element is affected by the following invariants: ele-1 |
| Type | Extension |
| 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 are unordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.extension:seriesUID.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | seriesUID |
| 24. Extension.extension:seriesUID.value[x] | |
| Definition | 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 This element is affected by the following invariants: ele-1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Extension.extension:rtStructUID | |
| Slice Name | rtStructUID |
| Definition | SOP reference Instance UID of RT Structure Set. Dicom Tag (0008,1155) |
| Short | UID RT Structure Set |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Must Support | true |
| 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 | |
| Definition | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| 30. Extension.extension:rtStructUID.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 This element is affected by the following invariants: ele-1 |
| Type | Extension |
| 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 are unordered and Open, and can be differentiated using the following discriminators: |
| 32. Extension.extension:rtStructUID.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | rtStructUID |
| 34. Extension.extension:rtStructUID.value[x] | |
| Definition | 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 This element is affected by the following invariants: ele-1 |
| Type | Reference(ROI segmentation) |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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 |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/basedOn |
| 38. Extension.value[x] | |
| Definition | 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 This element is affected by the following invariants: ele-1 |
| 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
IG © 2020+ Arkhn. Package arkhn.fhir.uv.osiris#2.1.0 based on FHIR 4.0.1. Generated 2024-03-21
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change