Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

Patient Care icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Patient Compartments: Patient

Search parameters for the Resource Goal - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource.

The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.


http://hl7.org/fhir/SearchParameter/Goal-achievement-status

Parameter achievement-status:token

in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable

ResourceGoal
ExpressionGoal.achievementStatus
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Goal-addresses

Parameter addresses:reference

Issues addressed by this goal

ResourceGoal
ExpressionGoal.addresses
Processing ModeNormal
Target ResourcesRiskAssessment, Procedure, Observation, MedicationStatement, ServiceRequest, MedicationRequest, Condition, NutritionOrder
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Goal-category

Parameter category:token

E.g. Treatment, dietary, behavioral, etc.

ResourceGoal
ExpressionGoal.category
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Goal-description

Parameter description:token

Code or text describing goal

ResourceGoal
ExpressionGoal.description
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

Parameter identifier:token

Goal: External Ids for this goal

ResourceGoal
ExpressionGoal.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status

Parameter lifecycle-status:token

proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected

ResourceGoal
ExpressionGoal.lifecycleStatus
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

Parameter patient:reference

Goal: Who this goal is intended for

ResourceGoal
ExpressionGoal.subject.where(resolve() is Patient)
Processing ModeNormal
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Goal-start-date

Parameter start-date:date

When goal pursuit begins

ResourceGoal
Expression(Goal.start.ofType(date))
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Goal-subject

Parameter subject:reference

Who this goal is intended for

ResourceGoal
ExpressionGoal.subject
Processing ModeNormal
Target ResourcesOrganization, Group, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Goal-target-date

Parameter target-date:date

Reach goal on or before

ResourceGoal
Expression(Goal.target.due.ofType(date))
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Goal-target-measure

Parameter target-measure:token

The parameter whose value is being tracked

ResourceGoal
ExpressionGoal.target.measure
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values