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/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ 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 Specification

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Goal 0..* Goal Describes the intended objective(s) for a patient, group or organization
Goal.lifecycleStatus This element is a modifier element. This element is included in summaries. 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.
Goal.description This element is included in summaries. 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.
Goal.subject This element is included in summaries. 1..1 Reference(Patient | Group | Organization) Who this goal is intended for

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Goal 0..* Goal Describes the intended objective(s) for a patient, group or organization
Goal.meta
Goal.meta.Slices for extension Content/Rules for all slices
Goal.meta.Slices for extension.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
Goal.meta.Slices for extension.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
Goal.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Goal.implicitRules 0..0 A set of rules under which this content was created
Goal.language 0..0 Language of the resource content
Goal.contained 0..0 Contained, inline Resources
Goal.extension 0..0 Extension
Goal.modifierExtension 0..0 Extension
Goal.identifier 0..0 External Ids for this goal
Goal.achievementStatus 0..0 in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Goal.category 0..0 E.g. Treatment, dietary, behavioral, etc.
Goal.priority 0..0 high-priority | medium-priority | low-priority
Goal.start[x] 0..0 When goal pursuit begins
Goal.target
Goal.target.id 0..0 Unique id for inter-element referencing
Goal.target.extension 0..0 Extension
Goal.target.modifierExtension 0..0 Extension
Goal.target.measure 0..0 The parameter whose value is being tracked
Goal.target.detail[x] 0..1 CodeableConcept The target value to be achieved
Goal.target.due[x] 0..0 Reach goal on or before
Goal.statusDate 0..0 When goal status took effect
Goal.statusReason 0..0 Reason for current status
Goal.expressedBy 0..0 Who's responsible for creating Goal?
Goal.addresses 0..0 Issues addressed by this goal
Goal.note 0..0 Comments about the goal
Goal.outcomeCode 0..0 What result was achieved regarding the goal?
Goal.outcomeReference 0..0 Observation that resulted from goal

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Goal 0..* Goal Describes the intended objective(s) for a patient, group or organization
Goal.id This element is included in summaries. 0..1 id Logical id of this artifact
Goal.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Goal.meta.id 0..1 string Unique id for inter-element referencing
Goal.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Goal.meta.Slices for extension.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
Goal.meta.Slices for extension.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
Goal.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Goal.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Goal.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Goal.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Goal.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Goal.meta.tag This element is included in summaries. 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".
Goal.lifecycleStatus This element is a modifier element. This element is included in summaries. 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.
Goal.description This element is included in summaries. 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.
Goal.subject This element is included in summaries. 1..1 Reference(Patient | Group | Organization) Who this goal is intended for
Goal.target C 0..* BackboneElement Target outcome for the goal
Constraints: gol-1
Goal.target.detail[x] This element is included in summaries. 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.

doco 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

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Goal 0..* Goal Describes the intended objective(s) for a patient, group or organization
Goal.lifecycleStatus This element is a modifier element. This element is included in summaries. 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.
Goal.description This element is included in summaries. 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.
Goal.subject This element is included in summaries. 1..1 Reference(Patient | Group | Organization) Who this goal is intended for

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Goal 0..* Goal Describes the intended objective(s) for a patient, group or organization
Goal.meta
Goal.meta.Slices for extension Content/Rules for all slices
Goal.meta.Slices for extension.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
Goal.meta.Slices for extension.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
Goal.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Goal.implicitRules 0..0 A set of rules under which this content was created
Goal.language 0..0 Language of the resource content
Goal.text 0..0 Text summary of the resource, for human interpretation
Goal.contained 0..0 Contained, inline Resources
Goal.extension 0..0 Extension
Goal.modifierExtension 0..0 Extension
Goal.identifier 0..0 External Ids for this goal
Goal.achievementStatus 0..0 in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Goal.category 0..0 E.g. Treatment, dietary, behavioral, etc.
Goal.priority 0..0 high-priority | medium-priority | low-priority
Goal.start[x] 0..0 When goal pursuit begins
Goal.target
Goal.target.id 0..0 Unique id for inter-element referencing
Goal.target.extension 0..0 Extension
Goal.target.modifierExtension 0..0 Extension
Goal.target.measure 0..0 The parameter whose value is being tracked
Goal.target.detail[x] 0..1 CodeableConcept The target value to be achieved
Goal.target.due[x] 0..0 Reach goal on or before
Goal.statusDate 0..0 When goal status took effect
Goal.statusReason 0..0 Reason for current status
Goal.expressedBy 0..0 Who's responsible for creating Goal?
Goal.addresses 0..0 Issues addressed by this goal
Goal.note 0..0 Comments about the goal
Goal.outcomeCode 0..0 What result was achieved regarding the goal?
Goal.outcomeReference 0..0 Observation that resulted from goal

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Goal 0..* Goal Describes the intended objective(s) for a patient, group or organization
Goal.id This element is included in summaries. 0..1 id Logical id of this artifact
Goal.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Goal.meta.id 0..1 string Unique id for inter-element referencing
Goal.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Goal.meta.Slices for extension.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
Goal.meta.Slices for extension.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
Goal.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Goal.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Goal.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Goal.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Goal.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Goal.meta.tag This element is included in summaries. 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".
Goal.lifecycleStatus This element is a modifier element. This element is included in summaries. 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.
Goal.description This element is included in summaries. 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.
Goal.subject This element is included in summaries. 1..1 Reference(Patient | Group | Organization) Who this goal is intended for
Goal.target C 0..* BackboneElement Target outcome for the goal
Constraints: gol-1
Goal.target.detail[x] This element is included in summaries. 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.

doco 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

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron