Skip to main content

Goal

Trial Use 2 Clinical — Summary

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Goal
InteractionMethodPath
ReadGET/fhir/R4/Goal/[id]
VreadGET/fhir/R4/Goal/[id]/_history/[vid]
UpdatePUT/fhir/R4/Goal/[id]
PatchPATCH/fhir/R4/Goal/[id]
DeleteDELETE/fhir/R4/Goal/[id]
CreatePOST/fhir/R4/Goal
SearchGET/fhir/R4/Goal
HistoryGET/fhir/R4/Goal/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*External Ids for this goal
lifecycleStatuscode1..1proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected modifier
achievementStatusCodeableConcept0..1in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
categoryCodeableConcept0..*E.g. Treatment, dietary, behavioral, etc.
priorityCodeableConcept0..1high-priority | medium-priority | low-priority
descriptionCodeableConcept1..1Code or text describing goal
subjectReference1..1Who this goal is intended for
start[x]date / CodeableConcept0..1When goal pursuit begins
targetBackboneElement0..*Target outcome for the goal
statusDatedate0..1When goal status took effect
statusReasonstring0..1Reason for current status
expressedByReference0..1Who's responsible for creating Goal?
addressesReference0..*Issues addressed by this goal
noteAnnotation0..*Comments about the goal
outcomeCodeCodeableConcept0..*What result was achieved regarding the goal?
outcomeReferenceReference0..*Observation that resulted from goal

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
achievement-statusstringhttp://hl7.org/fhir/SearchParameter/Goal-achievement-status
categorystringhttp://hl7.org/fhir/SearchParameter/Goal-category
descriptionstringhttp://hl7.org/fhir/us/core/SearchParameter/us-core-goal-description
identifierstringhttp://hl7.org/fhir/SearchParameter/clinical-identifier
lifecycle-statusstringhttp://hl7.org/fhir/SearchParameter/Goal-lifecycle-status
patientstringhttp://hl7.org/fhir/SearchParameter/clinical-patient
start-datestringhttp://hl7.org/fhir/SearchParameter/Goal-start-date
subjectstringhttp://hl7.org/fhir/SearchParameter/Goal-subject
target-datestringhttp://hl7.org/fhir/SearchParameter/Goal-target-date

Reference​

  • Official FHIR R4 spec: Goal
  • Maturity: Trial Use 2 (FMM 2).