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: Workout Debrief (DocumentReference)

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

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.

The coach's formal debrief of a completed session (ADR 0062/0093): authored by the coaching agent (Device) after the athlete submits their session assessment. type is the LOINC progress-note code; content carries the debrief markdown; context.related links the note back to the Activity Group Observation(s) it comments on. A stable identifier debrief {activityId} makes the write idempotent per activity.

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
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: cc-inv-debrief-identifier
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier debrief|{activityId} — idempotent review write (ADR 0093)
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
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://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11505-5
..... 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
... subject Σ 1..1 Reference(Soigneur Athlete (Patient)) The athlete
... content Σ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment The debrief note (text/markdown or plain text)
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
... context Σ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... related 1..* Reference(Activity Group Observation) Activity Group Observation(s) this debrief comments on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cc-inv-debrief-identifier error DocumentReference A workout debrief must carry a stable debrief|{activityId} identifier so the review write is idempotent per activity (ADR 0062/0093). identifier.value.exists() and identifier.value.startsWith('debrief|')

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: cc-inv-debrief-identifier
... identifier 1..1 Identifier debrief|{activityId} — idempotent review write (ADR 0093)
... type 1..1 CodeableConcept Kind of document (LOINC if possible)
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://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11505-5
... subject 1..1 Reference(Soigneur Athlete (Patient)) The athlete
.... attachment 1..1 Attachment The debrief note (text/markdown or plain text)
..... contentType 1..1 code Mime type of the content, with charset etc.
... context 1..1 BackboneElement Clinical context of document
.... related 1..* Reference(Activity Group Observation) Activity Group Observation(s) this debrief comments on

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
cc-inv-debrief-identifier error DocumentReference A workout debrief must carry a stable debrief|{activityId} identifier so the review write is idempotent per activity (ADR 0062/0093). identifier.value.exists() and identifier.value.startsWith('debrief|')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: cc-inv-debrief-identifier
... 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
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 1..1 Identifier debrief|{activityId} — idempotent review write (ADR 0093)
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
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://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11505-5
..... 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
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 1..1 Reference(Soigneur Athlete (Patient)) The athlete
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... 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
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content Σ 1..1 BackboneElement Document referenced
.... 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
.... attachment Σ 1..1 Attachment The debrief note (text/markdown or plain text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context Σ 1..1 BackboneElement Clinical context of document
.... 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
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 1..* Reference(Activity Group Observation) Activity Group Observation(s) this debrief comments on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.3
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cc-inv-debrief-identifier error DocumentReference A workout debrief must carry a stable debrief|{activityId} identifier so the review write is idempotent per activity (ADR 0062/0093). identifier.value.exists() and identifier.value.startsWith('debrief|')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: cc-inv-debrief-identifier
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier debrief|{activityId} — idempotent review write (ADR 0093)
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
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://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11505-5
..... 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
... subject Σ 1..1 Reference(Soigneur Athlete (Patient)) The athlete
... content Σ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment The debrief note (text/markdown or plain text)
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
... context Σ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... related 1..* Reference(Activity Group Observation) Activity Group Observation(s) this debrief comments on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cc-inv-debrief-identifier error DocumentReference A workout debrief must carry a stable debrief|{activityId} identifier so the review write is idempotent per activity (ADR 0062/0093). identifier.value.exists() and identifier.value.startsWith('debrief|')

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: cc-inv-debrief-identifier
... identifier 1..1 Identifier debrief|{activityId} — idempotent review write (ADR 0093)
... type 1..1 CodeableConcept Kind of document (LOINC if possible)
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://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11505-5
... subject 1..1 Reference(Soigneur Athlete (Patient)) The athlete
.... attachment 1..1 Attachment The debrief note (text/markdown or plain text)
..... contentType 1..1 code Mime type of the content, with charset etc.
... context 1..1 BackboneElement Clinical context of document
.... related 1..* Reference(Activity Group Observation) Activity Group Observation(s) this debrief comments on

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
cc-inv-debrief-identifier error DocumentReference A workout debrief must carry a stable debrief|{activityId} identifier so the review write is idempotent per activity (ADR 0062/0093). identifier.value.exists() and identifier.value.startsWith('debrief|')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: cc-inv-debrief-identifier
... 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
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 1..1 Identifier debrief|{activityId} — idempotent review write (ADR 0093)
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
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://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11505-5
..... 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
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 1..1 Reference(Soigneur Athlete (Patient)) The athlete
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... 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
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content Σ 1..1 BackboneElement Document referenced
.... 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
.... attachment Σ 1..1 Attachment The debrief note (text/markdown or plain text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context Σ 1..1 BackboneElement Clinical context of document
.... 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
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 1..* Reference(Activity Group Observation) Activity Group Observation(s) this debrief comments on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.3
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cc-inv-debrief-identifier error DocumentReference A workout debrief must carry a stable debrief|{activityId} identifier so the review write is idempotent per activity (ADR 0062/0093). identifier.value.exists() and identifier.value.startsWith('debrief|')

 

Other representations of profile: CSV, Excel, Schematron