AI Transparency on FHIR
1.0.0-current - STU1 Ballot
AI Transparency on FHIR
1.0.0-current - STU1 Ballot
AI Transparency on FHIR, published by HL7 International / Electronic Health Records. This guide is not an authorized publication; it is the continuous build for version 1.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/aitransparency-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the AIconfidence extension
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | The confidence that an AI system has in the result recorded in the resource or element to which this extension is attached. The confidence is expressible as:
Optional Extension Element - found in all resources. |
| Short | AI ConfidenceOptional Extensions Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | 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())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. |
| Short | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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 areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AIconfidence |
| 6. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 10..1 |
| Type | Choice of: decimal, string, CodeableConcept, Quantity, Range, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, RelatedArtifact, base64Binary, UsageContext, Timing, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | false |
| Invariants | 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.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 8. Extension.value[x]:valueDecimal | |
| Slice Name | valueDecimal |
| Definition | The probability that the result is correct, expressed as a decimal between 0 and 1. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | ProbabilityValue of extension |
| Control | 0..1 |
| Type | decimal, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, CodeableConcept, 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 | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Extension.value[x]:valueQuantity | |
| Slice Name | valueQuantity |
| Definition | The probability that the result is correct, expressed as a percentage with units. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | PercentageValue of extension |
| Control | 0..1 |
| Type | 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 | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Extension.value[x]:valueRange | |
| Slice Name | valueRange |
| Definition | The confidence interval for the result, expressed as a range of values. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Confidence IntervalValue of extension |
| Control | 0..1 |
| Type | Range, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, 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, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Extension.value[x]:valueCodeableConcept | |
| Slice Name | valueCodeableConcept |
| Definition | The confidence that the result is correct, expressed as a categorical value (e.g., low/medium/high). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Categorical ConfidenceValue of extension |
| Control | 0..1 |
| Binding | The codes SHALL be taken from For codes, see StatisticCertaintyRating (2.0.0) (required to http://terminology.hl7.org/ValueSet/certainty-rating|2.0.0) |
| Type | 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 | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Extension.value[x]:valueString | |
| Slice Name | valueString |
| Definition | The confidence that the result is correct, expressed as a free-form string. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Free-form ConfidenceValue of extension |
| Control | 0..1 |
| Type | string, 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, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Invariants | 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 foundhere
| 0. Extension | |
| Definition | The confidence that an AI system has in the result recorded in the resource or element to which this extension is attached. The confidence is expressible as:
|
| Short | AI Confidence |
| 2. Extension.extension | |
| Control | 0..0 |
| 4. Extension.url | |
| Fixed Value | http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AIconfidence |
| 6. Extension.value[x] | |
| Control | 1..? |
| Type | Choice of: decimal, string, CodeableConcept, Quantity, Range, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, RelatedArtifact, base64Binary, UsageContext, Timing, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor 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 |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Slicing | This element introduces a set of slices on Extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. Extension.value[x]:valueDecimal | |
| Slice Name | valueDecimal |
| Definition | The probability that the result is correct, expressed as a decimal between 0 and 1. |
| Short | Probability |
| Control | 0..1 |
| Type | decimal |
| [x] Note | SeeChoice of Data Typesfor 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 |
| 10. Extension.value[x]:valueQuantity | |
| Slice Name | valueQuantity |
| Definition | The probability that the result is correct, expressed as a percentage with units. |
| Short | Percentage |
| Control | 0..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 12. Extension.value[x]:valueRange | |
| Slice Name | valueRange |
| Definition | The confidence interval for the result, expressed as a range of values. |
| Short | Confidence Interval |
| Control | 0..1 |
| Type | Range |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 14. Extension.value[x]:valueCodeableConcept | |
| Slice Name | valueCodeableConcept |
| Definition | The confidence that the result is correct, expressed as a categorical value (e.g., low/medium/high). |
| Short | Categorical Confidence |
| Control | 0..1 |
| Binding | The codes SHALL be taken from StatisticCertaintyRating (2.0.0) (required to http://terminology.hl7.org/ValueSet/certainty-rating|2.0.0) |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 16. Extension.value[x]:valueString | |
| Slice Name | valueString |
| Definition | The confidence that the result is correct, expressed as a free-form string. |
| Short | Free-form Confidence |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor 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 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | The confidence that an AI system has in the result recorded in the resource or element to which this extension is attached. The confidence is expressible as:
|
| Short | AI Confidence |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | 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.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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 areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AIconfidence |
| 8. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 1..1 |
| Type | Choice of: decimal, string, CodeableConcept, Quantity, Range |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | false |
| Invariants | 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.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 10. Extension.value[x]:valueDecimal | |
| Slice Name | valueDecimal |
| Definition | The probability that the result is correct, expressed as a decimal between 0 and 1. |
| Short | Probability |
| Control | 0..1 |
| Type | decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Extension.value[x]:valueQuantity | |
| Slice Name | valueQuantity |
| Definition | The probability that the result is correct, expressed as a percentage with units. |
| Short | Percentage |
| Control | 0..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Extension.value[x]:valueRange | |
| Slice Name | valueRange |
| Definition | The confidence interval for the result, expressed as a range of values. |
| Short | Confidence Interval |
| Control | 0..1 |
| Type | Range |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Extension.value[x]:valueCodeableConcept | |
| Slice Name | valueCodeableConcept |
| Definition | The confidence that the result is correct, expressed as a categorical value (e.g., low/medium/high). |
| Short | Categorical Confidence |
| Control | 0..1 |
| Binding | The codes SHALL be taken from StatisticCertaintyRating (2.0.0) (required to http://terminology.hl7.org/ValueSet/certainty-rating|2.0.0) |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Extension.value[x]:valueString | |
| Slice Name | valueString |
| Definition | The confidence that the result is correct, expressed as a free-form string. |
| Short | Free-form Confidence |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
IG © 2024+ HL7 International / Electronic Health Records.
Package hl7.fhir.uv.aitransparency#1.0.0-current based on FHIR 4.0.1.
Generated
2026-08-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change