| Package | hl7.fhir.uv.aitransparency |
| Resource Type | StructureDefinition |
| Id | ModelCard |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/aitransparency/https://build.fhir.org/ig/HL7/aitransparency-ig/StructureDefinition-ModelCard.html |
| URL | http://hl7.org/fhir/uv/aitransparency/StructureDefinition/ModelCard |
| Version | 0.1.0 |
| Status | draft |
| Date | 2025-08-11T18:02:37+00:00 |
| Name | ModelCard |
| Title | AI Model Card |
| Realm | uv |
| Authority | hl7 |
| Description | An AI model card is a document that provides a standardized overview of an artificial intelligence model's purpose, performance, intended usage, and limitations. `ModelCard` could be a subset of the HuggingFace model card specification: https://huggingface.co/docs/hub/model-card-annotated. |
| Type | http://hl7.org/fhir/uv/aitransparency/StructureDefinition/ModelCard |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ModelCard
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ModelCard | 0..* | Base | AI Model Card Instances of this logical model can be the target of a Reference | |
  id | Σ | 0..1 | string | model card identifier |
| name | Σ | 0..1 | string | model card title |
| description | 0..1 | string | Basic details about the model. | |
| type | 0..1 | code | model type | |
  appliedIn | 0..* | Reference(Resource) | FHIR resource where the model was used if it was AI-generated | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "ModelCard",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "ehr"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/aitransparency/ImplementationGuide/hl7.fhir.uv.aitransparency"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/ModelCard",
"version": "0.1.0",
"name": "ModelCard",
"title": "AI Model Card",
"status": "draft",
"date": "2025-08-11T18:02:37+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": "An AI model card is a document that provides a standardized overview of an artificial intelligence model's purpose, performance, intended usage, and limitations. `ModelCard` could be a subset of the HuggingFace model card specification: https://huggingface.co/docs/hub/model-card-annotated.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/aitransparency/StructureDefinition/ModelCard",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "ModelCard",
"path": "ModelCard",
"short": "AI Model Card",
"definition": "An AI model card is a document that provides a standardized overview of an artificial intelligence model's purpose, performance, intended usage, and limitations. `ModelCard` could be a subset of the HuggingFace model card specification: https://huggingface.co/docs/hub/model-card-annotated.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "ModelCard.id",
"path": "ModelCard.id",
"short": "model card identifier",
"definition": "model card identifier",
"min": 0,
"max": "1",
"base": {
"path": "ModelCard.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ModelCard.name",
"path": "ModelCard.name",
"short": "model card title",
"definition": "model card title",
"min": 0,
"max": "1",
"base": {
"path": "ModelCard.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ModelCard.description",
"path": "ModelCard.description",
"short": "Basic details about the model.",
"definition": "This includes the architecture, version, if it was introduced in a paper, if an original implementation is available, and the creators. Any copyright should be attributed here. General information about training procedures, parameters, and important disclaimers can also be mentioned in this section.",
"min": 0,
"max": "1",
"base": {
"path": "ModelCard.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ModelCard.type",
"path": "ModelCard.type",
"short": "model type",
"definition": "You can name the “type” as: 1 = Supervision/Learning Method, 2 = Machine Learning Type, 3 = Modality",
"min": 0,
"max": "1",
"base": {
"path": "ModelCard.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "ModelCard.appliedIn",
"path": "ModelCard.appliedIn",
"short": "FHIR resource where the model was used if it was AI-generated",
"definition": "FHIR resource where the model was used if it was AI-generated",
"min": 0,
"max": "*",
"base": {
"path": "ModelCard.appliedIn",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
]
}
]
},
"differential": {
"element": [
{
"id": "ModelCard",
"path": "ModelCard",
"short": "AI Model Card",
"definition": "An AI model card is a document that provides a standardized overview of an artificial intelligence model's purpose, performance, intended usage, and limitations. `ModelCard` could be a subset of the HuggingFace model card specification: https://huggingface.co/docs/hub/model-card-annotated."
},
{
"id": "ModelCard.id",
"path": "ModelCard.id",
"short": "model card identifier",
"definition": "model card identifier",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ModelCard.name",
"path": "ModelCard.name",
"short": "model card title",
"definition": "model card title",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ModelCard.description",
"path": "ModelCard.description",
"short": "Basic details about the model.",
"definition": "This includes the architecture, version, if it was introduced in a paper, if an original implementation is available, and the creators. Any copyright should be attributed here. General information about training procedures, parameters, and important disclaimers can also be mentioned in this section.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ModelCard.type",
"path": "ModelCard.type",
"short": "model type",
"definition": "You can name the “type” as: 1 = Supervision/Learning Method, 2 = Machine Learning Type, 3 = Modality",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "ModelCard.appliedIn",
"path": "ModelCard.appliedIn",
"short": "FHIR resource where the model was used if it was AI-generated",
"definition": "FHIR resource where the model was used if it was AI-generated",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
]
}
]
}
}