Soigneur FHIR Implementation Guide
0.1.0 - ci-build Germany flag

Soigneur FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Ingestion / Translation Provenance (Provenance)

Official URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-translation-provenance Version: 0.1.0
Draft as of 2026-09-08 Computable Name: CcTranslationProvenance

Copyright/Legal: Copyright (c) Soigneur. Licensed under CC0-1.0 (public domain dedication). FHIR(R) is the registered trademark of HL7 and is used with permission.

Provenance for the ingestion / authoring chain (04 13 / 13 /

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Σ 1..* Reference(Resource) Resource(s) this provenance explains
... activity 1..1 CodeableConcept download / translate / re-translate / merge / push / coach-write / athlete-write / migration
Binding: Provenance activity (required)
... Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
.... 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:author 1..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.
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/provenance-participant-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
....... 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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Translator/coach Device, or the athlete (Patient), depending on activity
... Slices for entity 0..* BackboneElement An entity used in this activity
Slice: Unordered, Open by value:role
.... 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:source 0..1 BackboneElement The raw provider Binary a translation derived from
..... 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.
Required Pattern: source
..... what Σ 1..1 Reference(Raw Provider Artifact (Binary)) Identity of entity

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.activity Base required Provenance activity 📦0.1.0 This IG
Provenance.agent:author.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.
Provenance.entity:source.​role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target 1..* Reference(Resource) Resource(s) this provenance explains
... activity 1..1 CodeableConcept download / translate / re-translate / merge / push / coach-write / athlete-write / migration
Binding: Provenance activity (required)
... Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
.... agent:author 1..1 BackboneElement Actor involved
..... type 1..1 CodeableConcept How the agent participated
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/provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
..... who 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Translator/coach Device, or the athlete (Patient), depending on activity
.... entity:source 0..1 BackboneElement The raw provider Binary a translation derived from
..... role 1..1 code derivation | revision | quotation | source | removal
Required Pattern: source
..... what 1..1 Reference(Raw Provider Artifact (Binary)) Identity of entity

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Provenance.activity Base required Provenance activity 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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) Resource(s) this provenance explains
... 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
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.
... activity 1..1 CodeableConcept download / translate / re-translate / merge / push / coach-write / athlete-write / migration
Binding: Provenance activity (required)
... Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
.... 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:author 1..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.
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/provenance-participant-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
....... 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
..... 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) Translator/coach Device, or the athlete (Patient), depending on activity
..... 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 value:role
.... 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:source 0..1 BackboneElement The raw provider Binary a translation derived from
..... 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.
Required Pattern: source
..... what Σ 1..1 Reference(Raw Provider Artifact (Binary)) Identity of entity
..... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature 0..* Signature Signature on target

doco Documentation for this format

Terminology Bindings

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.3
Provenance.activity Base required Provenance activity 📦0.1.0 This IG
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:author.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent:author.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.
Provenance.entity:source.​role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Provenance

Summary

Mandatory: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Provenance.agent
  • The element 1 is sliced based on the value of Provenance.entity

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Σ 1..* Reference(Resource) Resource(s) this provenance explains
... activity 1..1 CodeableConcept download / translate / re-translate / merge / push / coach-write / athlete-write / migration
Binding: Provenance activity (required)
... Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
.... 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:author 1..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.
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/provenance-participant-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
....... 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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Translator/coach Device, or the athlete (Patient), depending on activity
... Slices for entity 0..* BackboneElement An entity used in this activity
Slice: Unordered, Open by value:role
.... 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:source 0..1 BackboneElement The raw provider Binary a translation derived from
..... 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.
Required Pattern: source
..... what Σ 1..1 Reference(Raw Provider Artifact (Binary)) Identity of entity

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.activity Base required Provenance activity 📦0.1.0 This IG
Provenance.agent:author.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.
Provenance.entity:source.​role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target 1..* Reference(Resource) Resource(s) this provenance explains
... activity 1..1 CodeableConcept download / translate / re-translate / merge / push / coach-write / athlete-write / migration
Binding: Provenance activity (required)
... Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
.... agent:author 1..1 BackboneElement Actor involved
..... type 1..1 CodeableConcept How the agent participated
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/provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
..... who 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Translator/coach Device, or the athlete (Patient), depending on activity
.... entity:source 0..1 BackboneElement The raw provider Binary a translation derived from
..... role 1..1 code derivation | revision | quotation | source | removal
Required Pattern: source
..... what 1..1 Reference(Raw Provider Artifact (Binary)) Identity of entity

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Provenance.activity Base required Provenance activity 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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) Resource(s) this provenance explains
... 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
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.
... activity 1..1 CodeableConcept download / translate / re-translate / merge / push / coach-write / athlete-write / migration
Binding: Provenance activity (required)
... Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
.... 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:author 1..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.
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/provenance-participant-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
....... 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
..... 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) Translator/coach Device, or the athlete (Patient), depending on activity
..... 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 value:role
.... 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:source 0..1 BackboneElement The raw provider Binary a translation derived from
..... 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.
Required Pattern: source
..... what Σ 1..1 Reference(Raw Provider Artifact (Binary)) Identity of entity
..... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature 0..* Signature Signature on target

doco Documentation for this format

Terminology Bindings

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.3
Provenance.activity Base required Provenance activity 📦0.1.0 This IG
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:author.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent:author.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.
Provenance.entity:source.​role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Provenance

Summary

Mandatory: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Provenance.agent
  • The element 1 is sliced based on the value of Provenance.entity

 

Other representations of profile: CSV, Excel, Schematron