HiMS API Documentation

The Goal resource represents a desired health state to be achieved for a patient, for example weight loss or restoring activities of daily living. This resource can also apply to a group of patients or an organization. However, here at One Medical, the Goal resource will primarily be used for patient goals.

The Goal resource returns data classes and elements defined for Goals in United States Core Data for Interoperability (USCDI v2) including Patient Goals, and SDOH Goals.

Example API requests for goal records are shown below:

Retrieve all goals related to a patient

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/Goal?patient={patientId}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/Goal?patient=29355
                    

Response schema

{
  "type": "object",
  "required": [],
  "properties": {
    "resourceType": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "link": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "relation": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "entry": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "fullUrl": {
            "type": "string"
          },
          "resource": {
            "type": "object",
            "required": [],
            "properties": {
              "resourceType": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "meta": {
                "type": "object",
                "required": [],
                "properties": {
                  "versionId": {
                    "type": "string"
                  },
                  "lastUpdated": {
                    "type": "string"
                  },
                  "profile": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              },
              "lifecycleStatus": {
                "type": "string"
              },
              "achievementStatus": {
                "type": "object",
                "required": [],
                "properties": {
                  "coding": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "system": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              },
              "description": {
                "type": "object",
                "required": [],
                "properties": {
                  "coding": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "system": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "text": {
                    "type": "string"
                  }
                }
              },
              "subject": {
                "type": "object",
                "required": [],
                "properties": {
                  "reference": {
                    "type": "string"
                  }
                }
              },
              "target": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "measure": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "text": {
                          "type": "string"
                        }
                      }
                    },
                    "dueDate": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}