Fast Healthcare Interoperability Resources (FHIR) — RelatedPerson

naftiko: 1.0.0-alpha2
info:
  label: Fast Healthcare Interoperability Resources (FHIR) — RelatedPerson
  description: 'Fast Healthcare Interoperability Resources (FHIR) — RelatedPerson. 9 operations. Lead operation: Fast Healthcare
    Interoperability Resources Search all resources of type RelatedPerson based on a set of criteria. Self-contained Naftiko
    capability covering one Fhir business surface.'
  tags:
  - Fhir
  - RelatedPerson
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FHIR_API_KEY: FHIR_API_KEY
capability:
  consumes:
  - type: http
    namespace: fhir-relatedperson
    baseUri: ''
    description: Fast Healthcare Interoperability Resources (FHIR) — RelatedPerson business capability. Self-contained, no
      shared references.
    resources:
    - name: RelatedPerson
      path: /RelatedPerson
      operations:
      - name: searchrelatedperson
        method: GET
        description: Fast Healthcare Interoperability Resources Search all resources of type RelatedPerson based on a set
          of criteria
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _id
          in: query
          type: string
          description: '**Logical id of this artifact**  '
        - name: name
          in: query
          type: string
          description: '**A server defined search that may match any of the string fields in the HumanName, including family,
            give, prefix, suffix, suffix, and/or text**  '
        - name: patient
          in: query
          type: string
          description: '**The patient this related person is related to**  '
      - name: createrelatedperson
        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: RelatedPerson-_history
      path: /RelatedPerson/_history
      operations:
      - name: histtyperelatedperson
        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: RelatedPerson-rid
      path: /RelatedPerson/{rid}
      operations:
      - name: readrelatedperson
        method: GET
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updaterelatedperson
        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: patchrelatedperson
        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: deleterelatedperson
        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: RelatedPerson-rid-_history
      path: /RelatedPerson/{rid}/_history
      operations:
      - name: histinstrelatedperson
        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: RelatedPerson-rid-_history-hid
      path: /RelatedPerson/{rid}/_history/{hid}
      operations:
      - name: vreadrelatedperson
        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-relatedperson-rest
    port: 8080
    description: REST adapter for Fast Healthcare Interoperability Resources (FHIR) — RelatedPerson. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/relatedperson
      name: relatedperson
      description: REST surface for RelatedPerson.
      operations:
      - method: GET
        name: searchrelatedperson
        description: Fast Healthcare Interoperability Resources Search all resources of type RelatedPerson based on a set
          of criteria
        call: fhir-relatedperson.searchrelatedperson
        with:
          _id: rest._id
          name: rest.name
          patient: rest.patient
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrelatedperson
        description: Fast Healthcare Interoperability Resources Create a new resource
        call: fhir-relatedperson.createrelatedperson
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/relatedperson/history
      name: relatedperson-history
      description: REST surface for RelatedPerson-_history.
      operations:
      - method: GET
        name: histtyperelatedperson
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        call: fhir-relatedperson.histtyperelatedperson
        with:
          _since: rest._since
          _at: rest._at
          _list: rest._list
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/relatedperson/{rid}
      name: relatedperson-rid
      description: REST surface for RelatedPerson-rid.
      operations:
      - method: GET
        name: readrelatedperson
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        call: fhir-relatedperson.readrelatedperson
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterelatedperson
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        call: fhir-relatedperson.updaterelatedperson
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchrelatedperson
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        call: fhir-relatedperson.patchrelatedperson
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterelatedperson
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        call: fhir-relatedperson.deleterelatedperson
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/relatedperson/{rid}/history
      name: relatedperson-rid-history
      description: REST surface for RelatedPerson-rid-_history.
      operations:
      - method: GET
        name: histinstrelatedperson
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        call: fhir-relatedperson.histinstrelatedperson
        with:
          _since: rest._since
          _at: rest._at
          _list: rest._list
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/relatedperson/{rid}/history/{hid}
      name: relatedperson-rid-history-hid
      description: REST surface for RelatedPerson-rid-_history-hid.
      operations:
      - method: GET
        name: vreadrelatedperson
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        call: fhir-relatedperson.vreadrelatedperson
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fhir-relatedperson-mcp
    port: 9090
    transport: http
    description: MCP adapter for Fast Healthcare Interoperability Resources (FHIR) — RelatedPerson. 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 RelatedPerson based on a set of
        criteria
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fhir-relatedperson.searchrelatedperson
      with:
        _id: tools._id
        name: tools.name
        patient: tools.patient
      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-relatedperson.createrelatedperson
      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-relatedperson.histtyperelatedperson
      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-relatedperson.readrelatedperson
      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-relatedperson.updaterelatedperson
      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-relatedperson.patchrelatedperson
      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-relatedperson.deleterelatedperson
      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-relatedperson.histinstrelatedperson
      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-relatedperson.vreadrelatedperson
      outputParameters:
      - type: object
        mapping: $.