LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
| Active as of 2022-11-10 |
Definitions for the span extension.
| 1. Extension | |
| Definition | Detail on a span of text from a reference source used as input for an insight evaluation Optional Extension Element - found in all resources. |
| 2. Extension.extension:offsetBegin | |
| SliceName | offsetBegin |
| Definition | Offset location of the first character for the span of covered text in relation to the overall reference where this span of text appears |
| Control | 0..1 |
| Type | Extension(OffsetBegin) (Extension Type: integer) |
| 3. Extension.extension:offsetEnd | |
| SliceName | offsetEnd |
| Definition | Offset location of the last character for the span of covered text in relation to the overall reference where this span of text appears |
| Control | 0..1 |
| Type | Extension(OffsetEnd) (Extension Type: integer) |
| 4. Extension.extension:coveredText | |
| SliceName | coveredText |
| Definition | Snippet of covered text used as input to the insight asseessment |
| Control | 0..1 |
| Type | Extension(CoveredText) (Extension Type: string) |
| 5. Extension.extension:insightConfidence | |
| SliceName | insightConfidence |
| Definition | Confidence scoring details for the insight |
| Control | 0..* |
| Type | Extension(InsightConfidence) (Complex Extension) |
| 6. Extension.url | |
| Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/span |
| 7. Extension.value[x] | |
| Control | 0..01 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 1. Extension | |
| Definition | Detail on a span of text from a reference source used as input for an insight evaluation 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:offsetBegin | |
| SliceName | offsetBegin |
| Definition | Offset location of the first character for the span of covered text in relation to the overall reference where this span of text appears |
| Control | 0..1 |
| Type | Extension(OffsetBegin) (Extension Type: integer) |
| 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()) |
| 3. Extension.extension:offsetEnd | |
| SliceName | offsetEnd |
| Definition | Offset location of the last character for the span of covered text in relation to the overall reference where this span of text appears |
| Control | 0..1 |
| Type | Extension(OffsetEnd) (Extension Type: integer) |
| 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:coveredText | |
| SliceName | coveredText |
| Definition | Snippet of covered text used as input to the insight asseessment |
| Control | 0..1 |
| Type | Extension(CoveredText) (Extension Type: string) |
| 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:insightConfidence | |
| SliceName | insightConfidence |
| Definition | Confidence scoring details for the insight 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. |
| Type | Extension(InsightConfidence) (Complex Extension) |
| Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
| 6. 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. |
| 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 | http://linuxforhealth.org/fhir/cdm/StructureDefinition/span |
| 7. 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] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 1. Extension | |
| Definition | Detail on a span of text from a reference source used as input for an insight evaluation |
| 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. |
| 3. 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensionsuser 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:
|
| 4. Extension.extension:offsetBegin | |
| SliceName | offsetBegin |
| Definition | Offset location of the first character for the span of covered text in relation to the overall reference where this span of text appears |
| Control | 0..1 |
| Type | Extension(OffsetBegin) (Extension Type: integer) |
| 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:offsetEnd | |
| SliceName | offsetEnd |
| Definition | Offset location of the last character for the span of covered text in relation to the overall reference where this span of text appears |
| Control | 0..1 |
| Type | Extension(OffsetEnd) (Extension Type: integer) |
| 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()) |
| 6. Extension.extension:coveredText | |
| SliceName | coveredText |
| Definition | Snippet of covered text used as input to the insight asseessment |
| Control | 0..1 |
| Type | Extension(CoveredText) (Extension Type: string) |
| 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()) |
| 7. Extension.extension:insightConfidence | |
| SliceName | insightConfidence |
| Definition | Confidence scoring details for the insight |
| Control | 0..* |
| Type | Extension(InsightConfidence) (Complex Extension) |
| 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()) |
| 8. 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. |
| 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 | http://linuxforhealth.org/fhir/cdm/StructureDefinition/span |
| 9. 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] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |