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: Onboarding-capture Provenance (Provenance)

Official URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-onboarding-provenance Version: 0.1.0
Draft as of 2026-11-14 Computable Name: CcOnboardingProvenance

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.

Stamps the resources written by the consent-gated onboarding transaction Bundle (ADR 0040 / ADR 0041). Its presence is the onboarding completion signal, replacing QuestionnaireResponse.status = completed: an abandoned interview writes nothing and leaves no Provenance, so onboarding simply restarts. activity = onboarding-capture; the author is the coach agent Device acting as a mechanical scribe under the athlete's own compartment-scoped token; target lists every resource the interview wrote.

Usages:

  • This Profil is not used by any profiles in this Specification

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: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Provenance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Provenance.target This element is included in summaries. 1..* Reference(Resource) Every resource written by the onboarding Bundle
Provenance.recorded This element is included in summaries. 1..1 instant When the activity was recorded / updated
Provenance.activity 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://fhir.soigneur.coach/fhir/CodeSystem/cc-provenance-activity",
      "code" : "onboarding-capture"
    }
  ]
}
Provenance.Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
Provenance.Slices for agent.agent:All Slices Content/Rules for all slices
Provenance.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:All Slices.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.Slices for agent.agent:author 1..1 BackboneElement Actor involved
Provenance.Slices for agent.agent:author.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:author.type This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:author.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The coach agent Device (scribe) or the athlete (Patient)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.activity Base extensible Provenance activity type 📍4.0.1 FHIR Std.
Provenance.agent:author.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Beschreibung Expression

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.target 1..* Reference(Resource) Every resource written by the onboarding Bundle
Provenance.activity 1..1 CodeableConcept Activity that occurred
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://fhir.soigneur.coach/fhir/CodeSystem/cc-provenance-activity",
      "code" : "onboarding-capture"
    }
  ]
}
Provenance.Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
Provenance.Slices for agent.agent:author 1..1 BackboneElement Actor involved
Provenance.Slices for agent.agent:author.type 1..1 CodeableConcept How the agent participated
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:author.who 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The coach agent Device (scribe) or the athlete (Patient)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.id This element is included in summaries. 0..1 id Logical id of this artifact
Provenance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Provenance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Provenance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Provenance.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
Provenance.contained 0..* Resource Contained, inline Resources
Provenance.extension 0..* Extension Additional content defined by implementations
Provenance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Provenance.target This element is included in summaries. 1..* Reference(Resource) Every resource written by the onboarding Bundle
Provenance.occurred[x] 0..1 When the activity occurred
Provenance.occurred[x].occurredPeriod Period
Provenance.occurred[x].occurredDateTime dateTime
Provenance.recorded This element is included in summaries. 1..1 instant When the activity was recorded / updated
Provenance.policy 0..* uri Policy or plan the activity was defined by
Provenance.location 0..1 Reference(Location) Where the activity occurred, if relevant
Provenance.reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.
Provenance.activity 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://fhir.soigneur.coach/fhir/CodeSystem/cc-provenance-activity",
      "code" : "onboarding-capture"
    }
  ]
}
Provenance.Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
Provenance.Slices for agent.agent:All Slices Content/Rules for all slices
Provenance.Slices for agent.agent:All Slices.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:All Slices.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:All Slices.type This element is included in summaries. 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Provenance.Slices for agent.agent:All Slices.role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
Provenance.Slices for agent.agent:All Slices.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.Slices for agent.agent:All Slices.onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
Provenance.Slices for agent.agent:author 1..1 BackboneElement Actor involved
Provenance.Slices for agent.agent:author.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:author.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:author.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:author.type This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:author.role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
Provenance.Slices for agent.agent:author.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The coach agent Device (scribe) or the athlete (Patient)
Provenance.Slices for agent.agent:author.onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
Provenance.entity 0..* BackboneElement An entity used in this activity
Provenance.entity.id 0..1 string Unique id for inter-element referencing
Provenance.entity.extension 0..* Extension Additional content defined by implementations
Provenance.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.entity.role This element is included in summaries. 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
Provenance.entity.what This element is included in summaries. 1..1 Reference(Resource) Identity of entity
Provenance.entity.agent 0..* See agent (Provenance) Entity is attributed to this agent
Provenance.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.5
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: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.

Constraints

Id Grade Path(s) Beschreibung Expression

This structure is derived from Provenance

Summary

Mandatory: 3 elements

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Provenance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Provenance.target This element is included in summaries. 1..* Reference(Resource) Every resource written by the onboarding Bundle
Provenance.recorded This element is included in summaries. 1..1 instant When the activity was recorded / updated
Provenance.activity 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://fhir.soigneur.coach/fhir/CodeSystem/cc-provenance-activity",
      "code" : "onboarding-capture"
    }
  ]
}
Provenance.Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
Provenance.Slices for agent.agent:All Slices Content/Rules for all slices
Provenance.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:All Slices.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.Slices for agent.agent:author 1..1 BackboneElement Actor involved
Provenance.Slices for agent.agent:author.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:author.type This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:author.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The coach agent Device (scribe) or the athlete (Patient)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.activity Base extensible Provenance activity type 📍4.0.1 FHIR Std.
Provenance.agent:author.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Beschreibung Expression

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.target 1..* Reference(Resource) Every resource written by the onboarding Bundle
Provenance.activity 1..1 CodeableConcept Activity that occurred
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://fhir.soigneur.coach/fhir/CodeSystem/cc-provenance-activity",
      "code" : "onboarding-capture"
    }
  ]
}
Provenance.Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
Provenance.Slices for agent.agent:author 1..1 BackboneElement Actor involved
Provenance.Slices for agent.agent:author.type 1..1 CodeableConcept How the agent participated
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:author.who 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The coach agent Device (scribe) or the athlete (Patient)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.id This element is included in summaries. 0..1 id Logical id of this artifact
Provenance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Provenance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Provenance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Provenance.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
Provenance.contained 0..* Resource Contained, inline Resources
Provenance.extension 0..* Extension Additional content defined by implementations
Provenance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Provenance.target This element is included in summaries. 1..* Reference(Resource) Every resource written by the onboarding Bundle
Provenance.occurred[x] 0..1 When the activity occurred
Provenance.occurred[x].occurredPeriod Period
Provenance.occurred[x].occurredDateTime dateTime
Provenance.recorded This element is included in summaries. 1..1 instant When the activity was recorded / updated
Provenance.policy 0..* uri Policy or plan the activity was defined by
Provenance.location 0..1 Reference(Location) Where the activity occurred, if relevant
Provenance.reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.
Provenance.activity 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://fhir.soigneur.coach/fhir/CodeSystem/cc-provenance-activity",
      "code" : "onboarding-capture"
    }
  ]
}
Provenance.Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
Provenance.Slices for agent.agent:All Slices Content/Rules for all slices
Provenance.Slices for agent.agent:All Slices.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:All Slices.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:All Slices.type This element is included in summaries. 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Provenance.Slices for agent.agent:All Slices.role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
Provenance.Slices for agent.agent:All Slices.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.Slices for agent.agent:All Slices.onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
Provenance.Slices for agent.agent:author 1..1 BackboneElement Actor involved
Provenance.Slices for agent.agent:author.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:author.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:author.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:author.type This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:author.role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
Provenance.Slices for agent.agent:author.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The coach agent Device (scribe) or the athlete (Patient)
Provenance.Slices for agent.agent:author.onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
Provenance.entity 0..* BackboneElement An entity used in this activity
Provenance.entity.id 0..1 string Unique id for inter-element referencing
Provenance.entity.extension 0..* Extension Additional content defined by implementations
Provenance.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.entity.role This element is included in summaries. 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
Provenance.entity.what This element is included in summaries. 1..1 Reference(Resource) Identity of entity
Provenance.entity.agent 0..* See agent (Provenance) Entity is attributed to this agent
Provenance.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.5
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: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.

Constraints

Id Grade Path(s) Beschreibung Expression

This structure is derived from Provenance

Summary

Mandatory: 3 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron