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 0.1.0 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
| Official URL: http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Provenance | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: AIProvenance | ||
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.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | 
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | 
|    target | SΣ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) | 
|    occurred[x] | S | 0..1 | When the activity occurred | |
|     occurredPeriod | Period | |||
|     occurredDateTime | dateTime | |||
|    recorded | Σ | 1..1 | instant | When the activity was recorded / updated | 
|    Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by value:$this Binding: PurposeOfUse (extensible): The reason the activity took place. | |
|     reason:AIReason | 1..* | CodeableConcept | Reason the activity is occurring Binding: Recommended provenance codes (required) | |
|    Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who | |
|     agent:All Slices | Content/Rules for all slices | |||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | 
|     agent:AIModelAgent | 1..* | BackboneElement | Actor involved | |
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      who | Σ | 1..1 | Reference(AI Device) | Who participated | 
|    Slices for entity | 0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what | |
|     entity:All Slices | Content/Rules for all slices | |||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | 
|      what | Σ | 1..1 | Reference(Resource) | Identity of entity | 
|     entity:AIInputData | 0..* | BackboneElement | An entity used in this activity | |
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | 
|      what | Σ | 1..1 | Reference(AI Model Card DocumentReference) | Identity of entity | 
|  Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.5 | 
| Provenance.reason:AIReason | Base | required | Recommended provenance codes | 📦0.1.0 | This IG | 
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. | 
| Provenance.entity:AIInputData.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. | 
| Id | Grade | Path(s) | Description | Expression | 
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources | contained.contained.empty() | 
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | 
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | 
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label | contained.meta.security.empty() | 
| dom-6 | best practice | Provenance | A resource should have narrative for robust management | text.`div`.exists() | 
| 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() | 
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
|    target | S | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) | 
|    occurred[x] | S | 0..1 | Period, dateTime | When the activity occurred | 
|    Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by value:$this | |
|     reason:AIReason | 1..* | CodeableConcept | Reason the activity is occurring Binding: Recommended provenance codes (required) | |
|    Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who | |
|     agent:AIModelAgent | 1..* | BackboneElement | Actor involved | |
|      who | 1..1 | Reference(AI Device) | Who participated | |
|    Slices for entity | 0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what | |
|     entity:AIInputData | 0..* | BackboneElement | An entity used in this activity | |
|      what | 1..1 | Reference(AI Model Card DocumentReference) | Identity of entity | |
|  Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Provenance.reason:AIReason | Base | required | Recommended provenance codes | 📦0.1.0 | This IG | 
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
|   Provenance | 0..* | Provenance | Who, What, When for a set of resources | |||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    target | SΣ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) | ||||
|    occurred[x] | S | 0..1 | When the activity occurred | |||||
|     occurredPeriod | Period | |||||||
|     occurredDateTime | dateTime | |||||||
|    recorded | Σ | 1..1 | instant | When the activity was recorded / updated | ||||
|    policy | 0..* | uri | Policy or plan the activity was defined by | |||||
|    location | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
|    Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by value:$this Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
|     reason:AIReason | 1..* | CodeableConcept | Reason the activity is occurring Binding: Recommended provenance codes (required) | |||||
|    activity | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
|    Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who | |||||
|     agent:All Slices | Content/Rules for all slices | |||||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|      type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | ||||
|      role | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
|      who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | ||||
|      onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
|     agent:AIModelAgent | 1..* | BackboneElement | Actor involved | |||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|      type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | ||||
|      role | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
|      who | Σ | 1..1 | Reference(AI Device) | Who participated | ||||
|      onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
|    Slices for entity | 0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what | |||||
|     entity:All Slices | Content/Rules for all slices | |||||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|      role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
|      what | Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
|      agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
|     entity:AIInputData | 0..* | BackboneElement | An entity used in this activity | |||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|      role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
|      what | Σ | 1..1 | Reference(AI Model Card DocumentReference) | Identity of entity | ||||
|      agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
|    signature | 0..* | Signature | Signature on target | |||||
|  Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. | 
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.5 | 
| Provenance.reason:AIReason | Base | required | Recommended provenance codes | 📦0.1.0 | This IG | 
| Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std. | 
| Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. | 
| Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. | 
| Provenance.agent:AIModelAgent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. | 
| Provenance.agent:AIModelAgent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. | 
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. | 
| Provenance.entity:AIInputData.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. | 
| Id | Grade | Path(s) | Description | Expression | 
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources | contained.contained.empty() | 
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | 
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | 
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label | contained.meta.security.empty() | 
| dom-6 | best practice | Provenance | A resource should have narrative for robust management | text.`div`.exists() | 
| 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() | 
This structure is derived from Provenance
Summary
Mandatory: 3 elements
 Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | 
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | 
|    target | SΣ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) | 
|    occurred[x] | S | 0..1 | When the activity occurred | |
|     occurredPeriod | Period | |||
|     occurredDateTime | dateTime | |||
|    recorded | Σ | 1..1 | instant | When the activity was recorded / updated | 
|    Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by value:$this Binding: PurposeOfUse (extensible): The reason the activity took place. | |
|     reason:AIReason | 1..* | CodeableConcept | Reason the activity is occurring Binding: Recommended provenance codes (required) | |
|    Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who | |
|     agent:All Slices | Content/Rules for all slices | |||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | 
|     agent:AIModelAgent | 1..* | BackboneElement | Actor involved | |
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      who | Σ | 1..1 | Reference(AI Device) | Who participated | 
|    Slices for entity | 0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what | |
|     entity:All Slices | Content/Rules for all slices | |||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | 
|      what | Σ | 1..1 | Reference(Resource) | Identity of entity | 
|     entity:AIInputData | 0..* | BackboneElement | An entity used in this activity | |
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | 
|      what | Σ | 1..1 | Reference(AI Model Card DocumentReference) | Identity of entity | 
|  Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.5 | 
| Provenance.reason:AIReason | Base | required | Recommended provenance codes | 📦0.1.0 | This IG | 
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. | 
| Provenance.entity:AIInputData.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. | 
| Id | Grade | Path(s) | Description | Expression | 
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources | contained.contained.empty() | 
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | 
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | 
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label | contained.meta.security.empty() | 
| dom-6 | best practice | Provenance | A resource should have narrative for robust management | text.`div`.exists() | 
| 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() | 
Differential View
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
|    target | S | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) | 
|    occurred[x] | S | 0..1 | Period, dateTime | When the activity occurred | 
|    Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by value:$this | |
|     reason:AIReason | 1..* | CodeableConcept | Reason the activity is occurring Binding: Recommended provenance codes (required) | |
|    Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who | |
|     agent:AIModelAgent | 1..* | BackboneElement | Actor involved | |
|      who | 1..1 | Reference(AI Device) | Who participated | |
|    Slices for entity | 0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what | |
|     entity:AIInputData | 0..* | BackboneElement | An entity used in this activity | |
|      what | 1..1 | Reference(AI Model Card DocumentReference) | Identity of entity | |
|  Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Provenance.reason:AIReason | Base | required | Recommended provenance codes | 📦0.1.0 | This IG | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
|   Provenance | 0..* | Provenance | Who, What, When for a set of resources | |||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    target | SΣ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) | ||||
|    occurred[x] | S | 0..1 | When the activity occurred | |||||
|     occurredPeriod | Period | |||||||
|     occurredDateTime | dateTime | |||||||
|    recorded | Σ | 1..1 | instant | When the activity was recorded / updated | ||||
|    policy | 0..* | uri | Policy or plan the activity was defined by | |||||
|    location | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
|    Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by value:$this Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
|     reason:AIReason | 1..* | CodeableConcept | Reason the activity is occurring Binding: Recommended provenance codes (required) | |||||
|    activity | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
|    Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who | |||||
|     agent:All Slices | Content/Rules for all slices | |||||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|      type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | ||||
|      role | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
|      who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | ||||
|      onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
|     agent:AIModelAgent | 1..* | BackboneElement | Actor involved | |||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|      type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | ||||
|      role | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
|      who | Σ | 1..1 | Reference(AI Device) | Who participated | ||||
|      onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
|    Slices for entity | 0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what | |||||
|     entity:All Slices | Content/Rules for all slices | |||||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|      role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
|      what | Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
|      agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
|     entity:AIInputData | 0..* | BackboneElement | An entity used in this activity | |||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|      role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
|      what | Σ | 1..1 | Reference(AI Model Card DocumentReference) | Identity of entity | ||||
|      agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
|    signature | 0..* | Signature | Signature on target | |||||
|  Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. | 
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.5 | 
| Provenance.reason:AIReason | Base | required | Recommended provenance codes | 📦0.1.0 | This IG | 
| Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std. | 
| Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. | 
| Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. | 
| Provenance.agent:AIModelAgent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. | 
| Provenance.agent:AIModelAgent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. | 
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. | 
| Provenance.entity:AIInputData.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. | 
| Id | Grade | Path(s) | Description | Expression | 
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources | contained.contained.empty() | 
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | 
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | 
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label | contained.meta.security.empty() | 
| dom-6 | best practice | Provenance | A resource should have narrative for robust management | text.`div`.exists() | 
| 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() | 
This structure is derived from Provenance
Summary
Mandatory: 3 elements
 Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron