US-Core CI Build

This page is part of the US Core (v0.0.0: STU1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

D.4.1 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:

  • Record or query for 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

  • [Goal-1]Gaol-goal-1.html)

D.4.1.1 Formal Views of Profile Content

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 Health Level Seven International (FHIR-Infrastructure).

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

Complete Summary of the Mandatory Requirements

  1. A status in Goal.status which has an 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 ?!S1..1codeproposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target | entered-in-error
Binding: GoalStatus (required)
... category ∑0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority ∑0..1CodeableConcepthigh | medium |low
Binding: GoalPriority (preferred)
... description S1..1CodeableConceptCode or text describing goal
Binding: (unbound) (example)
... subject S1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] ∑0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target[x] ∑0..1date, DurationReach goal on or before
... statusDate ∑0..1dateWhen goal status took effect
... statusReason 0..*CodeableConceptReason for current status
Binding: GoalStatusReason (example)
... expressedBy ∑0..1Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Who's responsible for creating Goal?
... addresses 0..*Reference(Condition), Reference(Observation), Reference(MedicationStatement), Reference(NutritionRequest), Reference(ProcedureRequest), Reference(RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcome I0..*BackboneElementWhat result was achieved regarding the goal?
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... result[x] 0..1CodeableConcept, Reference(Observation)Code or observation that resulted from goal
Binding: (unbound) (example)

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. A status in Goal.status which has an 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 ?!S1..1codeproposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target | entered-in-error
Binding: GoalStatus (required)
... category ∑0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority ∑0..1CodeableConcepthigh | medium |low
Binding: GoalPriority (preferred)
... description S1..1CodeableConceptCode or text describing goal
Binding: (unbound) (example)
... subject S1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] ∑0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target[x] ∑0..1date, DurationReach goal on or before
... statusDate ∑0..1dateWhen goal status took effect
... statusReason 0..*CodeableConceptReason for current status
Binding: GoalStatusReason (example)
... expressedBy ∑0..1Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Who's responsible for creating Goal?
... addresses 0..*Reference(Condition), Reference(Observation), Reference(MedicationStatement), Reference(NutritionRequest), Reference(ProcedureRequest), Reference(RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcome I0..*BackboneElementWhat result was achieved regarding the goal?
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... result[x] 0..1CodeableConcept, Reference(Observation)Code or observation that resulted from goal
Binding: (unbound) (example)

doco Documentation for this format

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

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Argonaut Search Criteria for StructureDefinition-us-core-goal

Clients

  • A client has connected to a server and fetched all of a patient’s goals using GET [base]/Goal?patient=[id].
  • A client has connected to a server and fetched all of a patient’s goals over a specified time period using GET [base]/Goal?patient=[id]&date=[date]{&date=[date]}.

Servers

  • A server is capable of returning all of a patient’s goals using GET [base]/Goal?patient=[id].

  • A server is capable of returning all of all of a patient’s goals over a specified time period using GET [base]/Goal?patient=[id]&date=[date]{&date=[date]}.

  • A server has ensured that every API request includes a valid Authorization token, supplied via:Authorization: Bearer {server-specific-token-here}
  • A server has rejected any unauthorized requests by returning an HTTP 401 Unauthorized response code.

GET /Goal?patient=[id]

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

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/Goal?patient=1137192

GET /Goal?patient=[id]&date=[date]{&date=[date]}[edit]

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

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/Goal?patient=1137192&date=ge2015-01-14

GET https://fhir-open-api-dstu2.smarthealthit.org/Goal?patient=1137192&date=ge2015-01-14&date=le2016-01-14