AI Transparency on FHIR
1.0.0-current - STU1 Ballot International flag

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

Resource Profile: AI Data

Official URL: http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-data Version: 1.0.0-current
Standards status: Trial-use Maturity Level: 2 Computable Name: AIdata
Other Identifiers: OID:2.16.840.1.113883.4.642.40.79.42.5

A resource that captures the input and output data used by an AI model in generating or enhancing FHIR resources.

Given that this is a profile on Resource, it can't be used in an IG, but it can be used for validation purposes.

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Resource 0..* Resource Base Resource
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for security SΣ 1..* Coding Security Labels applied to this resource
Slice: Unordered, Open by value:$this
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... security:AItags SΣ 1..* Coding Security Labels applied to this resource
Binding: Recommended provenance codes (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Resource.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Resource.meta.security:AItags Base required Recommended provenance codes 📦1.0.0-current This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Resource 0..* Resource Base Resource
... meta
.... Slices for security S 1..* Coding Security Labels applied to this resource
Slice: Unordered, Open by value:$this
..... security:AItags S 1..* Coding Security Labels applied to this resource
Binding: Recommended provenance codes (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Resource.meta.security:AItags Base required Recommended provenance codes 📦1.0.0-current This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Resource 0..* Resource Base Resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... Slices for security SΣ 1..* Coding Security Labels applied to this resource
Slice: Unordered, Open by value:$this
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... security:AItags SΣ 1..* Coding Security Labels applied to this resource
Binding: Recommended provenance codes (required)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Resource.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Resource.meta.security:AItags Base required Recommended provenance codes 📦1.0.0-current This IG
Resource.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Resource.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Resource.meta.security

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Resource 0..* Resource Base Resource
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for security SΣ 1..* Coding Security Labels applied to this resource
Slice: Unordered, Open by value:$this
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... security:AItags SΣ 1..* Coding Security Labels applied to this resource
Binding: Recommended provenance codes (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Resource.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Resource.meta.security:AItags Base required Recommended provenance codes 📦1.0.0-current This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Resource 0..* Resource Base Resource
... meta
.... Slices for security S 1..* Coding Security Labels applied to this resource
Slice: Unordered, Open by value:$this
..... security:AItags S 1..* Coding Security Labels applied to this resource
Binding: Recommended provenance codes (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Resource.meta.security:AItags Base required Recommended provenance codes 📦1.0.0-current This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Resource 0..* Resource Base Resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... Slices for security SΣ 1..* Coding Security Labels applied to this resource
Slice: Unordered, Open by value:$this
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... security:AItags SΣ 1..* Coding Security Labels applied to this resource
Binding: Recommended provenance codes (required)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Resource.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Resource.meta.security:AItags Base required Recommended provenance codes 📦1.0.0-current This IG
Resource.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Resource.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Resource.meta.security

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron