US Core Implementation Guide
8.0.0 - STU 8 United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Goal Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal Version: 8.0.0
Standards status: Trial-use Computable Name: USCoreGoalProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.28

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The US Core Goal Profile inherits from the FHIR Goal resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Goal resource to record, search, and fetch Goal information associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Goal Must Have:

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

Each Goal Must Support:

  1. start date*
  2. target date(s)*
  3. who established the goal*

*see guidance below

Profile Specific Implementation Guidance:

  • *Although both Goal.startDate and Goal.target.dueDate are marked as Must Support, the Server system is not required to support both, but SHALL support at least one of these elements. The Client application SHALL support both elements.
  • *Goals are often captured as text and communicated in Goal.description.text. When the goal is a Social Determinants of Health (SDOH) goal, use the preferred Social Determinants of Health Goals binding.
  • See the Screening and Assessments guidance page for more information when exchanging Social Determinants of Health (SDOH) Goals
  • *The profile element Goal.expressedBy communicates the individual level provenance author data corresponding to the U.S. Core Data for Interoperability (USCDI) Provenance Author Data Elements.

Usage:

Changes since version 7.0.0:

  • The data elements list has changed
  • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Goal 0..* Goal Describes the intended objective(s) for a patient, group or organization
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... lifecycleStatus ?!SΣ 1..1 code proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
    Binding: GoalLifecycleStatus (required)
    ele-1: All FHIR elements must have a @value or children
    ... description SΣ 1..1 CodeableConcept Code or text describing goal
    Binding: US Core Goal Codes (preferred): Value set to describe the Goal

    Additional BindingsPurpose
    Social Determinants of Health Goals . Preferred

    ele-1: All FHIR elements must have a @value or children
    ... subject SΣ 1..1 Reference(US Core Patient Profile) Who this goal is intended for
    ele-1: All FHIR elements must have a @value or children
    ... start[x] SΣ 0..1 When goal pursuit begins
    Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal.


    ele-1: All FHIR elements must have a @value or children
    .... startDate date
    ... target SC 0..* BackboneElement Target outcome for the goal
    ele-1: All FHIR elements must have a @value or children
    gol-1: Goal.target.measure is required if Goal.target.detail is populated
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... due[x] SΣ 0..1 Reach goal on or before
    ele-1: All FHIR elements must have a @value or children
    ..... dueDate date
    ... expressedBy SΣ 0..1 Reference(US Core Practitioner Profile) Who's responsible for creating Goal?
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Goal.lifecycleStatusrequiredGoalLifecycleStatus
    http://hl7.org/fhir/ValueSet/goal-status
    from the FHIR Standard
    Goal.descriptionpreferredUSCoreGoalCodes
    http://hl7.org/fhir/us/core/ValueSet/us-core-goal-description
    from this IG
    Goal.start[x]exampleGoalStartEvent
    http://hl7.org/fhir/ValueSet/goal-start-event
    from the FHIR Standard

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:


    Quick Start


    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a Server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    US Core Scopes

    Servers providing access to goal data SHALL support these US Core SMART Scopes:

    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support searching for all goals for a patient using the patient search parameter:

      GET [base]/Goal?patient={Type/}[id]

      Example:

      1. GET [base]/Goal?patient=1137192

      Implementation Notes: Fetches a bundle of all Goal resources for the specified patient (how to search by reference)

    Optional Search Parameters:

    The following search parameter combinations SHOULD be supported:

    1. SHOULD support searching using the combination of the patient and lifecycle-status search parameters:

      GET [base]/Goal?patient={Type/}[id]&lifecycle-status={system|}[code]

      Example:

      1. GET [base]/Goal?patient=1137192&lifecycle-status=active

      Implementation Notes: Fetches a bundle of all Goal resources for the specified patient and lifecycle-status (how to search by reference and how to search by token)

    2. SHOULD support searching using the combination of the patient and target-date search parameters:
      • including support for these target-date comparators: gt,lt,ge,le
      • including optional support for AND search on target-date (e.g.target-date=[date]&target-date=[date]]&...)

      GET [base]/Goal?patient={Type/}[id]&target-date={gt|lt|ge|le}[date]{&target-date={gt|lt|ge|le}[date]&...}

      Example:

      1. GET [base]/Goal?patient=1137192&target-date=ge2015-01-14&target-date=le2019-01-14

      Implementation Notes: Fetches a bundle of all Goal resources for the specified patient and target-date (how to search by reference and how to search by date)

    3. SHOULD support searching using the combination of the patient and description search parameters:

      GET [base]/Goal?patient={Type/}[id]&description={system|}[code]

      Example:

      1. GET [base]/Goal?patient=1137192&description=http://snomed.info/sct|1078229009

      Implementation Notes: Fetches a bundle of all Goal resources for the specified patient and description (how to search by reference and how to search by token)