US Core Implementation Guide (Release 1.1.0 Ballot )

This page is part of the US Core (v1.1.0: STU2 Ballot 1) 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

SD.9 StructureDefinition-us-core-goal

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:

  • Query for a Patient’s Goals
  • Record or update a Patient’s Goals
Mandatory Data Elements and Terminology

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:

  1. a status
  2. text description of the goal
  3. a patient

Profile specific implementation guidance:

  • none

Examples

SD.9.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal

Published on Mon Aug 01 00:00:00 AEST 2016 as a draft by HL7 US Realm Steering Committee.

This profile builds on Goal

Complete Summary of the Mandatory Requirements

  1. A status in Goal.status which has a required binding to:
  2. A text description in Goal.description.text
  3. A patient reference in Goal.subject
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*US Core Goal Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... status ?!SΣ1..1codeproposed | 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..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description SΣ1..1CodeableConceptCode or text describing goal
Binding: SNOMED CT Clinical Findings (example)
... subject SΣ1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] Σ0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target I0..1BackboneElementTarget outcome for the goal
gol-1: Goal.target.measure is required if Goal.target.detail is populated
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... measure ΣI0..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINC Codes (example)
.... detail[x] ΣI0..1Quantity, Range, CodeableConceptThe target value to be achieved
Binding: (unbound) (example)
.... due[x] Σ0..1date, DurationReach goal on or before
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy Σ0..1Reference(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..*AnnotationComments about the goal
... outcomeCode 0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMED CT Clinical Findings (example)
... outcomeReference 0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. A status in Goal.status which has a required binding to:
  2. A text description in Goal.description.text
  3. A patient reference in Goal.subject

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*US Core Goal Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... status ?!SΣ1..1codeproposed | 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..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description SΣ1..1CodeableConceptCode or text describing goal
Binding: SNOMED CT Clinical Findings (example)
... subject SΣ1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] Σ0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target I0..1BackboneElementTarget outcome for the goal
gol-1: Goal.target.measure is required if Goal.target.detail is populated
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... measure ΣI0..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINC Codes (example)
.... detail[x] ΣI0..1Quantity, Range, CodeableConceptThe target value to be achieved
Binding: (unbound) (example)
.... due[x] Σ0..1date, DurationReach goal on or before
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy Σ0..1Reference(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..*AnnotationComments about the goal
... outcomeCode 0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMED CT Clinical Findings (example)
... outcomeReference 0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

SD.9.2 Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions 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:

  • GET [base]/Goal?patient=1137192&date=ge2015-01-14
  • GET [base]/Goal?patient=1137192&date=ge2015-01-14&date=le2016-01-14

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).