LinuxForHealth FHIR Implementation Guide
8.0.0 - draft United States of America flag

LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions

Extension: InsightResult - Detailed Descriptions

Active as of 2022-11-10

Definitions for the insight-result extension.

1. Extension
Definition

Value specific insight result details

Optional Extension Element - found in all resources.

2. Extension.extension:insightValue
SliceNameinsightValue
Definition

Field value that this insight result pertains to.

Control0..*
TypeExtension(InsightValue) (Extension Type: Choice of: base64Binary, boolean, date, dateTime, decimal, instant, integer, string, time, uri, Annotation, Attachment, CodeableConcept, Coding, Period, Quantity, Range, Ratio)
3. Extension.extension:basedOnValue
SliceNamebasedOnValue
Definition

Value the insight result used as input; This element is to be used when the value leveraged as input to the insight is not an extracted span of text. Note this is different than the value the insight is about. It is instead a value from another element or reference that was used in evaluating the insight. For example, if the insight pertains to a zip code value, the based-on-value may be a city name that has been specified in another element.

Control0..*
TypeExtension(InsightBasedOnValue) (Extension Type: string)
4. Extension.extension:span
SliceNamespan
Definition

Detail on a span of text from a reference source used as input for an insight evaluation

Control0..*
TypeExtension(Span) (Complex Extension)
5. Extension.url
Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/insight-result
6. Extension.value[x]
Control0..01
[x] NoteSee Choice of Data Types for further information about how to use [x]
1. Extension
Definition

Value specific insight result details

Optional Extension Element - found in all resources.

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined 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:insightValue
SliceNameinsightValue
Definition

Field value that this insight result pertains to.

Control0..*
TypeExtension(InsightValue) (Extension Type: Choice of: base64Binary, boolean, date, dateTime, decimal, instant, integer, string, time, uri, Annotation, Attachment, CodeableConcept, Coding, Period, Quantity, Range, Ratio)
InvariantsDefined 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:basedOnValue
SliceNamebasedOnValue
Definition

Value the insight result used as input; This element is to be used when the value leveraged as input to the insight is not an extracted span of text. Note this is different than the value the insight is about. It is instead a value from another element or reference that was used in evaluating the insight. For example, if the insight pertains to a zip code value, the based-on-value may be a city name that has been specified in another element.

Control0..*
TypeExtension(InsightBasedOnValue) (Extension Type: string)
InvariantsDefined 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:span
SliceNamespan
Definition

Detail on a span of text from a reference source used as input for an insight evaluation

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.

TypeExtension(Span) (Complex Extension)
InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
5. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn 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 Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/insight-result
6. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..01
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. Extension
Definition

Value specific insight result details

Control0..* 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.

Control0..1
Typestring
XML RepresentationIn 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.

Control0..*
TypeExtension
Alternate Namesextensionsuser 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.

InvariantsDefined 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())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.extension:insightValue
SliceNameinsightValue
Definition

Field value that this insight result pertains to.

Control0..*
TypeExtension(InsightValue) (Extension Type: Choice of: base64Binary, boolean, date, dateTime, decimal, instant, integer, string, time, uri, Annotation, Attachment, CodeableConcept, Coding, Period, Quantity, Range, Ratio)
InvariantsDefined 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:basedOnValue
SliceNamebasedOnValue
Definition

Value the insight result used as input; This element is to be used when the value leveraged as input to the insight is not an extracted span of text. Note this is different than the value the insight is about. It is instead a value from another element or reference that was used in evaluating the insight. For example, if the insight pertains to a zip code value, the based-on-value may be a city name that has been specified in another element.

Control0..*
TypeExtension(InsightBasedOnValue) (Extension Type: string)
InvariantsDefined 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:span
SliceNamespan
Definition

Detail on a span of text from a reference source used as input for an insight evaluation

Control0..*
TypeExtension(Span) (Complex Extension)
InvariantsDefined 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.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn 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 Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/insight-result
8. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))