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
devhttps://api.sandbox.ovok.com/fhir/R5/Goal
| Interaction | Method | Path |
|---|
| Read | GET | /fhir/R5/Goal/[id] |
| Vread | GET | /fhir/R5/Goal/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/Goal/[id] |
| Patch | PATCH | /fhir/R5/Goal/[id] |
| Delete | DELETE | /fhir/R5/Goal/[id] |
| Create | POST | /fhir/R5/Goal |
| Search | GET | /fhir/R5/Goal?... |
| History | GET | /fhir/R5/Goal/[id]/_history |
| Type-history | GET | /fhir/R5/Goal/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|
identifier | Identifier | 0..* | External Ids for this goal |
lifecycleStatus | code | 1..1 | proposed |
achievementStatus | CodeableConcept | 0..1 | in-progress |
category | CodeableConcept | 0..* | E.g. Treatment, dietary, behavioral, etc |
continuous | boolean | 0..1 | After meeting the goal, ongoing activity is needed to sustain the goal objective |
priority | CodeableConcept | 0..1 | high-priority |
description | CodeableConcept | 1..1 | Code or text describing goal |
subject | Reference | 1..1 | Who this goal is intended for |
start[x] | date / CodeableConcept | 0..1 | When goal pursuit begins |
target | BackboneElement | 0..* | Target outcome for the goal |
statusDate | date | 0..1 | When goal status took effect |
statusReason | string | 0..1 | Reason for current status |
source | Reference | 0..1 | Who's responsible for creating Goal? |
addresses | Reference | 0..* | Issues addressed by this goal |
note | Annotation | 0..* | Comments about the goal |
outcome | CodeableReference | 0..* | What result was achieved regarding the goal? |
Resource-specific search parameters
| Parameter | Type | Description |
|---|
achievement-status | token | in-progress |
addresses | reference | Issues addressed by this goal |
category | token | E.g. Treatment, dietary, behavioral, etc. |
description | token | Code or text describing goal |
identifier | token | Account number |
| | |
lifecycle-status | token | proposed |
patient | reference | The entity that caused the expenses |
| | |
start-date | date | When goal pursuit begins |
subject | reference | Who this goal is intended for |
target-date | date | Reach goal on or before |
target-measure | token | The parameter whose value is being tracked |
Reference
- Official FHIR R5 spec:
Goal
- Maturity: Trial Use 2 (FMM 2).