NextGen Healthcare

NextGen Healthcare Goal API

https://hl7.org/fhir/R4/goal.html

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /fhir/r4/Goal/{id} Get one patient goal · Get fhir r4 goal by id #
Ask an LLM
“Can I fetch one patient goal by its id?”
“What does a single Goal record describe?”
Tell an agent
Get goal {id}.
Show the target described in patient goal {id}.
GET /fhir/r4/Goal List a patient's health goals · Get fhir r4 goal #
Ask an LLM
“What health goals are set for a patient?”
“Can I see a patient's goals for a particular date?”
Tell an agent
List health goals for patient {patient}.
Show patient {patient}'s goals as of {date}.

Documentation

📖
Documentation
https://www.nextgen.com/api/regulatory-ngo
📖
APIReference
https://petstore.swagger.io/?url=https://hfstatic.s3.amazonaws.com/swagger/swaggerR4.yaml
📖
APIReference
https://petstore.swagger.io/?url=https://hfstatic.s3.amazonaws.com/swagger/Bulk-API-R4-Swagger.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nextgen-healthcare/refs/heads/main/openapi/nextgen-healthcare-goal-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/nextgen-healthcare/refs/heads/main/json-schema/nextgen-healthcare-goal-bundled-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/nextgen-healthcare/refs/heads/main/json-schema/nextgen-healthcare-goal-schema.json

Other Resources

🔗
CapabilityStatement
https://raw.githubusercontent.com/api-evangelist/nextgen-healthcare/refs/heads/main/fhir/nextgen-office-r4-capabilitystatement.json
🔗
SMARTConfiguration
https://raw.githubusercontent.com/api-evangelist/nextgen-healthcare/refs/heads/main/fhir/nextgen-office-r4-smart-configuration.json
🔗
OpenIDConfiguration
https://raw.githubusercontent.com/api-evangelist/nextgen-healthcare/refs/heads/main/fhir/nextgen-office-openid-configuration.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/nextgen-healthcare:nextgen-healthcare-goal-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

nextgen-healthcare-goal-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: NextGen Office FHIR Goal API
  description: 'Our API is coded against the US Core Specification (FHIR Version: 4.0.0) https://hl7.org/fhir/us/core/CapabilityStatement-server.html'
  contact:
    email: nextgen-office-api@nextgen.com
servers:
- url: https://fhir.meditouchehr.com/api/
security:
- OauthSecurity:
  - patient/*.read
tags:
- name: Goal
  description: https://hl7.org/fhir/R4/goal.html
paths:
  /fhir/r4/Goal/{id}:
    get:
      tags:
      - Goal
      description: 'Fetches a single Goal by id.


        FHIR Resource: Goal

        * Patient Goals'
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Goal'
        '404':
          $ref: '#/components/responses/ResourceNotFound404'
        '401':
          $ref: '#/components/responses/ResourceNotAuthorized401'
      summary: Get fhir r4 goal by id
      x-summary-source: derived
      operationId: getFhirR4GoalById
      x-operation-id-source: derived
  /fhir/r4/Goal:
    get:
      tags:
      - Goal
      description: 'Fetches a bundled resource containing the health concern goals for the patient mentioned in the request.


        FHIR Resource: Goal

        * Patient Goals'
      parameters:
      - $ref: '#/components/parameters/patient_id'
      - $ref: '#/components/parameters/date'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalBundled'
        '404':
          $ref: '#/components/responses/ResourceNotFound404'
        '401':
          $ref: '#/components/responses/ResourceNotAuthorized401'
      summary: Get fhir r4 goal
      x-summary-source: derived
      operationId: getFhirR4Goal
      x-operation-id-source: derived
components:
  parameters:
    id:
      description: The id of the resource
      name: id
      in: path
      required: true
      schema:
        type: string
    patient_id:
      description: The id of the patient
      name: patient
      in: query
      required: true
      schema:
        type: string
    date:
      description: A date parameter searches on a date/time or period. The only supported prefixes are - gt, lt, ge, le, eq. Example-gt2015-01-15. See https://www.hl7.org/fhir/R4/search.html#date.
      name: date
      in: query
      schema:
        type: string
  schemas:
    Goal:
      type: object
      properties:
        resourceType:
          type: string
          minLength: 1
        id:
          type: string
          minLength: 1
        meta:
          type: object
          properties:
            profile:
              type: array
              items:
                type: string
          required:
          - profile
        lifecyclestatus:
          type: string
          description: describe the status
        description:
          type: object
          description: describe the status.
          properties:
            text:
              type: string
        subject:
          type: object
          properties:
            reference:
              type: string
        target:
          type: array
          items:
            type: object
            properties:
              due date:
                type: string
                minLength: 1
                description: Date in format - YYYY-MM-DDThh:mm:ss+zz
      required:
      - resourceType
      - id
      - meta
      - lifecyclestatus
      - description
      - subject
      - target
    GoalBundled:
      type: object
      properties:
        resourceType:
          type: string
          minLength: 1
        id:
          type: string
          minLength: 1
          description: id of the resource
        Meta:
          type: object
          description: Metadata about the resource
          properties:
            lastUpdated:
              type: string
        type:
          type: string
          minLength: 1
          description: Type of Search
        total:
          type: integer
          description: Number of Goals in entry field
        Link:
          type: object
          properties:
            relation:
              type: string
              minLength: 1
              description: relation of the resource with link provided in url
            url:
              type: string
              minLength: 1
              description: FHIR URI of the request
              required:
              - relation
              - url
        entry:
          type: array
          items:
            type: object
            properties:
              fullUrl:
                type: string
                minLength: 1
                description: FHIR URI of respective Goal resource in entry
              resource:
                $ref: '#/components/schemas/Goal'
      required:
      - resourceType
      - id
      - Meta
      - type
      - total
      - link
      - entry
  responses:
    ResourceNotFound404:
      description: Resource not found
    ResourceNotAuthorized401:
      description: Resource not authorized to be viewed by this user
  securitySchemes:
    OauthSecurity:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            openid: Open ID scope
            launch/patient: Used by clients to request a patient-scoped access token
            offline_access: Request a refresh_token that can be used to obtain a new access token to replace an expired one, and that will be usable for as long as the end-user remains online.
            patient/*.read: Read access to all Patient Resources
          authorizationUrl: https://idp-prod.prod.ngo.nextgenaws.net/auth/realms/nextgen/protocol/openid-connect/auth?aud=https://fhir.meditouchehr.com/api/fhir/r4
          tokenUrl: https://idp-prod.prod.ngo.nextgenaws.net/auth/realms/nextgen/protocol/openid-connect/token
      description: Access code based oauth authentication
externalDocs:
  description: Find out more about NextGen Office FHIR API
  url: https://www.nextgen.com/products-and-services/nextgen-office