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-athlete-message | Version: 0.1.0 | |||
| Draft as of 2026-09-08 | Computable Name: CcAthleteMessage | |||
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. |
||||
An athlete-facing message: outbound email delivery (invitation/reminder) or an in-app coach-ask turn / chat-notice (category cc-comm:llm-turn / chat-notice, ADR 0044). category is required; medium is email for outbound delivery and in-app for chat capture; partOf may carry an idempotency parent for email sends.
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | code | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-message-role Binding: In-app chat message role (required) | |
![]() ![]() ![]() |
0..1 | (Complex) | Billed OpenRouter usage that produced this coach turn (ADR 0088) URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-llm-usage | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier | Conversation thread + per-turn idempotency keys (ADR 0044) |
![]() ![]() |
Σ | 0..* | Reference(Resource) | Idempotency parent — the send this turn belongs to (email de-dup) |
![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
![]() ![]() |
1..* | CodeableConcept | Message kind — llm-turn / chat-notice / invitation / reminder; headers also carry conversation-header + thread-* Binding: Athlete communication category (required) | |
![]() ![]() |
1..* | CodeableConcept | A channel of communication Slice: Unordered, Open by pattern:$this Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Email delivery channel (outbound ACS path) Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationMode | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: EMAILWRIT | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
0..1 | CodeableConcept | In-app coach chat (no ACS) Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.soigneur.coach/fhir/CodeSystem/cc-comm | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: in-app | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
Σ | 1..1 | Reference(Soigneur Athlete (Patient)) | The athlete |
![]() ![]() |
0..* | Reference(Soigneur Athlete (Patient)) | Message recipient | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | required | Athlete communication category | 📦0.1.0 | This IG |
| Communication.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.medium:email | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.medium:inApp | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | code | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-message-role Binding: In-app chat message role (required) | |
![]() ![]() ![]() |
0..1 | (Complex) | Billed OpenRouter usage that produced this coach turn (ADR 0088) URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-llm-usage | |
![]() ![]() |
0..* | Identifier | Conversation thread + per-turn idempotency keys (ADR 0044) | |
![]() ![]() |
0..* | Reference(Resource) | Idempotency parent — the send this turn belongs to (email de-dup) | |
![]() ![]() |
1..* | CodeableConcept | Message kind — llm-turn / chat-notice / invitation / reminder; headers also carry conversation-header + thread-* Binding: Athlete communication category (required) | |
![]() ![]() |
1..* | CodeableConcept | A channel of communication Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Email delivery channel (outbound ACS path) Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationMode | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: EMAILWRIT | |
![]() ![]() ![]() |
0..1 | CodeableConcept | In-app coach chat (no ACS) Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.soigneur.coach/fhir/CodeSystem/cc-comm | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: in-app | |
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |
![]() ![]() |
0..* | Reference(Soigneur Athlete (Patient)) | Message recipient | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.category | Base | required | Athlete communication category | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | code | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-message-role Binding: In-app chat message role (required) | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Billed OpenRouter usage that produced this coach turn (ADR 0088) URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-llm-usage | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Conversation thread + per-turn idempotency keys (ADR 0044) | ||||
![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Idempotency parent — the send this turn belongs to (email de-dup) | ||||
![]() ![]() |
0..* | Reference(Communication) | Reply to | |||||
![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() |
1..* | CodeableConcept | Message kind — llm-turn / chat-notice / invitation / reminder; headers also carry conversation-header + thread-* Binding: Athlete communication category (required) | |||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
![]() ![]() |
1..* | CodeableConcept | A channel of communication Slice: Unordered, Open by pattern:$this Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Email delivery channel (outbound ACS path) Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationMode | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: EMAILWRIT | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | In-app coach chat (no ACS) Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.soigneur.coach/fhir/CodeSystem/cc-comm | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: in-app | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
Σ | 1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | ||||
![]() ![]() |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() |
0..1 | dateTime | When sent | |||||
![]() ![]() |
0..1 | dateTime | When received | |||||
![]() ![]() |
0..* | Reference(Soigneur Athlete (Patient)) | Message recipient | |||||
![]() ![]() |
0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() |
0..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() |
0..* | Annotation | Comments made about the communication | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | example | CommunicationNotDoneReason | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | required | Athlete communication category | 📦0.1.0 | This IG |
| Communication.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Communication.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.medium:email | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.medium:inApp | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Communication
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | code | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-message-role Binding: In-app chat message role (required) | |
![]() ![]() ![]() |
0..1 | (Complex) | Billed OpenRouter usage that produced this coach turn (ADR 0088) URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-llm-usage | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier | Conversation thread + per-turn idempotency keys (ADR 0044) |
![]() ![]() |
Σ | 0..* | Reference(Resource) | Idempotency parent — the send this turn belongs to (email de-dup) |
![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
![]() ![]() |
1..* | CodeableConcept | Message kind — llm-turn / chat-notice / invitation / reminder; headers also carry conversation-header + thread-* Binding: Athlete communication category (required) | |
![]() ![]() |
1..* | CodeableConcept | A channel of communication Slice: Unordered, Open by pattern:$this Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Email delivery channel (outbound ACS path) Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationMode | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: EMAILWRIT | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
0..1 | CodeableConcept | In-app coach chat (no ACS) Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.soigneur.coach/fhir/CodeSystem/cc-comm | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: in-app | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
Σ | 1..1 | Reference(Soigneur Athlete (Patient)) | The athlete |
![]() ![]() |
0..* | Reference(Soigneur Athlete (Patient)) | Message recipient | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | required | Athlete communication category | 📦0.1.0 | This IG |
| Communication.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.medium:email | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.medium:inApp | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | code | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-message-role Binding: In-app chat message role (required) | |
![]() ![]() ![]() |
0..1 | (Complex) | Billed OpenRouter usage that produced this coach turn (ADR 0088) URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-llm-usage | |
![]() ![]() |
0..* | Identifier | Conversation thread + per-turn idempotency keys (ADR 0044) | |
![]() ![]() |
0..* | Reference(Resource) | Idempotency parent — the send this turn belongs to (email de-dup) | |
![]() ![]() |
1..* | CodeableConcept | Message kind — llm-turn / chat-notice / invitation / reminder; headers also carry conversation-header + thread-* Binding: Athlete communication category (required) | |
![]() ![]() |
1..* | CodeableConcept | A channel of communication Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Email delivery channel (outbound ACS path) Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationMode | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: EMAILWRIT | |
![]() ![]() ![]() |
0..1 | CodeableConcept | In-app coach chat (no ACS) Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.soigneur.coach/fhir/CodeSystem/cc-comm | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: in-app | |
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |
![]() ![]() |
0..* | Reference(Soigneur Athlete (Patient)) | Message recipient | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.category | Base | required | Athlete communication category | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | code | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-message-role Binding: In-app chat message role (required) | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Billed OpenRouter usage that produced this coach turn (ADR 0088) URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-llm-usage | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Conversation thread + per-turn idempotency keys (ADR 0044) | ||||
![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Idempotency parent — the send this turn belongs to (email de-dup) | ||||
![]() ![]() |
0..* | Reference(Communication) | Reply to | |||||
![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() |
1..* | CodeableConcept | Message kind — llm-turn / chat-notice / invitation / reminder; headers also carry conversation-header + thread-* Binding: Athlete communication category (required) | |||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
![]() ![]() |
1..* | CodeableConcept | A channel of communication Slice: Unordered, Open by pattern:$this Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Email delivery channel (outbound ACS path) Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationMode | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: EMAILWRIT | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | In-app coach chat (no ACS) Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.soigneur.coach/fhir/CodeSystem/cc-comm | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: in-app | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
Σ | 1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | ||||
![]() ![]() |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() |
0..1 | dateTime | When sent | |||||
![]() ![]() |
0..1 | dateTime | When received | |||||
![]() ![]() |
0..* | Reference(Soigneur Athlete (Patient)) | Message recipient | |||||
![]() ![]() |
0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() |
0..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() |
0..* | Annotation | Comments made about the communication | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | example | CommunicationNotDoneReason | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | required | Athlete communication category | 📦0.1.0 | This IG |
| Communication.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Communication.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.medium:email | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.medium:inApp | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Communication
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron