Ovok · Schema

PostFhirR4GoalRequest

CompanyHealthcareFHIRDigital HealthAPI Platform

Properties

Name	Type	Description
id	string	Logical id of this artifact
meta	string	Metadata about the resource
implicitRules	string	A set of rules under which this content was created
language	string	Language of the resource content
text	string	Text summary of the resource, for human interpretation
contained	string	Contained, inline Resources
extension	string	Additional content defined by implementations
modifierExtension	string	Extensions that cannot be ignored
identifier	string	External Ids for this goal
lifecycleStatus	string	proposed \| planned \| accepted \| active \| on-hold \| completed \| cancelled \| entered-in-error \| rejected
achievementStatus	string	in-progress \| improving \| worsening \| no-change \| achieved \| sustaining \| not-achieved \| no-progress \| not-attainable
category	string	E.g. Treatment, dietary, behavioral, etc.
priority	string	high-priority \| medium-priority \| low-priority
description	string	Code or text describing goal
subject	string	Who this goal is intended for
start[x]	string	When goal pursuit begins
target	string	Target outcome for the goal
statusDate	string	When goal status took effect
statusReason	string	Reason for current status expressed
expressedBy	string	Who's responsible for creating Goal?
addresses	string	Issues addressed by this goal
note	string	Comments about the goal
outcomeCode	string	What result was achieved regarding the goal?
outcomeReference	string	Observation that resulted from goal

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ovok/json-schema/ovok-post-fhir-r4-goal-request-schema.json",
  "title": "PostFhirR4GoalRequest",
  "x-generated": "2026-11-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/ovok-openapi-generated.yml#/components/schemas/PostFhirR4GoalRequest",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Logical id of this artifact"
    },
    "meta": {
      "type": "string",
      "description": "Metadata about the resource"
    },
    "implicitRules": {
      "type": "string",
      "description": "A set of rules under which this content was created"
    },
    "language": {
      "type": "string",
      "description": "Language of the resource content"
    },
    "text": {
      "type": "string",
      "description": "Text summary of the resource, for human interpretation"
    },
    "contained": {
      "type": "string",
      "description": "Contained, inline Resources"
    },
    "extension": {
      "type": "string",
      "description": "Additional content defined by implementations"
    },
    "modifierExtension": {
      "type": "string",
      "description": "Extensions that cannot be ignored"
    },
    "identifier": {
      "type": "string",
      "description": "External Ids for this goal"
    },
    "lifecycleStatus": {
      "type": "string",
      "description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected"
    },
    "achievementStatus": {
      "type": "string",
      "description": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable"
    },
    "category": {
      "type": "string",
      "description": "E.g. Treatment, dietary, behavioral, etc."
    },
    "priority": {
      "type": "string",
      "description": "high-priority | medium-priority | low-priority"
    },
    "description": {
      "type": "string",
      "description": "Code or text describing goal"
    },
    "subject": {
      "type": "string",
      "description": "Who this goal is intended for"
    },
    "start[x]": {
      "type": "string",
      "description": "When goal pursuit begins"
    },
    "target": {
      "type": "string",
      "description": "Target outcome for the goal"
    },
    "statusDate": {
      "type": "string",
      "description": "When goal status took effect"
    },
    "statusReason": {
      "type": "string",
      "description": "Reason for current status expressed"
    },
    "expressedBy": {
      "type": "string",
      "description": "Who's responsible for creating Goal?"
    },
    "addresses": {
      "type": "string",
      "description": "Issues addressed by this goal"
    },
    "note": {
      "type": "string",
      "description": "Comments about the goal"
    },
    "outcomeCode": {
      "type": "string",
      "description": "What result was achieved regarding the goal?"
    },
    "outcomeReference": {
      "type": "string",
      "description": "Observation that resulted from goal"
    }
  },
  "required": [
    "lifecycleStatus",
    "description",
    "subject"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/ovok-post-fhir-r4-goal-request"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.