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
| Official URL: http://hl7.org/fhir/uv/aitransparency/StructureDefinition/AI-Provenance | Version: 1.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AIProvenance | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.79.42.4 | |||||
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 Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Provenance |
C | 0..* | Provenance | Who, What, When for a set of resources Constraints: ai-target-aiast |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 target |
1..* | Reference(Resource) | Target Reference(s) (usually version specific) | |
  occurred[x] |
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 (3.1.0) (extensible): The reason the activity took place. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  reason:AIReason |
1..1 | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place. Required Pattern: At least the following | |
  id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AIAST | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
 text |
0..1 | string | Plain text representation of the concept | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  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:AIagent |
1..* | BackboneElement | Actor involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | |
| Slices for role |
1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:$this Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for role |
Content/Rules for all slices | |||
| role:AIrole |
1..1 | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/aitransparency/CodeSystem/AIdeviceTypeCS | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Artificial-Intelligence | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| who |
1..1 | Reference(AI Device) | Who participated | |
| agent:Humanagent |
0..* | BackboneElement | Actor involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient) | Who participated | |
 Slices for entity |
0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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:modelCard |
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. Fixed Value: derivation | |
| what |
1..1 | Reference(AI Model-Card DocumentReference) | Identity of entity | |
| entity:inputPrompt |
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. Fixed Value: derivation | |
| what |
1..1 | Reference(AI Input Prompt DocumentReference) | Identity of entity | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| Provenance.reason:AIReason | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| Provenance.agent:AIagent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent:AIagent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:AIagent.role:AIrole | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:Humanagent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.entity:modelCard.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.entity:inputPrompt.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ai-target-aiast | warning | Provenance | Every target resource shall be labeled with the AIAST (Artificial Intelligence asserted) security label. |
target.all(resolve().empty() or resolve().meta.security.where(system = 'http://terminology.hl7.org/CodeSystem/v3-ObservationValue' and code = 'AIAST').exists())
|
| 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 |
C | 0..* | Provenance | Who, What, When for a set of resources Constraints: ai-target-aiast |
| target |
1..* | Reference(Resource) | Target Reference(s) (usually version specific) | |
| occurred[x] |
0..1 | Period, dateTime | When the activity occurred | |
| Slices for reason |
1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| reason:AIReason |
1..1 | CodeableConcept | Reason the activity is occurring Required Pattern: At least the following | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AIAST | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:AIagent |
1..* | BackboneElement | Actor involved | |
| type |
1..1 | CodeableConcept | How the agent participated | |
| Slices for role |
1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for role |
Content/Rules for all slices | |||
| role:AIrole |
1..1 | CodeableConcept | What the agents role was Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/aitransparency/CodeSystem/AIdeviceTypeCS | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Artificial-Intelligence | |
| who |
1..1 | Reference(AI Device) | Who participated | |
| agent:Humanagent |
0..* | BackboneElement | Actor involved | |
| type |
1..1 | CodeableConcept | How the agent participated | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient) | Who participated | |
| Slices for entity |
0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| entity:All Slices |
Content/Rules for all slices | |||
| what |
1..1 | Reference(Resource) | Identity of entity | |
| entity:modelCard |
0..* | BackboneElement | An entity used in this activity | |
| role |
1..1 | code | derivation | revision | quotation | source | removal Fixed Value: derivation | |
| what |
1..1 | Reference(AI Model-Card DocumentReference) | Identity of entity | |
| entity:inputPrompt |
0..* | BackboneElement | An entity used in this activity | |
| role |
1..1 | code | derivation | revision | quotation | source | removal Fixed Value: derivation | |
| what |
1..1 | Reference(AI Input Prompt DocumentReference) | Identity of entity | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ai-target-aiast | warning | Provenance | Every target resource shall be labeled with the AIAST (Artificial Intelligence asserted) security label. |
target.all(resolve().empty() or resolve().meta.security.where(system = 'http://terminology.hl7.org/CodeSystem/v3-ObservationValue' and code = 'AIAST').exists())
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
C | 0..* | Provenance | Who, What, When for a set of resources Constraints: ai-target-aiast | ||||
| 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 |
1..* | Reference(Resource) | Target Reference(s) (usually version specific) | |||||
| occurred[x] |
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 (3.1.0) (extensible): The reason the activity took place. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| reason:AIReason |
1..1 | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AIAST | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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:AIagent |
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 |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | |||||
| Slices for role |
1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:$this Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for role |
Content/Rules for all slices | |||||||
| role:AIrole |
1..1 | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/aitransparency/CodeSystem/AIdeviceTypeCS | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Artificial-Intelligence | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| who |
1..1 | Reference(AI Device) | Who participated | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| agent:Humanagent |
0..* | 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 |
1..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) | 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.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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:modelCard |
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. Fixed Value: derivation | |||||
| what |
1..1 | Reference(AI Model-Card DocumentReference) | Identity of entity | |||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| entity:inputPrompt |
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. Fixed Value: derivation | |||||
| what |
1..1 | Reference(AI Input Prompt 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 v7.4 |
| Provenance.reason:AIReason | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| 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:AIagent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent:AIagent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:AIagent.role:AIrole | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:Humanagent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent:Humanagent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.entity:modelCard.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.entity:inputPrompt.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ai-target-aiast | warning | Provenance | Every target resource shall be labeled with the AIAST (Artificial Intelligence asserted) security label. |
target.all(resolve().empty() or resolve().meta.security.where(system = 'http://terminology.hl7.org/CodeSystem/v3-ObservationValue' and code = 'AIAST').exists())
|
| 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: 6 elements(1 nested mandatory element)
Must-Support: 10 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
C | 0..* | Provenance | Who, What, When for a set of resources Constraints: ai-target-aiast |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| target |
1..* | Reference(Resource) | Target Reference(s) (usually version specific) | |
| occurred[x] |
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 (3.1.0) (extensible): The reason the activity took place. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| reason:AIReason |
1..1 | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AIAST | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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:AIagent |
1..* | BackboneElement | Actor involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | |
| Slices for role |
1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:$this Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for role |
Content/Rules for all slices | |||
| role:AIrole |
1..1 | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/aitransparency/CodeSystem/AIdeviceTypeCS | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Artificial-Intelligence | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| who |
1..1 | Reference(AI Device) | Who participated | |
| agent:Humanagent |
0..* | BackboneElement | Actor involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient) | Who participated | |
| Slices for entity |
0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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:modelCard |
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. Fixed Value: derivation | |
| what |
1..1 | Reference(AI Model-Card DocumentReference) | Identity of entity | |
| entity:inputPrompt |
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. Fixed Value: derivation | |
| what |
1..1 | Reference(AI Input Prompt DocumentReference) | Identity of entity | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| Provenance.reason:AIReason | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| Provenance.agent:AIagent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent:AIagent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:AIagent.role:AIrole | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:Humanagent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.entity:modelCard.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.entity:inputPrompt.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ai-target-aiast | warning | Provenance | Every target resource shall be labeled with the AIAST (Artificial Intelligence asserted) security label. |
target.all(resolve().empty() or resolve().meta.security.where(system = 'http://terminology.hl7.org/CodeSystem/v3-ObservationValue' and code = 'AIAST').exists())
|
| 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 |
C | 0..* | Provenance | Who, What, When for a set of resources Constraints: ai-target-aiast |
| target |
1..* | Reference(Resource) | Target Reference(s) (usually version specific) | |
| occurred[x] |
0..1 | Period, dateTime | When the activity occurred | |
| Slices for reason |
1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| reason:AIReason |
1..1 | CodeableConcept | Reason the activity is occurring Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AIAST | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by profile:who.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:AIagent |
1..* | BackboneElement | Actor involved | |
| type |
1..1 | CodeableConcept | How the agent participated | |
| Slices for role |
1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for role |
Content/Rules for all slices | |||
| role:AIrole |
1..1 | CodeableConcept | What the agents role was Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/aitransparency/CodeSystem/AIdeviceTypeCS | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Artificial-Intelligence | |
| who |
1..1 | Reference(AI Device) | Who participated | |
| agent:Humanagent |
0..* | BackboneElement | Actor involved | |
| type |
1..1 | CodeableConcept | How the agent participated | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient) | Who participated | |
| Slices for entity |
0..* | BackboneElement | An entity used in this activity Slice: Unordered, Open by profile:what.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| entity:All Slices |
Content/Rules for all slices | |||
| what |
1..1 | Reference(Resource) | Identity of entity | |
| entity:modelCard |
0..* | BackboneElement | An entity used in this activity | |
| role |
1..1 | code | derivation | revision | quotation | source | removal Fixed Value: derivation | |
| what |
1..1 | Reference(AI Model-Card DocumentReference) | Identity of entity | |
| entity:inputPrompt |
0..* | BackboneElement | An entity used in this activity | |
| role |
1..1 | code | derivation | revision | quotation | source | removal Fixed Value: derivation | |
| what |
1..1 | Reference(AI Input Prompt DocumentReference) | Identity of entity | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ai-target-aiast | warning | Provenance | Every target resource shall be labeled with the AIAST (Artificial Intelligence asserted) security label. |
target.all(resolve().empty() or resolve().meta.security.where(system = 'http://terminology.hl7.org/CodeSystem/v3-ObservationValue' and code = 'AIAST').exists())
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
C | 0..* | Provenance | Who, What, When for a set of resources Constraints: ai-target-aiast | ||||
| 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 |
1..* | Reference(Resource) | Target Reference(s) (usually version specific) | |||||
| occurred[x] |
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 (3.1.0) (extensible): The reason the activity took place. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| reason:AIReason |
1..1 | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AIAST | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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:AIagent |
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 |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | |||||
| Slices for role |
1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:$this Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for role |
Content/Rules for all slices | |||||||
| role:AIrole |
1..1 | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/aitransparency/CodeSystem/AIdeviceTypeCS | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Artificial-Intelligence | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| who |
1..1 | Reference(AI Device) | Who participated | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| agent:Humanagent |
0..* | 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 |
1..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) | 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.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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:modelCard |
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. Fixed Value: derivation | |||||
| what |
1..1 | Reference(AI Model-Card DocumentReference) | Identity of entity | |||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| entity:inputPrompt |
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. Fixed Value: derivation | |||||
| what |
1..1 | Reference(AI Input Prompt 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 v7.4 |
| Provenance.reason:AIReason | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| 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:AIagent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent:AIagent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:AIagent.role:AIrole | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:Humanagent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent:Humanagent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.entity:modelCard.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.entity:inputPrompt.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ai-target-aiast | warning | Provenance | Every target resource shall be labeled with the AIAST (Artificial Intelligence asserted) security label. |
target.all(resolve().empty() or resolve().meta.security.where(system = 'http://terminology.hl7.org/CodeSystem/v3-ObservationValue' and code = 'AIAST').exists())
|
| 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: 6 elements(1 nested mandatory element)
Must-Support: 10 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Electronic Health Records.
Package hl7.fhir.uv.aitransparency#1.0.0-current based on FHIR 4.0.1.
Generated
2026-10-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change