共同資料模式實作指引(Common Data Model IG)
1.0.0-Trial Use - draft
共同資料模式實作指引(Common Data Model IG) - Local Development build (v1.0.0-Trial Use). See the Directory of published versions
Active as of 2023-03-21 |
Definitions for the rth-radiotherapy-dose-delivered-to-volume extension.
Guidance on how to interpret the contents of this table can be found here.
1. Extension | |
Definition | Dose delivered to a given radiotherapy volume. Optional Extension Element - found in all resources. |
2. Extension.extension | |
Control | 10..* |
Slicing | This element introduces a set of slices on Extension.extension. The slices are and , and can be differentiated using the following discriminators:
|
3. Extension.extension:volume | |
SliceName | volume |
Definition | A BodyStructure resource representing volume in the body where radiation was delivered, for example, Chest Wall Lymph Nodes. |
Control | 1..1 |
Must Support | true |
4. Extension.extension:volume.url | |
Control | 0..? |
Fixed Value | volume |
5. Extension.extension:volume.value[x] | |
Control | 0..? |
Type | Reference |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
6. Extension.extension:volume.value[x].reference | |
Control | 0..? |
Must Support | true |
7. Extension.extension:volume.value[x].display | |
Control | 0..? |
Must Support | true |
8. Extension.extension:totalDoseDelivered | |
SliceName | totalDoseDelivered |
Definition | The total amount of radiation delivered to this volume within the scope of this dose delivery, i.e., dose delivered from the Procedure in which this extension is used. |
Control | 0..1 |
Must Support | true |
9. Extension.extension:totalDoseDelivered.url | |
Control | 0..? |
Fixed Value | totalDoseDelivered |
10. Extension.extension:totalDoseDelivered.value[x] | |
Control | 0..? |
Type | Quantity |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
11. Extension.extension:totalDoseDelivered.value[x]:valueQuantity | |
SliceName | valueQuantity |
Control | 0..? |
Type | Quantity |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
12. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.value | |
Control | 0..? |
Must Support | true |
13. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.unit | |
Control | 0..? |
Must Support | true |
Fixed Value | cGy |
14. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.system | |
Control | 0..? |
Must Support | true |
15. Extension.extension:fractionsDelivered | |
SliceName | fractionsDelivered |
Definition | The number of fractions delivered to this volume. |
Control | 0..1 |
Must Support | true |
16. Extension.extension:fractionsDelivered.url | |
Control | 0..? |
Fixed Value | fractionsDelivered |
17. Extension.extension:fractionsDelivered.value[x] | |
Control | 0..? |
Type | unsignedInt |
[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 |
Must Support | true |
18. Extension.url | |
Fixed Value | https://standard-interoperability-lab.com/fhir/StructureDefinition/rth-radiotherapy-dose-delivered-to-volume |
19. Extension.value[x] | |
Control | 0..01 |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here.
1. Extension | |||
Definition | Dose delivered to a given radiotherapy volume. Optional Extension Element - found in all resources. | ||
Control | 0..* This element is affected by the following invariants: ele-1 | ||
Invariants | Defined on this element 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 | |||
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. | ||
Control | 10..* | ||
Type | Extension | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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:
| ||
3. Extension.extension:volume | |||
SliceName | volume | ||
Definition | A BodyStructure resource representing volume in the body where radiation was delivered, for example, Chest Wall Lymph Nodes. 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. | ||
Control | 10..1* | ||
Type | Extension | ||
Must Support | true | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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:volume.url | |||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Control | 1..1 | ||
Type | uri | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
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. | ||
Fixed Value | volume | ||
5. Extension.extension:volume.value[x] | |||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Control | 0..1 | ||
Type | Choice of: Reference, 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] | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
6. Extension.extension:volume.value[x].reference | |||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
7. Extension.extension:volume.value[x].display | |||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
Control | 0..1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Obligations |
| ||
Summary | true | ||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
8. Extension.extension:totalDoseDelivered | |||
SliceName | totalDoseDelivered | ||
Definition | The total amount of radiation delivered to this volume within the scope of this dose delivery, i.e., dose delivered from the Procedure in which this extension is used. 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. | ||
Control | 0..1* | ||
Type | Extension | ||
Must Support | true | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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()) | ||
9. Extension.extension:totalDoseDelivered.url | |||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Control | 1..1 | ||
Type | uri | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
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. | ||
Fixed Value | totalDoseDelivered | ||
10. Extension.extension:totalDoseDelivered.value[x] | |||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Control | 0..1 | ||
Type | Choice of: Quantity, 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, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||
11. Extension.extension:totalDoseDelivered.value[x]:valueQuantity | |||
SliceName | valueQuantity | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Control | 0..1 | ||
Type | Choice of: Quantity, 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, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
12. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.value | |||
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||
Control | 0..1 | ||
Type | decimal | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Requirements | Precision is handled implicitly in almost all cases of measurement. | ||
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
13. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.comparator | |||
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||
Control | 0..1 | ||
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented. | ||
Type | code | ||
Is Modifier | true | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||
Meaning if Missing | If there is no comparator, then there is no modification of the value | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
14. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.unit | |||
Definition | A human-readable form of the unit. | ||
Control | 0..1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Obligations |
| ||
Summary | true | ||
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||
Fixed Value | cGy | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
15. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.system | |||
Definition | The identification of the system that provides the coded form of the unit. | ||
Control | 0..1 This element is affected by the following invariants: qty-3 | ||
Type | uri | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Requirements | Need to know the system that defines the coded form of the unit. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
16. Extension.extension:fractionsDelivered | |||
SliceName | fractionsDelivered | ||
Definition | The number of fractions delivered to this volume. 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. | ||
Control | 0..1* | ||
Type | Extension | ||
Must Support | true | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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()) | ||
17. Extension.extension:fractionsDelivered.url | |||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Control | 1..1 | ||
Type | uri | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
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. | ||
Fixed Value | fractionsDelivered | ||
18. Extension.extension:fractionsDelivered.value[x] | |||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Control | 0..1 | ||
Type | Choice of: unsignedInt, 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, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, 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 | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
19. Extension.url | |||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Control | 1..1 | ||
Type | uri | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
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. | ||
Fixed Value | https://standard-interoperability-lab.com/fhir/StructureDefinition/rth-radiotherapy-dose-delivered-to-volume | ||
20. Extension.value[x] | |||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
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 | ||
[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 | ||
Summary | false | ||
Invariants | Defined on this element 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.
1. Extension | |||
Definition | Dose delivered to a given radiotherapy volume. | ||
Control | 0..* This element is affected by the following invariants: ele-1 | ||
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. | ||
Control | 0..1 | ||
Type | string | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
3. Extension.extension | |||
Definition | An Extension | ||
Control | 1..* | ||
Type | Extension | ||
Summary | false | ||
Invariants | Defined on this element 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:
| ||
4. Extension.extension:volume | |||
SliceName | volume | ||
Definition | A BodyStructure resource representing volume in the body where radiation was delivered, for example, Chest Wall Lymph Nodes. | ||
Control | 1..1 | ||
Type | Extension | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element 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()) | ||
5. Extension.extension:volume.id | |||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Control | 0..1 | ||
Type | string | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
6. Extension.extension:volume.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. | ||
Control | 0..* | ||
Type | Extension | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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:
| ||
7. Extension.extension:volume.url | |||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Control | 1..1 | ||
Type | uri | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
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. | ||
Fixed Value | volume | ||
8. Extension.extension:volume.value[x] | |||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Control | 0..1 | ||
Type | Reference | ||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
9. Extension.extension:volume.value[x].id | |||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Control | 0..1 | ||
Type | string | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
10. Extension.extension:volume.value[x].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. | ||
Control | 0..* | ||
Type | Extension | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||
11. Extension.extension:volume.value[x].reference | |||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
12. Extension.extension:volume.value[x].type | |||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
Control | 0..1 | ||
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) | ||
Type | uri | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
13. Extension.extension:volume.value[x].identifier | |||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
Note | This is a business identifier, not a resource identifier (see discussion) | ||
Control | 0..1 | ||
Type | Identifier | ||
Summary | true | ||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
14. Extension.extension:volume.value[x].display | |||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
Control | 0..1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Obligations |
| ||
Summary | true | ||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
15. Extension.extension:totalDoseDelivered | |||
SliceName | totalDoseDelivered | ||
Definition | The total amount of radiation delivered to this volume within the scope of this dose delivery, i.e., dose delivered from the Procedure in which this extension is used. | ||
Control | 0..1 | ||
Type | Extension | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element 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()) | ||
16. Extension.extension:totalDoseDelivered.id | |||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Control | 0..1 | ||
Type | string | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
17. Extension.extension:totalDoseDelivered.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. | ||
Control | 0..* | ||
Type | Extension | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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:
| ||
18. Extension.extension:totalDoseDelivered.url | |||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Control | 1..1 | ||
Type | uri | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
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. | ||
Fixed Value | totalDoseDelivered | ||
19. Extension.extension:totalDoseDelivered.value[x] | |||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Control | 0..1 | ||
Type | Quantity | ||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||
20. Extension.extension:totalDoseDelivered.value[x]:valueQuantity | |||
SliceName | valueQuantity | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Control | 0..1 | ||
Type | Quantity | ||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
21. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.id | |||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Control | 0..1 | ||
Type | string | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
22. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.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. | ||
Control | 0..* | ||
Type | Extension | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||
23. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.value | |||
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||
Control | 0..1 | ||
Type | decimal | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Requirements | Precision is handled implicitly in almost all cases of measurement. | ||
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
24. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.comparator | |||
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||
Control | 0..1 | ||
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented | ||
Type | code | ||
Is Modifier | true | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||
Meaning if Missing | If there is no comparator, then there is no modification of the value | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
25. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.unit | |||
Definition | A human-readable form of the unit. | ||
Control | 0..1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Obligations |
| ||
Summary | true | ||
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||
Fixed Value | cGy | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
26. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.system | |||
Definition | The identification of the system that provides the coded form of the unit. | ||
Control | 0..1 This element is affected by the following invariants: qty-3 | ||
Type | uri | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Requirements | Need to know the system that defines the coded form of the unit. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
27. Extension.extension:totalDoseDelivered.value[x]:valueQuantity.code | |||
Definition | A computer processable form of the unit in some unit representation system. | ||
Control | 0..1 | ||
Type | code | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
28. Extension.extension:fractionsDelivered | |||
SliceName | fractionsDelivered | ||
Definition | The number of fractions delivered to this volume. | ||
Control | 0..1 | ||
Type | Extension | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element 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()) | ||
29. Extension.extension:fractionsDelivered.id | |||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Control | 0..1 | ||
Type | string | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
30. Extension.extension:fractionsDelivered.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. | ||
Control | 0..* | ||
Type | Extension | ||
Summary | false | ||
Alternate Names | extensions, user content | ||
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. | ||
Invariants | Defined on this element 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:
| ||
31. Extension.extension:fractionsDelivered.url | |||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Control | 1..1 | ||
Type | uri | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
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. | ||
Fixed Value | fractionsDelivered | ||
32. Extension.extension:fractionsDelivered.value[x] | |||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Control | 0..1 | ||
Type | unsignedInt | ||
[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 | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
33. Extension.url | |||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Control | 1..1 | ||
Type | uri | ||
XML Representation | In the XML format, this property is represented as an attribute. | ||
Summary | false | ||
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. | ||
Fixed Value | https://standard-interoperability-lab.com/fhir/StructureDefinition/rth-radiotherapy-dose-delivered-to-volume | ||
34. Extension.value[x] | |||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
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 | ||
[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 | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |