R6 Ballot (3rd Draft) FHIR CI-Build

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes ). The current version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

9.6.13 Resource Goal - Search Parameters

Maturity Level : N/A
Responsible Owner: Patient Care icon Work Group   Trial Use Normative Security Category : Patient Compartments : Group , Patient

Search parameters for the Goal 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

Generated Narrative: SearchParameter Goal-achievement-status

9.6.14 achievement-status

Parameter achievement-status : token

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

Resource Goal
Expression Goal.achievementStatus
Processing Mode Normal
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

Generated Narrative: SearchParameter Goal-addresses

9.6.15 addresses

Parameter addresses : reference

Issues addressed by this goal

Resource Goal
Expression Goal.addresses
Processing Mode Normal
Target Resources NutritionIntake , 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

Generated Narrative: SearchParameter Goal-category

9.6.16 category

Parameter category : token

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

Resource Goal
Expression Goal.category
Processing Mode Normal
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

Generated Narrative: SearchParameter Goal-description

9.6.17 description

Parameter description : token

Code or text describing goal

Resource Goal
Expression Goal.description
Processing Mode Normal
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

Generated Narrative: SearchParameter clinical-identifier

9.6.18 identifier

Parameter identifier : token

Goal : External Ids for this goal

Resource Goal
Expression Goal.identifier
Processing Mode Normal
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

Generated Narrative: SearchParameter Goal-lifecycle-status

9.6.19 lifecycle-status

Parameter lifecycle-status : token

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

Resource Goal
Expression Goal.lifecycleStatus
Processing Mode Normal
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

Generated Narrative: SearchParameter clinical-patient

9.6.20 patient

Parameter patient : reference

Goal : Who this goal is intended for

Resource Goal
Expression Goal.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources 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-start-date

Generated Narrative: SearchParameter Goal-start-date

9.6.21 start-date

Parameter start-date : date

When goal pursuit begins

Resource Goal
Expression (Goal.start.ofType(date))
Processing Mode Normal
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
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Goal-subject

Generated Narrative: SearchParameter Goal-subject

9.6.22 subject

Parameter subject : reference

Who this goal is intended for

Resource Goal
Expression Goal.subject
Processing Mode Normal
Target Resources Organization , 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

Generated Narrative: SearchParameter Goal-target-date

9.6.23 target-date

Parameter target-date : date

Reach goal on or before

Resource Goal
Expression (Goal.target.due.ofType(date))
Processing Mode Normal
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
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Goal-target-measure

Generated Narrative: SearchParameter Goal-target-measure

9.6.24 target-measure

Parameter target-measure : token

The parameter whose value is being tracked

Resource Goal
Expression Goal.target.measure
Processing Mode Normal
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