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-debrief | Version: 0.1.0 | |||
| Draft as of 2026-11-14 | 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: cc-inv-debrief-identifier |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | string, Reference(Day Call Observation (per-day)) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-next-decision | |
![]() ![]() ![]() |
0..1 | string | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-takeaway | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | Identifier | debrief|{activityId} — idempotent review write (ADR 0093) | |
![]() ![]() |
1..1 | code | current | superseded | entered-in-error 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: | |
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |
![]() ![]() |
0..1 | string | The lead headline — the coach's assessment of the session in one sentence | |
![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Attachment | The debrief note (text/markdown or plain text) | |
![]() ![]() ![]() ![]() |
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. Beispiel General: text/plain; charset=UTF-8, image/png | |
![]() ![]() |
1..1 | BackboneElement | Clinical context of document | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..* | Reference(Activity Group Observation) | Activity Group Observation(s) this debrief comments on | |
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.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Beschreibung | 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: cc-inv-debrief-identifier |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | string, Reference(Day Call Observation (per-day)) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-next-decision | |
![]() ![]() ![]() |
0..1 | string | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-takeaway | |
![]() ![]() |
1..1 | Identifier | debrief|{activityId} — idempotent review write (ADR 0093) | |
![]() ![]() |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Required Pattern: | |
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |
![]() ![]() |
0..1 | string | The lead headline — the coach's assessment of the session in one sentence | |
![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() |
1..1 | Attachment | The debrief note (text/markdown or plain text) | |
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. | |
![]() ![]() |
1..1 | BackboneElement | Clinical context of document | |
![]() ![]() ![]() |
1..* | Reference(Activity Group Observation) | Activity Group Observation(s) this debrief comments on | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Beschreibung | 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|')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: cc-inv-debrief-identifier | ||||
![]() ![]() |
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 | string, Reference(Day Call Observation (per-day)) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-next-decision | |||||
![]() ![]() ![]() |
0..1 | string | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-takeaway | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..1 | Identifier | Master Version Specific Identifier | |||||
![]() ![]() |
1..1 | Identifier | debrief|{activityId} — idempotent review write (ADR 0093) | |||||
![]() ![]() |
1..1 | code | current | superseded | entered-in-error 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: | |||||
![]() ![]() |
0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | |||||
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |||||
![]() ![]() |
0..1 | instant | When this document reference was created | |||||
![]() ![]() |
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 | Relationships to other documents | |||||
![]() ![]() ![]() |
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 | The lead headline — the coach's assessment of the session in one sentence | |||||
![]() ![]() |
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 debrief note (text/markdown or plain text) | |||||
![]() ![]() ![]() ![]() |
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. Beispiel General: text/plain; charset=UTF-8, image/png | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Beispiel General: en-AU | |||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() ![]() |
0..1 | url | Uri where the data can be found Beispiel 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 Beispiel 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. | |||||
![]() ![]() |
1..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 | |||||
![]() ![]() ![]() |
1..* | Reference(Activity Group Observation) | Activity Group Observation(s) this debrief comments on | |||||
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 | 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.5 |
| 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) | Beschreibung | 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
Summary
Mandatory: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: cc-inv-debrief-identifier |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | string, Reference(Day Call Observation (per-day)) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-next-decision | |
![]() ![]() ![]() |
0..1 | string | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-takeaway | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | Identifier | debrief|{activityId} — idempotent review write (ADR 0093) | |
![]() ![]() |
1..1 | code | current | superseded | entered-in-error 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: | |
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |
![]() ![]() |
0..1 | string | The lead headline — the coach's assessment of the session in one sentence | |
![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Attachment | The debrief note (text/markdown or plain text) | |
![]() ![]() ![]() ![]() |
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. Beispiel General: text/plain; charset=UTF-8, image/png | |
![]() ![]() |
1..1 | BackboneElement | Clinical context of document | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..* | Reference(Activity Group Observation) | Activity Group Observation(s) this debrief comments on | |
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.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Beschreibung | 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: cc-inv-debrief-identifier |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | string, Reference(Day Call Observation (per-day)) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-next-decision | |
![]() ![]() ![]() |
0..1 | string | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-takeaway | |
![]() ![]() |
1..1 | Identifier | debrief|{activityId} — idempotent review write (ADR 0093) | |
![]() ![]() |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Required Pattern: | |
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |
![]() ![]() |
0..1 | string | The lead headline — the coach's assessment of the session in one sentence | |
![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() |
1..1 | Attachment | The debrief note (text/markdown or plain text) | |
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. | |
![]() ![]() |
1..1 | BackboneElement | Clinical context of document | |
![]() ![]() ![]() |
1..* | Reference(Activity Group Observation) | Activity Group Observation(s) this debrief comments on | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Beschreibung | 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: cc-inv-debrief-identifier | ||||
![]() ![]() |
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 | string, Reference(Day Call Observation (per-day)) | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-next-decision | |||||
![]() ![]() ![]() |
0..1 | string | Optional Extensions Element URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-ext-debrief-takeaway | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..1 | Identifier | Master Version Specific Identifier | |||||
![]() ![]() |
1..1 | Identifier | debrief|{activityId} — idempotent review write (ADR 0093) | |||||
![]() ![]() |
1..1 | code | current | superseded | entered-in-error 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: | |||||
![]() ![]() |
0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | |||||
![]() ![]() |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete | |||||
![]() ![]() |
0..1 | instant | When this document reference was created | |||||
![]() ![]() |
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 | Relationships to other documents | |||||
![]() ![]() ![]() |
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 | The lead headline — the coach's assessment of the session in one sentence | |||||
![]() ![]() |
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 debrief note (text/markdown or plain text) | |||||
![]() ![]() ![]() ![]() |
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. Beispiel General: text/plain; charset=UTF-8, image/png | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Beispiel General: en-AU | |||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() ![]() |
0..1 | url | Uri where the data can be found Beispiel 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 Beispiel 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. | |||||
![]() ![]() |
1..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 | |||||
![]() ![]() ![]() |
1..* | Reference(Activity Group Observation) | Activity Group Observation(s) this debrief comments on | |||||
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 | 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.5 |
| 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) | Beschreibung | 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
Summary
Mandatory: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron