The Goal resource implements the FHIR R4 Goal specification and US Core v3.1.1 Goal profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   External Ids for this goal
lifecycleStatus code 1..1 * proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding
achievementStatus code 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(US Core Patient Profile) 1..1 * Who this goal is intended for
startDate date 0..1   When goal pursuit begins
startCodeableConcept CodeableConcept 0..1   When goal pursuit begins
target BackboneElement 0..*   Target outcome for the goal
target.dueDate date 0..1   Reach goal on or before
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

Interactions

Read

Get an Goal entry by id

GET /Goal/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Goal/b26d2f04-d854-4551-80b9-1d60be7d094c

Response

{
  "resourceType": "Goal",
  "lifecycleStatus": "active",
  "description": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "281004",
        "display": "Alcoholic dementia"
      }
    ],
    "text": "Alcoholic dementia"
  },
  "subject": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
  },
  "target": [
    {
      "dueDate": "2022-06-17"
    }
  ],
  "id": "b26d2f04-d854-4551-80b9-1d60be7d094c"
}

Query Goal resources

GET /Goal?:query_parameters

Parameters

Name Type Description
patient reference Who this goal is intended for
subject reference Who this goal is intended for
start-date date When goal pursuit begins
category token E.g. Treatment, dietary, behavioral, etc.
lifecycleStatus token proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
achievementStatus token in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found