Argonaut Data Query Implementation Guide Version 1.0.0

This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-argo-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 Argonaut Goal profile:

  • Query for Goals belonging to a Patient
  • Record Goals belonging to a Patient
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 patient
  2. text description of the goal
  3. a status

Profile specific implementation guidance:

  • none

Examples

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://fhir.org/guides/argonaut/StructureDefinition/argo-goal

This profile builds on Goal.

This profile was published on Tue Oct 18 00:00:00 AEDT 2016 as a draft by Argonaut Project.

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

Complete Summary of the Mandatory Requirements

  1. A patient reference in Goal.subject
  2. A text description in Goal.description
  3. A status in Goal.status which has an required binding to:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*Argonaut 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: IETF BCP-47 (required)
... 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
... subject S1..1Reference(Argonaut 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
... category Σ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... description S1..1stringWhat's the desired outcome?
... status ?!S1..1codeproposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
Binding: GoalStatus (required)
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1CodeableConceptReason for current status
Binding: GoalStatusReason (example)
... author Σ0..1Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Who's responsible for creating Goal?
... priority Σ0..1CodeableConcepthigh | medium |low
Binding: GoalPriority (preferred)
... 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
... outcome 0..*BackboneElementWhat was end result of goal?
.... id 0..1idxml: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 patient reference in Goal.subject
  2. A text description in Goal.description
  3. A status in Goal.status which has an required binding to:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*Argonaut 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: IETF BCP-47 (required)
... 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
... subject S1..1Reference(Argonaut 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
... category Σ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... description S1..1stringWhat's the desired outcome?
... status ?!S1..1codeproposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
Binding: GoalStatus (required)
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1CodeableConceptReason for current status
Binding: GoalStatusReason (example)
... author Σ0..1Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Who's responsible for creating Goal?
... priority Σ0..1CodeableConcepthigh | medium |low
Binding: GoalPriority (preferred)
... 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
... outcome 0..*BackboneElementWhat was end result of goal?
.... id 0..1idxml: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 for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.

GET /Goal?patient=[id]

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/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).

Response Class:

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

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

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

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