Orion Health HIE API — Notifications

naftiko: 1.0.0-alpha2
info:
  label: Orion Health HIE API — Notifications
  description: 'Orion Health HIE API — Notifications. 3 operations. Lead operation: Orion Health List ADT notifications. Self-contained
    Naftiko capability covering one Orion business surface.'
  tags:
  - Orion
  - Notifications
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORION_API_KEY: ORION_API_KEY
capability:
  consumes:
  - type: http
    namespace: hie-notifications
    baseUri: https://api.orionhealth.com/hie
    description: Orion Health HIE API — Notifications business capability. Self-contained, no shared references.
    resources:
    - name: notifications
      path: /notifications
      operations:
      - name: listnotifications
        method: GET
        description: Orion Health List ADT notifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: patientId
          in: query
          type: string
        - name: type
          in: query
          type: string
        - name: organization
          in: query
          type: string
        - name: dateFrom
          in: query
          type: string
        - name: dateTo
          in: query
          type: string
        - name: status
          in: query
          type: string
    - name: notifications-subscriptions
      path: /notifications/subscriptions
      operations:
      - name: listnotificationsubscriptions
        method: GET
        description: Orion Health List notification subscriptions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createnotificationsubscription
        method: POST
        description: Orion Health Create a notification subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ORION_API_KEY}}'
  exposes:
  - type: rest
    namespace: hie-notifications-rest
    port: 8080
    description: REST adapter for Orion Health HIE API — Notifications. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/notifications
      name: notifications
      description: REST surface for notifications.
      operations:
      - method: GET
        name: listnotifications
        description: Orion Health List ADT notifications
        call: hie-notifications.listnotifications
        with:
          patientId: rest.patientId
          type: rest.type
          organization: rest.organization
          dateFrom: rest.dateFrom
          dateTo: rest.dateTo
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/subscriptions
      name: notifications-subscriptions
      description: REST surface for notifications-subscriptions.
      operations:
      - method: GET
        name: listnotificationsubscriptions
        description: Orion Health List notification subscriptions
        call: hie-notifications.listnotificationsubscriptions
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createnotificationsubscription
        description: Orion Health Create a notification subscription
        call: hie-notifications.createnotificationsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: hie-notifications-mcp
    port: 9090
    transport: http
    description: MCP adapter for Orion Health HIE API — Notifications. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: orion-health-list-adt-notifications
      description: Orion Health List ADT notifications
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hie-notifications.listnotifications
      with:
        patientId: tools.patientId
        type: tools.type
        organization: tools.organization
        dateFrom: tools.dateFrom
        dateTo: tools.dateTo
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: orion-health-list-notification-subscriptions
      description: Orion Health List notification subscriptions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hie-notifications.listnotificationsubscriptions
      outputParameters:
      - type: object
        mapping: $.
    - name: orion-health-create-notification-subscription
      description: Orion Health Create a notification subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hie-notifications.createnotificationsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.