FHIR IG analytics| Package | hl7.fhir.uv.aitransparency |
| Resource Type | ImplementationGuide |
| Id | ImplementationGuide-hl7.fhir.uv.aitransparency.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/aitransparency-ig/index.html |
| URL | http://hl7.org/fhir/uv/aitransparency/ImplementationGuide/hl7.fhir.uv.aitransparency |
| Version | 1.0.0-ballot |
| Status | active |
| Date | 2025-12-09T17:45:04+00:00 |
| Name | AITransparency |
| Title | AI Transparency on FHIR |
| Realm | uv |
| Authority | hl7 |
| Description | Provides guidance for representing the usage of AI in influencing FHIR resources. Starting with how to tag FHIR resources, and expanding into how to use Provenance, Device, and other data elements, this FHIR IG provides standards that enable downstream use cases to identify such resources. This allows the informed usage of AI-inferred health data. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide hl7.fhir.uv.aitransparency
The official URL for this implementation guide is:
http://hl7.org/fhir/uv/aitransparency/ImplementationGuide/hl7.fhir.uv.aitransparency
Provides guidance for representing the usage of AI in influencing FHIR resources. Starting with how to tag FHIR resources, and expanding into how to use Provenance, Device, and other data elements, this FHIR IG provides standards that enable downstream use cases to identify such resources. This allows the informed usage of AI-inferred health data.
FHIR
FHIRsmith{
"resourceType": "ImplementationGuide",
"id": "hl7.fhir.uv.aitransparency",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "ehr"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}
],
"url": "http://hl7.org/fhir/uv/aitransparency/ImplementationGuide/hl7.fhir.uv.aitransparency",
"version": "1.0.0-ballot",
"name": "AITransparency",
"title": "AI Transparency on FHIR",
"status": "active",
"date": "2025-12-09T17:45:04+00:00",
"publisher": "HL7 International / Electronic Health Records",
"contact": [
{
"name": "HL7 International / Electronic Health Records",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/ehr"
},
{
"system": "email",
"value": "ehr@lists.hl7.org"
}
]
}
],
"description": "Provides guidance for representing the usage of AI in influencing FHIR resources. Starting with how to tag FHIR resources, and expanding into how to use Provenance, Device, and other data elements, this FHIR IG provides standards that enable downstream use cases to identify such resources. This allows the informed usage of AI-inferred health data.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"packageId": "hl7.fhir.uv.aitransparency",
"license": "CC0-1.0",
"fhirVersion": [
"4.0.1"
],
"dependsOn": [
{
"id": "hl7tx",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
}
],
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"packageId": "hl7.terminology.r4",
"version": "7.0.0"
},
{
"id": "hl7ext",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"
}
],
"uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"packageId": "hl7.fhir.uv.extensions.r4",
"version": "5.2.0"
},
{
"id": "ds4p",
"uri": "http://hl7.org/fhir/uv/security-label-ds4p/ImplementationGuide/hl7.fhir.uv.security-label-ds4p",
"packageId": "hl7.fhir.uv.security-label-ds4p",
"version": "1.0.0"
}
],
"definition": {
"extension": [
{
"extension": [
{
"url": "code",
"valueString": "copyrightyear"
},
{
"url": "value",
"valueString": "2024+"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "releaselabel"
},
{
"url": "value",
"valueString": "STU1 Ballot"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "excludettl"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-binary"
},
{
"url": "value",
"valueString": "input/attachment"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "pin-canonicals"
},
{
"url": "value",
"valueString": "pin-multiples"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-history"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/uv/aitransparency/history.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "autoload-resources"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-liquid"
},
{
"url": "value",
"valueString": "template/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-liquid"
},
{
"url": "value",
"valueString": "input/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-qa"
},
{
"url": "value",
"valueString": "temp/qa"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-temp"
},
{
"url": "value",
"valueString": "temp/pages"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-output"
},
{
"url": "value",
"valueString": "output"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-suppressed-warnings"
},
{
"url": "value",
"valueString": "input/ignoreWarnings.txt"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "template-html"
},
{
"url": "value",
"valueString": "template-page.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "template-md"
},
{
"url": "value",
"valueString": "template-page-md.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-contact"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-context"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-copyright"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-jurisdiction"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-license"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-publisher"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-version"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-wg"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "active-tables"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "fmm-definition"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "propagate-status"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "excludelogbinaryformat"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "tabbed-snapshots"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r4#0.8.0"
},
{
"extension": [
{
"url": "code",
"valueCode": "copyrightyear"
},
{
"url": "value",
"valueString": "2024+"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "releaselabel"
},
{
"url": "value",
"valueString": "STU1 Ballot"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "excludettl"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-binary"
},
{
"url": "value",
"valueString": "input/attachment"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "pin-canonicals"
},
{
"url": "value",
"valueString": "pin-multiples"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-history"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/uv/aitransparency/history.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "autoload-resources"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-liquid"
},
{
"url": "value",
"valueString": "template/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-liquid"
},
{
"url": "value",
"valueString": "input/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-qa"
},
{
"url": "value",
"valueString": "temp/qa"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-temp"
},
{
"url": "value",
"valueString": "temp/pages"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-output"
},
{
"url": "value",
"valueString": "output"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-suppressed-warnings"
},
{
"url": "value",
"valueString": "input/ignoreWarnings.txt"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "template-html"
},
{
"url": "value",
"valueString": "template-page.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "template-md"
},
{
"url": "value",
"valueString": "template-page-md.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-contact"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-context"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-copyright"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-jurisdiction"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-license"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-publisher"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-version"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-wg"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "active-tables"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "fmm-definition"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "propagate-status"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "excludelogbinaryformat"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "tabbed-snapshots"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
}
],
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
}
],
"reference": {
"reference": "CodeSystem/AIdeviceTypeCS"
},
"name": "Added Device.type for AI/LLM",
"description": "This CodeSystem contains codes for the Device.type that indicate that the Device is an AI. The codes here were created by AI.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
}
],
"reference": {
"reference": "CodeSystem/AImodelCardCS"
},
"name": "Added DocumentReference.code for AI ModelCard",
"description": "This CodeSystem contains codes for the DocumentReference.type and DocumentReference.category that indicate that the DocumentReference is a Model-Card.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
}
],
"reference": {
"reference": "CodeSystem/AddedProvenanceCS"
},
"name": "Added Provenance Codes",
"description": "This CodeSystem contains codes for the provenance indications used in .meta.security and elsewhere that indicate that the AI system has been involved.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/AI-data"
},
"name": "AI Data",
"description": "A resource that captures the input and output data used by an AI model in generating or enhancing FHIR resources.\n\nGiven that this is a profile on DomainResource, it can't be used in an IG, but it can be used for validation purposes.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/AI-Device"
},
"name": "AI Device",
"description": "A Device that represents an AI system, such as a Large Language Model (LLM) or other AI model. This profile includes a recommended set of codes for Device.type to indicate the type of AI system. The extension AIKind is used to specify the more specific kind(s) of AI technology and techniques employed by the AI system. The extension ModelCardDescription is used to reference a Model-Card that is always used with the AI system.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/AI-ModelCard"
},
"name": "AI Model-Card DocumentReference",
"description": "A DocumentReference that contains a Model-Card describing an AI system.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/AI-Provenance"
},
"name": "AI Provenance",
"description": "An AI Provenance is a record of the use of an AI model in generating or enhancing FHIR resources. It captures the details of the AI model used, the input data given to the AI, and the output generated by the AI.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Procedure"
}
],
"reference": {
"reference": "Procedure/proc"
},
"name": "Appendectomy Procedure",
"description": "A Procedure resource that is created by an AI system and verified by a human.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/ModelCard-sample-CHAI-binary-pdf"
},
"name": "Binary example using Binary of pdf",
"description": "Example of the CHAI example pdf using Binary.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/ModelCard-sample-CHAI-binary-xml"
},
"name": "Binary example using Binary of xml",
"description": "Example of the CHAI example xml using Binary.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/f206"
},
"name": "Blood Culture Result",
"description": "A lab result Observation resource that is created by an AI system and verified by a human.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Bundle"
}
],
"reference": {
"reference": "Bundle/b3c1f2d4-5c8e-4b0a-9f6d-7c8e1f2d4b5c"
},
"name": "Bundle of AI generated resources",
"description": "A Bundle resource containing AI generated resources",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Device"
}
],
"reference": {
"reference": "Device/Attached-ModelCard"
},
"name": "Device with attached Model-Card",
"description": "A Device that has an attached Model-Card.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Device"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Device"
}
],
"reference": {
"reference": "Device/Note-ModelCard"
},
"name": "Device with Model-Card in Device.note.text",
"description": "A Device that has a Model-Card.\nGiven that it is understood that ModelCards are Markdown, this could simply go into the .note.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Device"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DiagnosticReport"
}
],
"reference": {
"reference": "DiagnosticReport/f202"
},
"name": "DiagnosticReport with Inline AI Security Labels",
"description": "This DiagnosticeReport is derived from FHIR Core R4 DiagnosticReport id **f202**. \nThis use contains a DiagnosticReport with inline Artificial Intelligence asserted security labels for the conclusion and conclusionCode, \nas well as a ServiceRequest.\n\n- The DiagnosticReport is tagged with the security label `PROCESSINLINELABEL`, to indicate that there is inline security labeling.\n- The `DiagnosticReport.conclusion` and `DiagnosticReport.conclusionCode` elements are tagged with the Artificial Intelligence asserted security label `AIAST`.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentReference"
}
],
"reference": {
"reference": "DocumentReference/ModelCard-sample-CHAI-attached"
},
"name": "DocumentReference Model-Card in CHAI format attached",
"description": "An example of a Model-Card DocumentReference that contains the Model-Card in CHAI format. Where the Model-Card is attached.\n\nNote: This is not functioning at this time due to problems with IG Publisher and attachments using the ig-loader where the contentType is specified. When it is specified the ig-loader will not work, but we need it to be specified to meet our profile and slicing requirements.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-ModelCard"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentReference"
}
],
"reference": {
"reference": "DocumentReference/ModelCard-sample-CHAI-binary"
},
"name": "DocumentReference Model-Card in CHAI format binary",
"description": "An example of a Model-Card DocumentReference that contains the Model-Card in CHAI format. Where the Model-Card is attached using Binary resources.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-ModelCard"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentReference"
}
],
"reference": {
"reference": "DocumentReference/ModelCard-sample-CHAI-web"
},
"name": "DocumentReference Model-Card in CHAI format from web",
"description": "An example of a Model-Card DocumentReference that contains the Model-Card in CHAI format. Where the Model-Card is referenced from the CHAI GitHub repository.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-ModelCard"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentReference"
}
],
"reference": {
"reference": "DocumentReference/ModelCard-sample-huggingface-attached"
},
"name": "DocumentReference Model-Card in HuggingFace Markdown format attached",
"description": "An example of a Model-Card DocumentReference that contains the Model-Card in YAML and Markdown formats.Using an example from HuggingFace.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-ModelCard"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/glasgow"
},
"name": "Example Observation with AI Assisted security labels",
"description": "This observation is derived from FHIR Core R4 Observation id **glasgow**. \nThis use contains a Glasgow Coma Scale observation with **Artificial Intelligence asserted** security labels for the whole Resource.\n\nNote that the example I took, I assumed was a good one for AIAST. But I am not sure that it is, especially since the outcome is not well coded, using ucum score values.\n\nNote that there is no .performer as that element can't hold a Device, and we are modeling this as being wholely authored by the AI. Thus I use the extension alternate-reference.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Provenance"
}
],
"reference": {
"reference": "Provenance/AIdeviceTypeCS-initial-history"
},
"name": "Initial creation of AIdeviceTypeCS CodeSystem",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentReference"
}
],
"reference": {
"reference": "DocumentReference/Input-Prompt-lorem-ipsum"
},
"name": "Input Prompt DocumentReference lorem ipsum",
"description": "A DocumentReference that contains the input prompt provided to the AI system. -- Lorem ipsum text is used as a placeholder.\n\n```\nGenerate a lorem ipsum text to serve as placeholder copy for use in design, development, and publishing. \n\n1. Specify the exact amount of text or the number of paragraphs required (e.g., 1 paragraph, 3 paragraphs, etc.). \n2. Create the lorem ipsum text using a classic style or introduce slight variations while keeping the nonsensical nature to suit the requested length. \n\nEnsure that the text maintains a good balance between readability and the traditional lorem ipsum style, giving a realistic impression of how the text will impact the overall layout and design.\n\n# Output Format\n- Provide a continuous block of lorem ipsum text corresponding to the specified amount needed.\n```",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-ModelCard"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentReference"
}
],
"reference": {
"reference": "DocumentReference/Input-Prompt-create-patient"
},
"name": "Input Prompt DocumentReference to create a patient",
"description": "A DocumentReference that contains the input prompt provided to the AI system. -- to generate a Patient resource.\n\n```\nSystem Prompt\n\nYou are a healthcare data specialist that converts natural language patient information into valid FHIR Patient resources. Your task is to extract relevant patient demographics and create a well-formed FHIR Patient resource that is fully conformant with FHIR US Core 6.1.0 specifications.\n\nRequirements:\n\n- Generate valid JSON that conforms to FHIR R4 Patient resource structure\n- Ensure compliance with US Core Patient Profile (US Core 6.1.0)\n- Include all required US Core elements when data is available\n- Use appropriate FHIR data types and value sets\n- Generate a unique resource ID using UUID format\n- Apply proper FHIR coding systems and terminologies\n- Handle missing data appropriately (omit optional fields when data unavailable)\n- Use standard US address formatting\n- Apply proper date formatting (YYYY-MM-DD)\n- Include appropriate extensions when necessary for US Core compliance\n\nUS Core 6.1.0 Patient Profile Requirements:\n\n- Must include: identifier, name, gender, birthDate\n- Should include: address, telecom, race, ethnicity when available\n- Use US Core extensions for race and ethnicity\n- Follow US postal address conventions\n- Use appropriate terminologies (e.g., HL7 AdministrativeGender, OMB race categories)\n\nData Mapping Guidelines:\n\n- Extract patient name and structure as HumanName with family/given components\n- Map gender terms to FHIR AdministrativeGender codes (male, female, other, unknown)\n- Convert birth dates to FHIR date format\n- Structure addresses using Address data type with appropriate use codes\n- Map race/ethnicity information using US Core extensions with appropriate OMB codes\n- Generate medical record number as primary identifier when not provided\n- Include meta.profile reference to US Core Patient profile\n\nOutput Format:\n\n- Provide only the valid FHIR JSON resource without additional commentary or explanation.\n\nUser Prompt\n\n- Convert the following patient information into a FHIR Patient resource conformant with US Core 6.1.0:\n\n`Jane Doe is a white female born on November 15, 1950. She lives at 123 Main Street, Anytown, Michigan, zipcode 12345.`\n```",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-ModelCard"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentReference"
}
],
"reference": {
"reference": "DocumentReference/Lab-Results-PDF"
},
"name": "Lab Results PDF",
"description": "A DocumentReference resource that represents a PDF document containing lab results for a patient. \nThis is provided to an AI, which interprets and creates FHIR Resources.\n\nIn the attached example the patient's name is Alton Walsh and the lab test is an HbA1C. All the FHIR resources in the bundle have been created by the AI, so they should be tagged accordingly.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
}
],
"reference": {
"reference": "StructureDefinition/aitransparency.modelCardDescription"
},
"name": "Model-Card",
"description": "When the Device is described by a Model-Card, this extension can be used to reference the Model-Card.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/satO2"
},
"name": "Oxygen Saturation example with AI device",
"description": "An example of an Oxygen Saturation Observation, where the device used is an AI system.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Patient"
}
],
"reference": {
"reference": "Patient/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"name": "Patient an AI generated",
"description": "An example Patient resource generated by AI",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Provenance"
}
],
"reference": {
"reference": "Provenance/AI-generated-patient-resource"
},
"name": "Provenance for AI created Patient resource",
"description": "A Provenance resource that captures the full AI process, including the Model-Card, input, and output.\n\nThis is a full example of how to capture the AI process in FHIR.\n\n- One output that this Provenance resource is documenting:\n - an Patient resource \n- Two agents\n - a verifier (human) who verifies the AI output\n - an author (AI system) who generated the output\n- One entity that is the AI Input Prompt\n - Where the Input Prompt is a DocumentReference resource that contains the input prompt provided to the AI system.\n - Where the Input Prompt is a contained resource in the Provenance resource.\n - Where the Input Prompt is associated with the clinician which provided it",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Provenance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Provenance"
}
],
"reference": {
"reference": "Provenance/AI-full-lorem-ipsum"
},
"name": "Provenance for AI with Model-Card, input, and output",
"description": "A Provenance resource that captures the full AI process, including the Model-Card, input, and output.\n\nThis is a full example of how to capture the AI process in FHIR.\n\n- Two outputs that this Provenance resource is documenting:\n - an Observation resource (e.g., lab result)\n - with Observation.interpretation being attributed to this Provenance\n - a CarePlan resource (e.g., follow-up care plan)\n- Two agents\n - a verifier (human) who verifies the AI output\n - an author (AI system) who generated the output\n- Two entities that were clinical resources provided to the AI system\n - a DocumentReference resource (e.g., patient summary)\n - an Observation resource (e.g., lab result)\n- One entity that is a PlanDefinition resource (e.g., care plan definition)\n- One entity that is the AI Input Prompt\n - Where the Input Prompt is a DocumentReference resource that contains the input prompt provided to the AI system.\n - Where the Input Prompt is a contained resource in the Provenance resource.\n - Where the Input Prompt is associated with the clinician which provided it",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Provenance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Provenance"
}
],
"reference": {
"reference": "Provenance/AI-Contributed"
},
"name": "Provenance of AI authored Lab Observation",
"description": "A Provenance resource that documents the creation of a Lab result Observation resource by an AI (device), verified by a human.\n- The AI system is represented as a Device resource.\n- No Model-Card was used.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Provenance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Provenance"
}
],
"reference": {
"reference": "Provenance/AI-Authored-Element"
},
"name": "Provenance of AI Authored Procedure.followup.text",
"description": "A Provenance resource that documents the addition of followUp text in a Procedure by an AI system. No Model-Card was used.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Provenance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Provenance"
}
],
"reference": {
"reference": "Provenance/AI-Generated-Lab-Results"
},
"name": "Provenance of AI Generated Lab Results",
"description": "A Provenance resource that documents the creation of a Lab result Observation resource by an AI (device), verified by a human.\n- The AI system is represented as a Device resource.\n- No Model-Card was used.\n- The Input is a PDF Lab result.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Provenance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/AIdeviceTypeVS"
},
"name": "Recommended Device.type codes for AI/LLM",
"description": "Subset from HL7, plus those defined here",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/ProvenanceVS"
},
"name": "Recommended provenance codes",
"description": "Subset from HL7, plus those defined here. For use in .meta.security to indicate AI was used in some way.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
}
],
"reference": {
"reference": "StructureDefinition/aitransparency.AIKind"
},
"name": "Specific kind of AI technology",
"description": "Expresses the more specific kind(s) of AI technology and techniques.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Device"
}
],
"reference": {
"reference": "Device/TheAI"
},
"name": "The AI System",
"description": "An AI system that authored a resource.",
"exampleCanonical": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Device"
}
],
"page": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "toc.html"
}
],
"nameUrl": "toc.html",
"title": "Table of Contents",
"generation": "html",
"page": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "index.html"
}
],
"nameUrl": "index.html",
"title": "Overview",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "general_guidance.html"
}
],
"nameUrl": "general_guidance.html",
"title": "General Guidance",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "use_cases.html"
}
],
"nameUrl": "use_cases.html",
"title": "Use Cases",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "changes.html"
}
],
"nameUrl": "changes.html",
"title": "Changes",
"generation": "markdown"
}
]
},
"parameter": [
{
"code": "path-resource",
"value": "input/capabilities"
},
{
"code": "path-resource",
"value": "input/examples"
},
{
"code": "path-resource",
"value": "input/extensions"
},
{
"code": "path-resource",
"value": "input/models"
},
{
"code": "path-resource",
"value": "input/operations"
},
{
"code": "path-resource",
"value": "input/profiles"
},
{
"code": "path-resource",
"value": "input/resources"
},
{
"code": "path-resource",
"value": "input/vocabulary"
},
{
"code": "path-resource",
"value": "input/maps"
},
{
"code": "path-resource",
"value": "input/testing"
},
{
"code": "path-resource",
"value": "input/history"
},
{
"code": "path-resource",
"value": "fsh-generated/resources"
},
{
"code": "path-pages",
"value": "template/config"
},
{
"code": "path-pages",
"value": "input/images"
},
{
"code": "path-tx-cache",
"value": "input-cache/txcache"
}
]
}
}