0.1.0 - ci-build
collabreefhirdocumentation - 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.collabree.com/fhir/StructureDefinition/collabree-trophy | Version: 0.1.0 | |||
| Draft as of 2025-11-04 | Computable Name: CollabreeTrophy | |||
A trophy represents an achievement earned by a patient in the Collabree adherence tracking system. Trophies are automatically calculated and awarded based on adherence patterns, quiz completions, and system interactions.
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..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
1..* | Identifier | External Ids for this goal Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
1..1 | Identifier | External Ids for this goal | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.collabree.com/fhir/ValueSet/collabree-trophy-type-vs |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Trophy Type Binding: Collabree Trophy Type Value Set (required) Example General: 123456 |
![]() ![]() |
?!Σ | 1..1 | code | Trophy Status Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. Required Pattern: completed |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Trophy Description Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used. |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 404684003 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: Clinical finding (finding) |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Patient Reference |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.identifier:trophy.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Goal.identifier:trophy.value | Base | required | Collabree Trophy Type Value Set | 📦0.1.0 | This IG |
| Goal.lifecycleStatus | Base | required | GoalLifecycleStatus | 📍4.0.1 | FHIR Std. |
| Goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Goal | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Goal
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
![]() ![]() |
1..* | Identifier | External Ids for this goal Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
1..1 | Identifier | External Ids for this goal | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.collabree.com/fhir/ValueSet/collabree-trophy-type-vs | |
![]() ![]() ![]() ![]() |
1..1 | string | Trophy Type Binding: Collabree Trophy Type Value Set (required) | |
![]() ![]() |
1..1 | code | Trophy Status Required Pattern: completed | |
![]() ![]() |
1..1 | CodeableConcept | Trophy Description | |
![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: 404684003 | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: Clinical finding (finding) | |
![]() ![]() |
1..1 | Reference(Patient) | Patient Reference | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.identifier:trophy.value | Base | required | Collabree Trophy Type Value Set | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |||||
![]() ![]() |
Σ | 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 | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
1..* | Identifier | External Ids for this goal Slice: Unordered, Open by value:system | |||||
![]() ![]() ![]() |
1..1 | Identifier | External Ids for this goal | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.collabree.com/fhir/ValueSet/collabree-trophy-type-vs | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Trophy Type Binding: Collabree Trophy Type Value Set (required) Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | Trophy Status Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. Required Pattern: completed | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Trophy Description Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 404684003 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: Clinical finding (finding) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Patient Reference | ||||
![]() ![]() |
Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Target outcome for the goal Constraints: gol-1 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | The target value to be achieved Binding Description: (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | |||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Reach goal on or before | |||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() |
Σ | 0..1 | date | When goal status took effect | ||||
![]() ![]() |
0..1 | string | Reason for current status | |||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? | ||||
![]() ![]() |
0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal | |||||
![]() ![]() |
0..* | Annotation | Comments about the goal | |||||
![]() ![]() |
0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMEDCTClinicalFindings (example): The result of the goal; e.g. "25% increase in shoulder mobility", "Anxiety reduced to moderate levels". "15 kg weight loss sustained over 6 months". | |||||
![]() ![]() |
0..* | Reference(Observation) | Observation that resulted from goal | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Goal.identifier:trophy.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Goal.identifier:trophy.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Goal.identifier:trophy.value | Base | required | Collabree Trophy Type Value Set | 📦0.1.0 | This IG |
| Goal.lifecycleStatus | Base | required | GoalLifecycleStatus | 📍4.0.1 | FHIR Std. |
| Goal.achievementStatus | Base | preferred | Goal achievement status | 📍4.0.1 | FHIR Std. |
| Goal.category | Base | example | Goal category | 📍4.0.1 | FHIR Std. |
| Goal.priority | Base | preferred | Goal priority | 📍4.0.1 | FHIR Std. |
| Goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Goal.start[x] | Base | example | Goal start event | 📍4.0.1 | FHIR Std. |
| Goal.target.measure | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Goal.target.detail[x] | Base | example | Not State | Unknown | |
| Goal.outcomeCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Goal | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| gol-1 | error | Goal.target | Goal.target.measure is required if Goal.target.detail is populated |
(detail.exists() and measure.exists()) or detail.exists().not()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
1..* | Identifier | External Ids for this goal Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
1..1 | Identifier | External Ids for this goal | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.collabree.com/fhir/ValueSet/collabree-trophy-type-vs |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Trophy Type Binding: Collabree Trophy Type Value Set (required) Example General: 123456 |
![]() ![]() |
?!Σ | 1..1 | code | Trophy Status Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. Required Pattern: completed |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Trophy Description Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used. |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 404684003 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: Clinical finding (finding) |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Patient Reference |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.identifier:trophy.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Goal.identifier:trophy.value | Base | required | Collabree Trophy Type Value Set | 📦0.1.0 | This IG |
| Goal.lifecycleStatus | Base | required | GoalLifecycleStatus | 📍4.0.1 | FHIR Std. |
| Goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Goal | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Goal
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
![]() ![]() |
1..* | Identifier | External Ids for this goal Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
1..1 | Identifier | External Ids for this goal | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.collabree.com/fhir/ValueSet/collabree-trophy-type-vs | |
![]() ![]() ![]() ![]() |
1..1 | string | Trophy Type Binding: Collabree Trophy Type Value Set (required) | |
![]() ![]() |
1..1 | code | Trophy Status Required Pattern: completed | |
![]() ![]() |
1..1 | CodeableConcept | Trophy Description | |
![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: 404684003 | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: Clinical finding (finding) | |
![]() ![]() |
1..1 | Reference(Patient) | Patient Reference | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.identifier:trophy.value | Base | required | Collabree Trophy Type Value Set | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |||||
![]() ![]() |
Σ | 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 | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
1..* | Identifier | External Ids for this goal Slice: Unordered, Open by value:system | |||||
![]() ![]() ![]() |
1..1 | Identifier | External Ids for this goal | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.collabree.com/fhir/ValueSet/collabree-trophy-type-vs | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Trophy Type Binding: Collabree Trophy Type Value Set (required) Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | Trophy Status Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. Required Pattern: completed | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Trophy Description Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 404684003 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: Clinical finding (finding) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Patient Reference | ||||
![]() ![]() |
Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Target outcome for the goal Constraints: gol-1 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | The target value to be achieved Binding Description: (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | |||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Reach goal on or before | |||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() |
Σ | 0..1 | date | When goal status took effect | ||||
![]() ![]() |
0..1 | string | Reason for current status | |||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? | ||||
![]() ![]() |
0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal | |||||
![]() ![]() |
0..* | Annotation | Comments about the goal | |||||
![]() ![]() |
0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMEDCTClinicalFindings (example): The result of the goal; e.g. "25% increase in shoulder mobility", "Anxiety reduced to moderate levels". "15 kg weight loss sustained over 6 months". | |||||
![]() ![]() |
0..* | Reference(Observation) | Observation that resulted from goal | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Goal.identifier:trophy.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Goal.identifier:trophy.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Goal.identifier:trophy.value | Base | required | Collabree Trophy Type Value Set | 📦0.1.0 | This IG |
| Goal.lifecycleStatus | Base | required | GoalLifecycleStatus | 📍4.0.1 | FHIR Std. |
| Goal.achievementStatus | Base | preferred | Goal achievement status | 📍4.0.1 | FHIR Std. |
| Goal.category | Base | example | Goal category | 📍4.0.1 | FHIR Std. |
| Goal.priority | Base | preferred | Goal priority | 📍4.0.1 | FHIR Std. |
| Goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Goal.start[x] | Base | example | Goal start event | 📍4.0.1 | FHIR Std. |
| Goal.target.measure | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Goal.target.detail[x] | Base | example | Not State | Unknown | |
| Goal.outcomeCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Goal | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| gol-1 | error | Goal.target | Goal.target.measure is required if Goal.target.detail is populated |
(detail.exists() and measure.exists()) or detail.exists().not()
|
Other representations of profile: CSV, Excel, Schematron