Soigneur FHIR Implementation Guide
0.1.0 - ci-build
Soigneur FHIR Implementation Guide
0.1.0 - ci-build
Soigneur FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.soigneur.coach/fhir/StructureDefinition/cc-raw-file-index | Version: 0.1.0 | |||
| Draft as of 2026-11-14 | Computable Name: CcRawFileIndex | |||
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. |
||||
Searchable index for a raw provider Binary (04 15.6 / 15.7). A Binary is not itself searchable (FHIR spec) and is not a valid Observation.derivedFrom target (R4), so a DocumentReference carries the discoverable metadata and points at the blob via content.attachment.url → Binary/{id}. Derived Observations (e.g. the CcActivityGroup and its sampled stream) reference THIS resource via derivedFrom; the download/translate lineage back to the raw blob is carried by the CcTranslationProvenance entity[source]. When the provider serves the original export file (e.g. the downloaded FIT), it is stored as a second Binary and indexed as a second content entry — the same document in its native format — so every raw blob is reachable over a FHIR edge (never only by id convention, issue #660).
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:  |
|---|---|---|---|---|
  DocumentReference |
0..* | DocumentReference | A reference to a document | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 masterIdentifier |
0..1 | Identifier | The source artifact's provider id, per source + version (e.g. Garmin activityId) — the download-idempotency key (04 13.5), NOT the consolidated-activity pointer (that is the CcActivityGroup Observation, 13.6) | |
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |
 subject |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete this raw file belongs to | |
 content |
1..2 | BackboneElement | Document referenced | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| attachment |
1..1 | Attachment | Where to access the document | |
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Beispiel General: text/plain; charset=UTF-8, image/png | |
 url |
1..1 | url | Relative reference to the raw Binary (Binary/{id}); a second entry, when present, indexes the original provider export-file Binary Beispiel General: http://www.acme.com/logo-small.png | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Beschreibung | Expression |
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |
 masterIdentifier |
0..1 | Identifier | The source artifact's provider id, per source + version (e.g. Garmin activityId) — the download-idempotency key (04 13.5), NOT the consolidated-activity pointer (that is the CcActivityGroup Observation, 13.6) | |
| subject |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete this raw file belongs to | |
 content |
1..2 | BackboneElement | Document referenced | |
 attachment |
||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. | |
| url |
1..1 | url | Relative reference to the raw Binary (Binary/{id}); a second entry, when present, indexes the original provider export-file Binary | |
| context |
||||
| related |
0..* | Reference(Activity Group Observation) | The Activity Group Observation(s) derived from this raw file | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| masterIdentifier |
0..1 | Identifier | The source artifact's provider id, per source + version (e.g. Garmin activityId) — the download-idempotency key (04 13.5), NOT the consolidated-activity pointer (that is the CcActivityGroup Observation, 13.6) | |||||
| identifier |
0..* | Identifier | Other identifiers for the document | |||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |||||
| docStatus |
0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | |||||
| type |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | |||||
| category |
0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | |||||
| subject |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete this raw file belongs to | |||||
| date |
0..1 | instant | When this document reference was created | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
| relatesTo |
0..* | BackboneElement | Relationships to other documents | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
| description |
0..1 | string | Human-readable description | |||||
| securityLabel |
0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| content |
1..2 | BackboneElement | Document referenced | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| attachment |
1..1 | Attachment | Where to access the document | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Beispiel General: text/plain; charset=UTF-8, image/png | |||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Beispiel General: en-AU | |||||
| data |
0..1 | base64Binary | Data inline, base64ed | |||||
| url |
1..1 | url | Relative reference to the raw Binary (Binary/{id}); a second entry, when present, indexes the original provider export-file Binary Beispiel General: http://www.acme.com/logo-small.png | |||||
| size |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||
| hash |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
| title |
0..1 | string | Label to display in place of the data Beispiel General: Official Corporate Logo | |||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||
| format |
0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | |||||
| context |
0..1 | BackboneElement | Clinical context of document | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| encounter |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
| event |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| period |
0..1 | Period | Time of service that is being documented | |||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |||||
| related |
0..* | Reference(Activity Group Observation) | The Activity Group Observation(s) derived from this raw file | |||||
| 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 |
This structure is derived from DocumentReference
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| masterIdentifier |
0..1 | Identifier | The source artifact's provider id, per source + version (e.g. Garmin activityId) — the download-idempotency key (04 13.5), NOT the consolidated-activity pointer (that is the CcActivityGroup Observation, 13.6) | |
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |
| subject |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete this raw file belongs to | |
| content |
1..2 | BackboneElement | Document referenced | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| attachment |
1..1 | Attachment | Where to access the document | |
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Beispiel General: text/plain; charset=UTF-8, image/png | |
| url |
1..1 | url | Relative reference to the raw Binary (Binary/{id}); a second entry, when present, indexes the original provider export-file Binary Beispiel General: http://www.acme.com/logo-small.png | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Beschreibung | Expression |
Differential View
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |
| masterIdentifier |
0..1 | Identifier | The source artifact's provider id, per source + version (e.g. Garmin activityId) — the download-idempotency key (04 13.5), NOT the consolidated-activity pointer (that is the CcActivityGroup Observation, 13.6) | |
| subject |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete this raw file belongs to | |
| content |
1..2 | BackboneElement | Document referenced | |
| attachment |
||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. | |
| url |
1..1 | url | Relative reference to the raw Binary (Binary/{id}); a second entry, when present, indexes the original provider export-file Binary | |
| context |
||||
| related |
0..* | Reference(Activity Group Observation) | The Activity Group Observation(s) derived from this raw file | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| masterIdentifier |
0..1 | Identifier | The source artifact's provider id, per source + version (e.g. Garmin activityId) — the download-idempotency key (04 13.5), NOT the consolidated-activity pointer (that is the CcActivityGroup Observation, 13.6) | |||||
| identifier |
0..* | Identifier | Other identifiers for the document | |||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |||||
| docStatus |
0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | |||||
| type |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | |||||
| category |
0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | |||||
| subject |
1..1 | Reference(Soigneur Athlete (Patient)) | The athlete this raw file belongs to | |||||
| date |
0..1 | instant | When this document reference was created | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
| relatesTo |
0..* | BackboneElement | Relationships to other documents | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
| description |
0..1 | string | Human-readable description | |||||
| securityLabel |
0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| content |
1..2 | BackboneElement | Document referenced | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| attachment |
1..1 | Attachment | Where to access the document | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Beispiel General: text/plain; charset=UTF-8, image/png | |||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Beispiel General: en-AU | |||||
| data |
0..1 | base64Binary | Data inline, base64ed | |||||
| url |
1..1 | url | Relative reference to the raw Binary (Binary/{id}); a second entry, when present, indexes the original provider export-file Binary Beispiel General: http://www.acme.com/logo-small.png | |||||
| size |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||
| hash |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
| title |
0..1 | string | Label to display in place of the data Beispiel General: Official Corporate Logo | |||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||
| format |
0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | |||||
| context |
0..1 | BackboneElement | Clinical context of document | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| encounter |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
| event |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| period |
0..1 | Period | Time of service that is being documented | |||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |||||
| related |
0..* | Reference(Activity Group Observation) | The Activity Group Observation(s) derived from this raw file | |||||
| 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 |
This structure is derived from DocumentReference
Other representations of profile: CSV, Excel, Schematron