Soigneur FHIR Implementation Guide
0.1.0 - ci-build
Soigneur FHIR Implementation Guide
0.1.0 - ci-build
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
| Official URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-consent | Version: 0.1.0 | |||
| Draft as of 2026-11-14 | Computable Name: CcConsent | |||
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. |
||||
A versioned, hashed consent record captured at onboarding (ADR 0034; doc 14 4.1; 09 3/§14). Written server-side by the BFF using the athlete's own token (the athlete is the grantor). category is the consent type (Terms of Service and Privacy Policy are separate, independently-versioned records); policy.uri (url#version) pins the operative document version (and satisfies R4 ppc-1); the cc-ext-consent-text extension records the exact shown text's version, effective date, and SHA-256 hash so a wording/version change re-prompts on next login.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:consentText |
1..1 | (Complex) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-consent-text | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |
 scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Soigneur consent type (extensible) | |
 patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| dateTime |
1..1 | dateTime | When this Consent was created or indexed | |
 policy |
1..1 | BackboneElement | Policies covered by this consent | |
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.status | Base | required | ConsentState | 📍4.0.1 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.0.1 | FHIR Std. |
| Consent.category | Base | extensible | Soigneur consent type | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Beschreibung | Expression |
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:consentText |
1..1 | (Complex) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-consent-text | |
 category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Soigneur consent type (extensible) | |
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| dateTime |
1..1 | dateTime | When this Consent was created or indexed | |
| policy |
1..1 | BackboneElement | Policies covered by this consent | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.category | Base | extensible | Soigneur consent type | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | ||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:consentText |
1..1 | (Complex) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-consent-text | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier for this record (external references) Beispiel General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | |||||
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |||||
| scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |||||
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Soigneur consent type (extensible) | |||||
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |||||
| dateTime |
1..1 | dateTime | When this Consent was created or indexed | |||||
| performer |
0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |||||
| organization |
0..* | Reference(Organization) | Custodian of the consent | |||||
 source[x] |
0..1 | Source from which this consent is taken | ||||||
| sourceAttachment |
Attachment | |||||||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy |
1..1 | BackboneElement | Policies covered by this consent | |||||
| 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 | |||||
| authority |
C | 0..1 | uri | Enforcement source for policy | ||||
| uri |
C | 0..1 | uri | Specific policy covered by this consent | ||||
| policyRule |
C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| verification |
0..* | BackboneElement | Consent Verified by patient or family | |||||
| 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 | |||||
| verified |
1..1 | boolean | Has been verified | |||||
| verifiedWith |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
| verificationDate |
0..1 | dateTime | When consent verified | |||||
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |||||
| 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 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | |||||
| period |
0..1 | Period | Timeframe for this rule | |||||
| actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
| 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 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| action |
0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | |||||
| securityLabel |
0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| purpose |
0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | |||||
| class |
0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||
| code |
0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | |||||
| dataPeriod |
0..1 | Period | Timeframe for data controlled by this rule | |||||
| data |
0..* | BackboneElement | Data controlled by this rule | |||||
| 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 | |||||
| meaning |
1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | |||||
| reference |
1..1 | Reference(Resource) | The actual data reference | |||||
| provision |
0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Consent.status | Base | required | ConsentState | 📍4.0.1 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.0.1 | FHIR Std. |
| Consent.category | Base | extensible | Soigneur consent type | 📦0.1.0 | This IG |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.type | Base | required | ConsentProvisionType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.role | Base | extensible | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Consent.provision.purpose | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.5 |
| Consent.provision.class | Base | extensible | Consent Content Class | 📍4.0.1 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Beschreibung | Expression |
This structure is derived from Consent
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:consentText |
1..1 | (Complex) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-consent-text | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |
| scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Soigneur consent type (extensible) | |
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| dateTime |
1..1 | dateTime | When this Consent was created or indexed | |
| policy |
1..1 | BackboneElement | Policies covered by this consent | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.status | Base | required | ConsentState | 📍4.0.1 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.0.1 | FHIR Std. |
| Consent.category | Base | extensible | Soigneur consent type | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Beschreibung | Expression |
Differential View
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:consentText |
1..1 | (Complex) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-consent-text | |
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Soigneur consent type (extensible) | |
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| dateTime |
1..1 | dateTime | When this Consent was created or indexed | |
| policy |
1..1 | BackboneElement | Policies covered by this consent | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.category | Base | extensible | Soigneur consent type | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | ||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:consentText |
1..1 | (Complex) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-consent-text | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier for this record (external references) Beispiel General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | |||||
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |||||
| scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |||||
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Soigneur consent type (extensible) | |||||
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |||||
| dateTime |
1..1 | dateTime | When this Consent was created or indexed | |||||
| performer |
0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |||||
| organization |
0..* | Reference(Organization) | Custodian of the consent | |||||
| source[x] |
0..1 | Source from which this consent is taken | ||||||
| sourceAttachment |
Attachment | |||||||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy |
1..1 | BackboneElement | Policies covered by this consent | |||||
| 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 | |||||
| authority |
C | 0..1 | uri | Enforcement source for policy | ||||
| uri |
C | 0..1 | uri | Specific policy covered by this consent | ||||
| policyRule |
C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| verification |
0..* | BackboneElement | Consent Verified by patient or family | |||||
| 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 | |||||
| verified |
1..1 | boolean | Has been verified | |||||
| verifiedWith |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
| verificationDate |
0..1 | dateTime | When consent verified | |||||
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |||||
| 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 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | |||||
| period |
0..1 | Period | Timeframe for this rule | |||||
| actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
| 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 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| action |
0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | |||||
| securityLabel |
0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| purpose |
0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | |||||
| class |
0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||
| code |
0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | |||||
| dataPeriod |
0..1 | Period | Timeframe for data controlled by this rule | |||||
| data |
0..* | BackboneElement | Data controlled by this rule | |||||
| 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 | |||||
| meaning |
1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | |||||
| reference |
1..1 | Reference(Resource) | The actual data reference | |||||
| provision |
0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Consent.status | Base | required | ConsentState | 📍4.0.1 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.0.1 | FHIR Std. |
| Consent.category | Base | extensible | Soigneur consent type | 📦0.1.0 | This IG |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.type | Base | required | ConsentProvisionType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.role | Base | extensible | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Consent.provision.purpose | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.5 |
| Consent.provision.class | Base | extensible | Consent Content Class | 📍4.0.1 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Beschreibung | Expression |
This structure is derived from Consent
Other representations of profile: CSV, Excel, Schematron