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: InsightDetail - Detailed Descriptions

Active as of 2022-11-10

Definitions for the insight-detail extension.

1. Extension
Definition

The break down of information referenced to produce the insight and information specific scoring breakdown and output when appropriate

Optional Extension Element - found in all resources.

2. Extension.extension:reference
SliceNamereference
Definition

Reference to content leveraged to produce the insight

Control0..1
TypeExtension(InsightReference) (Extension Type: Reference)
3. Extension.extension:referencePath
SliceNamereferencePath
Definition

Path to FHIR element in the reference that was used to produce the insight

Control0..1
TypeExtension(ReferencePath) (Extension Type: string)
4. Extension.extension:evaluatedOutput
SliceNameevaluatedOutput
Definition

Attachment for content created as output when producing the insight

Control0..1
TypeExtension(EvaluatedOutput) (Extension Type: Attachment)
5. Extension.extension:insightResult
SliceNameinsightResult
Definition

Value specific final insight results based on a particular piece of evaluated input. For example, if one or more pieces of unstructured content have been used as input to the insight, the insight result is specific to one fragment of text that has been annotated from that unstructured content.

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

The break down of information referenced to produce the insight and information specific scoring breakdown and output when appropriate

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:reference
SliceNamereference
Definition

Reference to content leveraged to produce the insight

Control0..1
TypeExtension(InsightReference) (Extension Type: Reference)
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:referencePath
SliceNamereferencePath
Definition

Path to FHIR element in the reference that was used to produce the insight

Control0..1
TypeExtension(ReferencePath) (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:evaluatedOutput
SliceNameevaluatedOutput
Definition

Attachment for content created as output when producing the insight

Control0..1
TypeExtension(EvaluatedOutput) (Extension Type: Attachment)
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:insightResult
SliceNameinsightResult
Definition

Value specific final insight results based on a particular piece of evaluated input. For example, if one or more pieces of unstructured content have been used as input to the insight, the insight result is specific to one fragment of text that has been annotated from that unstructured content.

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(InsightResult) (Complex Extension)
InvariantsDefined 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.

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-detail
7. 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

The break down of information referenced to produce the insight and information specific scoring breakdown and output when appropriate

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:reference
SliceNamereference
Definition

Reference to content leveraged to produce the insight

Control0..1
TypeExtension(InsightReference) (Extension Type: Reference)
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:referencePath
SliceNamereferencePath
Definition

Path to FHIR element in the reference that was used to produce the insight

Control0..1
TypeExtension(ReferencePath) (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:evaluatedOutput
SliceNameevaluatedOutput
Definition

Attachment for content created as output when producing the insight

Control0..1
TypeExtension(EvaluatedOutput) (Extension Type: Attachment)
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.extension:insightResult
SliceNameinsightResult
Definition

Value specific final insight results based on a particular piece of evaluated input. For example, if one or more pieces of unstructured content have been used as input to the insight, the insight result is specific to one fragment of text that has been annotated from that unstructured content.

Control0..*
TypeExtension(InsightResult) (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())
8. 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-detail
9. 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()))