FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

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
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Goal-addresses

Parameter addresses:reference

Issues addressed by this goal

ResourceGoal
ExpressionGoal.addresses
Processing ModeNormal
Target ResourcesNutritionIntake, RiskAssessment, Procedure, Observation, MedicationStatement, ServiceRequest, MedicationRequest, Condition, NutritionOrder
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Goal-category

Parameter category:token

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

ResourceGoal
ExpressionGoal.category
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Goal-description

Parameter description:token

Code or text describing goal

ResourceGoal
ExpressionGoal.description
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
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
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
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
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
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
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Goal-start-date

Parameter start-date:date

When goal pursuit begins

ResourceGoal
Expression(Goal.start.ofType(date))
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
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
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
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
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
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
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true