Fast Healthcare Interoperability Resources (FHIR) — Goal

naftiko: 1.0.0-alpha2
info:
  label: Fast Healthcare Interoperability Resources (FHIR) — Goal
  description: 'Fast Healthcare Interoperability Resources (FHIR) — Goal. 9 operations. Lead operation: Fast Healthcare Interoperability
    Resources Search all resources of type Goal based on a set of criteria. Self-contained Naftiko capability covering one
    Fhir business surface.'
  tags:
  - Fhir
  - Goal
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FHIR_API_KEY: FHIR_API_KEY
capability:
  consumes:
  - type: http
    namespace: fhir-goal
    baseUri: ''
    description: Fast Healthcare Interoperability Resources (FHIR) — Goal business capability. Self-contained, no shared references.
    resources:
    - name: Goal
      path: /Goal
      operations:
      - name: searchgoal
        method: GET
        description: Fast Healthcare Interoperability Resources Search all resources of type Goal based on a set of criteria
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: description
          in: query
          type: string
          description: '**The code or text describing the goal**'
        - name: lifecycle-status
          in: query
          type: string
          description: '**proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected**  '
        - name: patient
          in: query
          type: string
          description: '**Who this goal is intended for**  '
        - name: target-date
          in: query
          type: string
          description: '**Reach goal on or before**  '
      - name: creategoal
        method: POST
        description: Fast Healthcare Interoperability Resources Create a new resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: Goal-_history
      path: /Goal/_history
      operations:
      - name: histtypegoal
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          description: Only include resource versions that were current at some point during the time period specified in
            the date time value (see Search notes on date searching)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
    - name: Goal-rid
      path: /Goal/{rid}
      operations:
      - name: readgoal
        method: GET
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategoal
        method: PUT
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchgoal
        method: PATCH
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletegoal
        method: DELETE
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: Goal-rid-_history
      path: /Goal/{rid}/_history
      operations:
      - name: histinstgoal
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          description: Only include resource versions that were current at some point during the time period specified in
            the date time value (see Search notes on date searching)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
    - name: Goal-rid-_history-hid
      path: /Goal/{rid}/_history/{hid}
      operations:
      - name: vreadgoal
        method: GET
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: fhir-goal-rest
    port: 8080
    description: REST adapter for Fast Healthcare Interoperability Resources (FHIR) — Goal. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/goal
      name: goal
      description: REST surface for Goal.
      operations:
      - method: GET
        name: searchgoal
        description: Fast Healthcare Interoperability Resources Search all resources of type Goal based on a set of criteria
        call: fhir-goal.searchgoal
        with:
          description: rest.description
          lifecycle-status: rest.lifecycle-status
          patient: rest.patient
          target-date: rest.target-date
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategoal
        description: Fast Healthcare Interoperability Resources Create a new resource
        call: fhir-goal.creategoal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/goal/history
      name: goal-history
      description: REST surface for Goal-_history.
      operations:
      - method: GET
        name: histtypegoal
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        call: fhir-goal.histtypegoal
        with:
          _since: rest._since
          _at: rest._at
          _list: rest._list
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/goal/{rid}
      name: goal-rid
      description: REST surface for Goal-rid.
      operations:
      - method: GET
        name: readgoal
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        call: fhir-goal.readgoal
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updategoal
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        call: fhir-goal.updategoal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchgoal
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        call: fhir-goal.patchgoal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegoal
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        call: fhir-goal.deletegoal
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/goal/{rid}/history
      name: goal-rid-history
      description: REST surface for Goal-rid-_history.
      operations:
      - method: GET
        name: histinstgoal
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        call: fhir-goal.histinstgoal
        with:
          _since: rest._since
          _at: rest._at
          _list: rest._list
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/goal/{rid}/history/{hid}
      name: goal-rid-history-hid
      description: REST surface for Goal-rid-_history-hid.
      operations:
      - method: GET
        name: vreadgoal
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        call: fhir-goal.vreadgoal
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fhir-goal-mcp
    port: 9090
    transport: http
    description: MCP adapter for Fast Healthcare Interoperability Resources (FHIR) — Goal. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: fast-healthcare-interoperability-resources-search
      description: Fast Healthcare Interoperability Resources Search all resources of type Goal based on a set of criteria
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fhir-goal.searchgoal
      with:
        description: tools.description
        lifecycle-status: tools.lifecycle-status
        patient: tools.patient
        target-date: tools.target-date
      outputParameters:
      - type: object
        mapping: $.
    - name: fast-healthcare-interoperability-resources-create
      description: Fast Healthcare Interoperability Resources Create a new resource
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fhir-goal.creategoal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fast-healthcare-interoperability-resources-read
      description: Fast Healthcare Interoperability Resources Read the past states of the resource
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fhir-goal.histtypegoal
      with:
        _since: tools._since
        _at: tools._at
        _list: tools._list
      outputParameters:
      - type: object
        mapping: $.
    - name: fast-healthcare-interoperability-resources-read-2
      description: Fast Healthcare Interoperability Resources Read the current state of the resource
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fhir-goal.readgoal
      outputParameters:
      - type: object
        mapping: $.
    - name: fast-healthcare-interoperability-resources-update
      description: Fast Healthcare Interoperability Resources Update the current state of the resource
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fhir-goal.updategoal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fast-healthcare-interoperability-resources-change
      description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
        - a series of change commands
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fhir-goal.patchgoal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fast-healthcare-interoperability-resources-delete
      description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc)
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fhir-goal.deletegoal
      outputParameters:
      - type: object
        mapping: $.
    - name: fast-healthcare-interoperability-resources-read-3
      description: Fast Healthcare Interoperability Resources Read the past states of the resource
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fhir-goal.histinstgoal
      with:
        _since: tools._since
        _at: tools._at
        _list: tools._list
      outputParameters:
      - type: object
        mapping: $.
    - name: fast-healthcare-interoperability-resources-read-4
      description: Fast Healthcare Interoperability Resources Read a past state of the resource
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fhir-goal.vreadgoal
      outputParameters:
      - type: object
        mapping: $.