EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/goal | Version: 0.1.0 | |||
| Draft as of 2024-02-05 | Computable Name: EHIGoal | |||
Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Goal
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Goal | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| lifecycleStatus | ?!Σ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. |
 description | Σ | 1..1 | CodeableConcept | Code or text describing goal 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. |
  subject | Σ | 1..1 | Reference(Patient | Group | Organization) | Who this goal is intended for |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Goal.lifecycleStatus | required | GoalLifecycleStatus |
| Goal.description | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Goal | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | External Ids for this goal | |||||
| lifecycleStatus | ?!Σ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. | ||||
| achievementStatus | Σ | 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. | ||||
| category | Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
| priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
| description | Σ | 1..1 | CodeableConcept | Code or text describing goal 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. | ||||
| subject | Σ | 1..1 | Reference(Patient | Group | Organization) | Who this goal is intended for | ||||
  start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
 startDate | date | |||||||
| startCodeableConcept | CodeableConcept | |||||||
| target | C | 0..* | BackboneElement | Target outcome for the goal | ||||
| 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 | ||||
| measure | Σ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. | ||||
| detail[x] | ΣC | 0..1 | The target value to be achieved Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | |||||
| detailQuantity | Quantity | |||||||
| detailRange | Range | |||||||
| detailCodeableConcept | CodeableConcept | |||||||
| detailString | string | |||||||
| detailBoolean | boolean | |||||||
| detailInteger | integer | |||||||
| detailRatio | Ratio | |||||||
 due[x] | Σ | 0..1 | Reach goal on or before | |||||
 dueDate | date | |||||||
| dueDuration | Duration | |||||||
| statusDate | Σ | 0..1 | date | When goal status took effect | ||||
| statusReason | 0..1 | string | Reason for current status | |||||
| expressedBy | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? | ||||
| addresses | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal | |||||
| note | 0..* | Annotation | Comments about the goal | |||||
| outcomeCode | 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". | |||||
| outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Goal.language | preferred | CommonLanguages
| ||||
| Goal.lifecycleStatus | required | GoalLifecycleStatus | ||||
| Goal.achievementStatus | preferred | GoalAchievementStatus | ||||
| Goal.category | example | GoalCategory | ||||
| Goal.priority | preferred | GoalPriority | ||||
| Goal.description | example | SNOMEDCTClinicalFindings | ||||
| Goal.start[x] | example | GoalStartEvent | ||||
| Goal.target.measure | example | LOINCCodes (a valid code from LOINC) | ||||
| Goal.target.detail[x] | example | |||||
| Goal.outcomeCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from Goal
Differential View
This structure is derived from Goal
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| lifecycleStatus | ?!Σ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. |
| description | Σ | 1..1 | CodeableConcept | Code or text describing goal 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. |
| subject | Σ | 1..1 | Reference(Patient | Group | Organization) | Who this goal is intended for |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Goal.lifecycleStatus | required | GoalLifecycleStatus |
| Goal.description | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Goal | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | External Ids for this goal | |||||
| lifecycleStatus | ?!Σ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. | ||||
| achievementStatus | Σ | 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. | ||||
| category | Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
| priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
| description | Σ | 1..1 | CodeableConcept | Code or text describing goal 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. | ||||
| subject | Σ | 1..1 | Reference(Patient | Group | Organization) | Who this goal is intended for | ||||
| start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
| startDate | date | |||||||
| startCodeableConcept | CodeableConcept | |||||||
| target | C | 0..* | BackboneElement | Target outcome for the goal | ||||
| 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 | ||||
| measure | Σ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. | ||||
| detail[x] | ΣC | 0..1 | The target value to be achieved Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | |||||
| detailQuantity | Quantity | |||||||
| detailRange | Range | |||||||
| detailCodeableConcept | CodeableConcept | |||||||
| detailString | string | |||||||
| detailBoolean | boolean | |||||||
| detailInteger | integer | |||||||
| detailRatio | Ratio | |||||||
| due[x] | Σ | 0..1 | Reach goal on or before | |||||
| dueDate | date | |||||||
| dueDuration | Duration | |||||||
| statusDate | Σ | 0..1 | date | When goal status took effect | ||||
| statusReason | 0..1 | string | Reason for current status | |||||
| expressedBy | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? | ||||
| addresses | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal | |||||
| note | 0..* | Annotation | Comments about the goal | |||||
| outcomeCode | 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". | |||||
| outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Goal.language | preferred | CommonLanguages
| ||||
| Goal.lifecycleStatus | required | GoalLifecycleStatus | ||||
| Goal.achievementStatus | preferred | GoalAchievementStatus | ||||
| Goal.category | example | GoalCategory | ||||
| Goal.priority | preferred | GoalPriority | ||||
| Goal.description | example | SNOMEDCTClinicalFindings | ||||
| Goal.start[x] | example | GoalStartEvent | ||||
| Goal.target.measure | example | LOINCCodes (a valid code from LOINC) | ||||
| Goal.target.detail[x] | example | |||||
| Goal.outcomeCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from Goal
Other representations of profile: CSV, Excel, Schematron