This page is part of the US Core (v1.0.0: STU1) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions
This profile sets minimum expectations for the Goal resource to record, search and fetch Goal information associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the US Core-Goal profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Goal must have:
Profile specific implementation guidance:
The official URL for this profile is:
http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal
This profile builds on Goal.
This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by HL7 US Realm Steering Committee.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Goal.status
which has a required binding to:
Goal.description.text
Goal.subject
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | US Core Goal Profile | ||
status | S | 1..1 | code | Binding: GoalStatus (required) |
description | S | 1..1 | CodeableConcept | |
subject | S | 1..1 | Reference(US Core Patient Profile) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | I | 0..* | US Core Goal Profile | |
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: Common Languages (extensible) | |
text | I | 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 | |
status | ?!SΣ | 1..1 | code | proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected Binding: GoalStatus (required) |
category | Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMED CT Clinical Findings (example) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
start[x] | Σ | 0..1 | date, CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
target | I | 0..1 | BackboneElement | Target outcome for the goal gol-1: Goal.target.measure is required if Goal.target.detail is populated |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
measure | ΣI | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINC Codes (example) |
detail[x] | ΣI | 0..1 | Quantity, Range, CodeableConcept | The target value to be achieved Binding: (unbound) (example) |
due[x] | Σ | 0..1 | date, Duration | Reach goal on or before |
statusDate | Σ | 0..1 | date | When goal status took effect |
statusReason | 0..1 | string | Reason for current status | |
expressedBy | Σ | 0..1 | Reference(Patient), Reference(Practitioner), Reference(RelatedPerson) | Who's responsible for creating Goal? |
addresses | 0..* | Reference(Condition), Reference(Observation), Reference(MedicationStatement), Reference(NutritionOrder), Reference(ProcedureRequest), Reference(RiskAssessment) | Issues addressed by this goal | |
note | 0..* | Annotation | Comments about the goal | |
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMED CT Clinical Findings (example) | |
outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |
Documentation for this format |
Goal.status
which has a required binding to:
Goal.description.text
Goal.subject
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | US Core Goal Profile | ||
status | S | 1..1 | code | Binding: GoalStatus (required) |
description | S | 1..1 | CodeableConcept | |
subject | S | 1..1 | Reference(US Core Patient Profile) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | I | 0..* | US Core Goal Profile | |
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: Common Languages (extensible) | |
text | I | 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 | |
status | ?!SΣ | 1..1 | code | proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected Binding: GoalStatus (required) |
category | Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMED CT Clinical Findings (example) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
start[x] | Σ | 0..1 | date, CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
target | I | 0..1 | BackboneElement | Target outcome for the goal gol-1: Goal.target.measure is required if Goal.target.detail is populated |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
measure | ΣI | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINC Codes (example) |
detail[x] | ΣI | 0..1 | Quantity, Range, CodeableConcept | The target value to be achieved Binding: (unbound) (example) |
due[x] | Σ | 0..1 | date, Duration | Reach goal on or before |
statusDate | Σ | 0..1 | date | When goal status took effect |
statusReason | 0..1 | string | Reason for current status | |
expressedBy | Σ | 0..1 | Reference(Patient), Reference(Practitioner), Reference(RelatedPerson) | Who's responsible for creating Goal? |
addresses | 0..* | Reference(Condition), Reference(Observation), Reference(MedicationStatement), Reference(NutritionOrder), Reference(ProcedureRequest), Reference(RiskAssessment) | Issues addressed by this goal | |
note | 0..* | Annotation | Comments about the goal | |
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMED CT Clinical Findings (example) | |
outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.
GET /Goal?patient=[id]
Example: GET [base]/Goal?patient=1137192
Support: Mandatory to support search by patient.
Implementation Notes: Search for all goals for a patient. Fetches a bundle of all Goal resources for the specified patient. (how to search by reference).
GET /Goal?patient=[id]&date=[date]{&date=[date]}[edit]
Example:
Support: Mandatory to support search by date.
Implementation Notes: Search for all goals for a patient within a time period. Fetches a bundle of all Goal resources for the specified patient with a specified time period. (how to search by reference) and (how to search by date).