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 insight extension.
| 1. Extension | |
| Definition | Element level insights relating to the element values in the contained resource instance Optional Extension Element - found in all resources. |
| 2. Extension.extension:path | |
| SliceName | path |
| Definition | Path to the FHIR element that the insight pertains to; Multiple array instances for path should only be created when the same set of insight results pertain to more than one path. If insight results are different for each path, then multiple insight elements at the top level insight array should be created instead. |
| Control | 0..* |
| Type | Extension(Path) (Extension Type: string) |
| 3. Extension.extension:insightId | |
| SliceName | insightId |
| Definition | ID for the insight as it is known by the source (or source system) that this insight was provided from. |
| Control | 0..1 |
| Type | Extension(InsightId) (Extension Type: Identifier) |
| 4. Extension.extension:sourceId | |
| SliceName | sourceId |
| Definition | The ID of the source of the insight, such as an individual, algorithm, etc. that generated the insight. |
| Control | 0..1 |
| Type | Extension(SourceId) (Extension Type: Identifier) |
| 5. Extension.extension:detected | |
| SliceName | detected |
| Definition | When the insight evaluation occurred |
| Control | 0..1 |
| Type | Extension(Detected) (Extension Type: dateTime) |
| 6. Extension.extension:category | |
| SliceName | category |
| Definition | Top level category classifying the type of insight, such as Natural Language Processing, Data Quality, etc. |
| Control | 0..1 |
| Type | Extension(Category) (Extension Type: CodeableConcept) |
| 7. Extension.extension:category.valueCodeableConcept | |
| Control | 0..1 |
| Binding | For example codes, see Insight Category ValueSet |
| 8. Extension.extension:insightType | |
| SliceName | insightType |
| Definition | Code for the specific insight type, such as Phone Number Inconsistent with Area Code |
| Control | 0..1 |
| Type | Extension(InsightType) (Extension Type: CodeableConcept) |
| 9. Extension.extension:insightDetail | |
| SliceName | insightDetail |
| Definition | Information leveraged to produce the insight results and information specific scoring breakdown when appropriate |
| Control | 0..* |
| Type | Extension(InsightDetail) (Complex Extension) |
| 10. Extension.extension:result | |
| SliceName | result |
| Definition | Value specific final insight results |
| Control | 0..* |
| Type | Extension(InsightResultSummary) (Complex Extension) |
| 11. Extension.url | |
| Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/insight |
| 12. Extension.value[x] | |
| Control | 0..01 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 1. Extension | |
| Definition | Element level insights relating to the element values in the contained resource instance 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:path | |
| SliceName | path |
| Definition | Path to the FHIR element that the insight pertains to; Multiple array instances for path should only be created when the same set of insight results pertain to more than one path. If insight results are different for each path, then multiple insight elements at the top level insight array should be created instead. |
| Control | 0..* |
| Type | Extension(Path) (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()) |
| 3. Extension.extension:insightId | |
| SliceName | insightId |
| Definition | ID for the insight as it is known by the source (or source system) that this insight was provided from. |
| Control | 0..1 |
| Type | Extension(InsightId) (Extension Type: Identifier) |
| 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:sourceId | |
| SliceName | sourceId |
| Definition | The ID of the source of the insight, such as an individual, algorithm, etc. that generated the insight. |
| Control | 0..1 |
| Type | Extension(SourceId) (Extension Type: Identifier) |
| 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:detected | |
| SliceName | detected |
| Definition | When the insight evaluation occurred |
| Control | 0..1 |
| Type | Extension(Detected) (Extension Type: dateTime) |
| 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:category | |
| SliceName | category |
| Definition | Top level category classifying the type of insight, such as Natural Language Processing, Data Quality, etc. |
| Control | 0..1 |
| Type | Extension(Category) (Extension Type: CodeableConcept) |
| 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:category.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 | 0..0* |
| Type | Extension |
| 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:
|
| 8. Extension.extension:category.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/category |
| 9. Extension.extension:category.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: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, 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] |
| 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:
|
| 10. Extension.extension:category.value[x]:valueCodeableConcept | |
| SliceName | valueCodeableConcept |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 |
| Binding | For example codes, see Insight Category ValueSetFor codes, see (unbound) |
| Type | Choice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, 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] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. Extension.extension:insightType | |
| SliceName | insightType |
| Definition | Code for the specific insight type, such as Phone Number Inconsistent with Area Code |
| Control | 0..1 |
| Type | Extension(InsightType) (Extension Type: CodeableConcept) |
| 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()) |
| 12. Extension.extension:insightDetail | |
| SliceName | insightDetail |
| Definition | Information leveraged to produce the insight results and information specific scoring breakdown when appropriate 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(InsightDetail) (Complex Extension) |
| Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
| 13. Extension.extension:result | |
| SliceName | result |
| Definition | Value specific final insight results 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(InsightResultSummary) (Complex Extension) |
| Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
| 14. 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/insight |
| 15. 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 | Element level insights relating to the element values in the contained resource instance |
| 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:path | |
| SliceName | path |
| Definition | Path to the FHIR element that the insight pertains to; Multiple array instances for path should only be created when the same set of insight results pertain to more than one path. If insight results are different for each path, then multiple insight elements at the top level insight array should be created instead. |
| Control | 0..* |
| Type | Extension(Path) (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:insightId | |
| SliceName | insightId |
| Definition | ID for the insight as it is known by the source (or source system) that this insight was provided from. |
| Control | 0..1 |
| Type | Extension(InsightId) (Extension Type: Identifier) |
| 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:sourceId | |
| SliceName | sourceId |
| Definition | The ID of the source of the insight, such as an individual, algorithm, etc. that generated the insight. |
| Control | 0..1 |
| Type | Extension(SourceId) (Extension Type: Identifier) |
| 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:detected | |
| SliceName | detected |
| Definition | When the insight evaluation occurred |
| Control | 0..1 |
| Type | Extension(Detected) (Extension Type: dateTime) |
| 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.extension:category | |
| SliceName | category |
| Definition | Top level category classifying the type of insight, such as Natural Language Processing, Data Quality, etc. |
| Control | 0..1 |
| Type | Extension(Category) (Extension Type: CodeableConcept) |
| 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:category.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. |
| 10. Extension.extension:category.extension | |
| Definition | An Extension |
| Control | 0..0 |
| Type | 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()) |
| 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:
|
| 11. Extension.extension:category.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/category |
| 12. Extension.extension:category.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 | CodeableConcept |
| [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())) |
| 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:
|
| 13. Extension.extension:category.value[x]:valueCodeableConcept | |
| SliceName | valueCodeableConcept |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 |
| Binding | For example codes, see Insight Category ValueSet |
| Type | CodeableConcept |
| [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())) |
| 14. Extension.extension:insightType | |
| SliceName | insightType |
| Definition | Code for the specific insight type, such as Phone Number Inconsistent with Area Code |
| Control | 0..1 |
| Type | Extension(InsightType) (Extension Type: CodeableConcept) |
| 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()) |
| 15. Extension.extension:insightDetail | |
| SliceName | insightDetail |
| Definition | Information leveraged to produce the insight results and information specific scoring breakdown when appropriate |
| Control | 0..* |
| Type | Extension(InsightDetail) (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()) |
| 16. Extension.extension:result | |
| SliceName | result |
| Definition | Value specific final insight results |
| Control | 0..* |
| Type | Extension(InsightResultSummary) (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()) |
| 17. 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/insight |
| 18. 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())) |