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-coach-insight | Version: 0.1.0 | |||
| Draft as of 2026-09-08 | Computable Name: CcCoachInsight | |||
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 durable, curated coaching insight — a learned behavioural/physiological/health pattern, preference, or constraint (ADR 0070). status current | superseded (never deleted); relatesTo[replaces] chains supersessions so history stays queryable. category is the insight kind; cc-ext-insight-confidence + cc-ext-insight-last-reinforced carry the ratchet/decay; context.related links the source Communications/Observations. |
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..* | DocumentReference | A reference to a document | |
![]() ![]() |
?!Σ | 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-insight-confidence Binding: Coach-insight confidence rung (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-insight-last-reinforced | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error — supersede, never delete Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. 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-doc | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coach-insight | |
![]() ![]() ![]() ![]() |
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..* | CodeableConcept | Categorization of document Binding: Coach-insight category (required) |
![]() ![]() |
Σ | 1..1 | Reference(Soigneur Athlete (Patient)) | The athlete |
![]() ![]() |
Σ | 0..1 | instant | When the insight was recorded / last updated |
![]() ![]() |
Σ | 0..* | BackboneElement | relatesTo[replaces] -> the insight version this supersedes (curation chain) |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
![]() ![]() |
Σ | 1..1 | BackboneElement | Document referenced |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Attachment | The insight narrative (text/markdown) |
![]() ![]() ![]() ![]() |
Σ | 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 |
Documentation for this format | ||||
| 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.category | Base | required | Coach-insight category | 📦0.1.0 | This IG |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | code | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-insight-confidence Binding: Coach-insight confidence rung (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-insight-last-reinforced | |
![]() ![]() |
1..1 | code | current | superseded | entered-in-error — supersede, never delete | |
![]() ![]() |
1..1 | CodeableConcept | Kind of document (LOINC if possible) 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-doc | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coach-insight | |
![]() ![]() |
1..* | CodeableConcept | Categorization of document Binding: Coach-insight category (required) | |
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |
![]() ![]() |
0..1 | instant | When the insight was recorded / last updated | |
![]() ![]() |
0..* | BackboneElement | relatesTo[replaces] -> the insight version this supersedes (curation chain) | |
![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() |
1..1 | Attachment | The insight narrative (text/markdown) | |
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Source Communications/Observations that evidence the insight (provenance) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.category | Base | required | Coach-insight category | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |||||
![]() ![]() |
Σ | 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-insight-confidence Binding: Coach-insight confidence rung (required) | |||||
![]() ![]() ![]() |
0..1 | dateTime | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-insight-last-reinforced | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error — supersede, never delete Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. 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-doc | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coach-insight | |||||
![]() ![]() ![]() ![]() |
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..* | CodeableConcept | Categorization of document Binding: Coach-insight category (required) | ||||
![]() ![]() |
Σ | 1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | ||||
![]() ![]() |
Σ | 0..1 | instant | When the insight was recorded / last updated | ||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | relatesTo[replaces] -> the insight version this supersedes (curation chain) | ||||
![]() ![]() ![]() |
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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() |
Σ | 1..1 | BackboneElement | Document referenced | ||||
![]() ![]() ![]() |
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 | Attachment | The insight narrative (text/markdown) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Source Communications/Observations that evidence the insight (provenance) | |||||
Documentation for this format | ||||||||
| 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 | required | Coach-insight category | 📦0.1.0 | This IG |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from DocumentReference
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
?!Σ | 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-insight-confidence Binding: Coach-insight confidence rung (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-insight-last-reinforced | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error — supersede, never delete Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. 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-doc | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coach-insight | |
![]() ![]() ![]() ![]() |
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..* | CodeableConcept | Categorization of document Binding: Coach-insight category (required) |
![]() ![]() |
Σ | 1..1 | Reference(Soigneur Athlete (Patient)) | The athlete |
![]() ![]() |
Σ | 0..1 | instant | When the insight was recorded / last updated |
![]() ![]() |
Σ | 0..* | BackboneElement | relatesTo[replaces] -> the insight version this supersedes (curation chain) |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
![]() ![]() |
Σ | 1..1 | BackboneElement | Document referenced |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Attachment | The insight narrative (text/markdown) |
![]() ![]() ![]() ![]() |
Σ | 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 |
Documentation for this format | ||||
| 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.category | Base | required | Coach-insight category | 📦0.1.0 | This IG |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | code | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-insight-confidence Binding: Coach-insight confidence rung (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-insight-last-reinforced | |
![]() ![]() |
1..1 | code | current | superseded | entered-in-error — supersede, never delete | |
![]() ![]() |
1..1 | CodeableConcept | Kind of document (LOINC if possible) 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-doc | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coach-insight | |
![]() ![]() |
1..* | CodeableConcept | Categorization of document Binding: Coach-insight category (required) | |
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |
![]() ![]() |
0..1 | instant | When the insight was recorded / last updated | |
![]() ![]() |
0..* | BackboneElement | relatesTo[replaces] -> the insight version this supersedes (curation chain) | |
![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() |
1..1 | Attachment | The insight narrative (text/markdown) | |
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Source Communications/Observations that evidence the insight (provenance) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.category | Base | required | Coach-insight category | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |||||
![]() ![]() |
Σ | 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-insight-confidence Binding: Coach-insight confidence rung (required) | |||||
![]() ![]() ![]() |
0..1 | dateTime | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-insight-last-reinforced | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error — supersede, never delete Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. 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-doc | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coach-insight | |||||
![]() ![]() ![]() ![]() |
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..* | CodeableConcept | Categorization of document Binding: Coach-insight category (required) | ||||
![]() ![]() |
Σ | 1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | ||||
![]() ![]() |
Σ | 0..1 | instant | When the insight was recorded / last updated | ||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | relatesTo[replaces] -> the insight version this supersedes (curation chain) | ||||
![]() ![]() ![]() |
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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() |
Σ | 1..1 | BackboneElement | Document referenced | ||||
![]() ![]() ![]() |
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 | Attachment | The insight narrative (text/markdown) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Source Communications/Observations that evidence the insight (provenance) | |||||
Documentation for this format | ||||||||
| 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 | required | Coach-insight category | 📦0.1.0 | This IG |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from DocumentReference
Other representations of profile: CSV, Excel, Schematron