Goal
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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Goal/[id] |
| Vread | GET | /fhir/R4/Goal/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Goal/[id] |
| Patch | PATCH | /fhir/R4/Goal/[id] |
| Delete | DELETE | /fhir/R4/Goal/[id] |
| Create | POST | /fhir/R4/Goal |
| Search | GET | /fhir/R4/Goal |
| History | GET | /fhir/R4/Goal/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | External Ids for this goal |
lifecycleStatus | code | 1..1 | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
achievementStatus | CodeableConcept | 0..1 | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
category | CodeableConcept | 0..* | E.g. Treatment, dietary, behavioral, etc. |
priority | CodeableConcept | 0..1 | high-priority | medium-priority | low-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 |
expressedBy | Reference | 0..1 | Who's responsible for creating Goal? |
addresses | Reference | 0..* | Issues addressed by this goal |
note | Annotation | 0..* | Comments about the goal |
outcomeCode | CodeableConcept | 0..* | What result was achieved regarding the goal? |
outcomeReference | Reference | 0..* | Observation that resulted from goal |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
achievement-status | token | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
category | token | E.g. Treatment, dietary, behavioral, etc. |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
lifecycle-status | token | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
patient | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for |
start-date | date | When goal pursuit begins |
subject | reference | Who this goal is intended for |
target-date | date | Reach goal on or before |
Reference
Official FHIR R4 spec: Goal.
Maturity: Trial Use 2 (FMM 2).