NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/PROJ-PHILHEALTH-EA-NHDR/nhdr-fhir-ig-review-project-2/ and changes regularly. See the Directory of published versions

## Resource Profile: PH Goal

Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-Goal | Version: 0.1.0
Standards status: Draft | Computable Name: PH_Goal
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

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.

Usages:

- This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Goal |  | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization
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(PH Patient | Group | PH Organization) | Who this goal is intended for
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Goal.lifecycleStatus | Base | required | GoalLifecycleStatus | 📍4.0.1 | FHIR Std.
Goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.

#### Constraints

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())`

This structure is derived from Goal

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Goal |  | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization
meta |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:hfRecordedDate |  | 0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
extension:hfLastUpdated |  | 0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
lastUpdated |  | 0..1 | instant | When the resource was uploaded to the NHDR.
implicitRules |  | 0..0 |  | A set of rules under which this content was created
language |  | 0..0 |  | Language of the resource content
text |  | 0..0 |  | Text summary of the resource, for human interpretation
contained |  | 0..0 |  | Contained, inline Resources
extension |  | 0..0 |  | Extension
modifierExtension |  | 0..0 |  | Extension
identifier |  | 0..0 |  | External Ids for this goal
achievementStatus |  | 0..0 |  | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
category |  | 0..0 |  | E.g. Treatment, dietary, behavioral, etc.
priority |  | 0..0 |  | high-priority | medium-priority | low-priority
subject |  | 1..1 | Reference(PH Patient | Group | PH Organization) | Who this goal is intended for
start[x] |  | 0..0 |  | When goal pursuit begins
target |  |  |  |
id |  | 0..0 |  | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension
modifierExtension |  | 0..0 |  | Extension
measure |  | 0..0 |  | The parameter whose value is being tracked
detail[x] |  | 0..1 | CodeableConcept | The target value to be achieved
due[x] |  | 0..0 |  | Reach goal on or before
statusDate |  | 0..0 |  | When goal status took effect
statusReason |  | 0..0 |  | Reason for current status
expressedBy |  | 0..0 |  | Who's responsible for creating Goal?
addresses |  | 0..0 |  | Issues addressed by this goal
note |  | 0..0 |  | Comments about the goal
outcomeCode |  | 0..0 |  | What result was achieved regarding the goal?
outcomeReference |  | 0..0 |  | Observation that resulted from goal
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:hfRecordedDate |  | 0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
extension:hfLastUpdated |  | 0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource was uploaded to the NHDR.
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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(PH Patient | Group | PH Organization) | Who this goal is intended for
target | C | 0..* | BackboneElement | Target outcome for the goal Constraints: gol-1
detail[x] | Σ C | 0..1 | CodeableConcept | 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.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Goal.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Goal.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
Goal.lifecycleStatus | Base | required | GoalLifecycleStatus | 📍4.0.1 | FHIR Std.
Goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.
Goal.target.detail[x] | Base | example |  | Not State | Unknown

#### Constraints

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()`

This structure is derived from Goal

Summary

Prohibited: 23 elements

Structures

This structure refers to these other structures:

- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Organization (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Organization)

Extensions

This structure refers to these extensions:

- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Goal |  | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization
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(PH Patient | Group | PH Organization) | Who this goal is intended for
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Goal.lifecycleStatus | Base | required | GoalLifecycleStatus | 📍4.0.1 | FHIR Std.
Goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.

#### Constraints

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())`

Differential View

This structure is derived from Goal

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Goal |  | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization
meta |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:hfRecordedDate |  | 0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
extension:hfLastUpdated |  | 0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
lastUpdated |  | 0..1 | instant | When the resource was uploaded to the NHDR.
implicitRules |  | 0..0 |  | A set of rules under which this content was created
language |  | 0..0 |  | Language of the resource content
text |  | 0..0 |  | Text summary of the resource, for human interpretation
contained |  | 0..0 |  | Contained, inline Resources
extension |  | 0..0 |  | Extension
modifierExtension |  | 0..0 |  | Extension
identifier |  | 0..0 |  | External Ids for this goal
achievementStatus |  | 0..0 |  | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
category |  | 0..0 |  | E.g. Treatment, dietary, behavioral, etc.
priority |  | 0..0 |  | high-priority | medium-priority | low-priority
subject |  | 1..1 | Reference(PH Patient | Group | PH Organization) | Who this goal is intended for
start[x] |  | 0..0 |  | When goal pursuit begins
target |  |  |  |
id |  | 0..0 |  | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension
modifierExtension |  | 0..0 |  | Extension
measure |  | 0..0 |  | The parameter whose value is being tracked
detail[x] |  | 0..1 | CodeableConcept | The target value to be achieved
due[x] |  | 0..0 |  | Reach goal on or before
statusDate |  | 0..0 |  | When goal status took effect
statusReason |  | 0..0 |  | Reason for current status
expressedBy |  | 0..0 |  | Who's responsible for creating Goal?
addresses |  | 0..0 |  | Issues addressed by this goal
note |  | 0..0 |  | Comments about the goal
outcomeCode |  | 0..0 |  | What result was achieved regarding the goal?
outcomeReference |  | 0..0 |  | Observation that resulted from goal
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:hfRecordedDate |  | 0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
extension:hfLastUpdated |  | 0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource was uploaded to the NHDR.
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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(PH Patient | Group | PH Organization) | Who this goal is intended for
target | C | 0..* | BackboneElement | Target outcome for the goal Constraints: gol-1
detail[x] | Σ C | 0..1 | CodeableConcept | 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.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Goal.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Goal.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
Goal.lifecycleStatus | Base | required | GoalLifecycleStatus | 📍4.0.1 | FHIR Std.
Goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.
Goal.target.detail[x] | Base | example |  | Not State | Unknown

#### Constraints

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()`

This structure is derived from Goal

Summary

Prohibited: 23 elements

Structures

This structure refers to these other structures:

- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Organization (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Organization)

Extensions

This structure refers to these extensions:

- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated

Other representations of profile: CSV, Excel, Schematron