Orion Health FHIR API — DocumentReference

naftiko: 1.0.0-alpha2
info:
  label: Orion Health FHIR API — DocumentReference
  description: 'Orion Health FHIR API — DocumentReference. 2 operations. Lead operation: Orion Health Search for document
    references. Self-contained Naftiko capability covering one Orion business surface.'
  tags:
  - Orion
  - DocumentReference
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORION_API_KEY: ORION_API_KEY
capability:
  consumes:
  - type: http
    namespace: fhir-documentreference
    baseUri: https://api.orionhealth.com/fhir
    description: Orion Health FHIR API — DocumentReference business capability. Self-contained, no shared references.
    resources:
    - name: DocumentReference
      path: /DocumentReference
      operations:
      - name: searchdocumentreferences
        method: GET
        description: Orion Health Search for document references
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: patient
          in: query
          type: string
          description: Reference to the patient
        - name: type
          in: query
          type: string
          description: Document type code
        - name: category
          in: query
          type: string
          description: Document category
        - name: date
          in: query
          type: string
          description: Document date or date range
        - name: status
          in: query
          type: string
          description: Document status
    - name: DocumentReference-id
      path: /DocumentReference/{id}
      operations:
      - name: getdocumentreference
        method: GET
        description: Orion Health Read a document reference by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ORION_API_KEY}}'
  exposes:
  - type: rest
    namespace: fhir-documentreference-rest
    port: 8080
    description: REST adapter for Orion Health FHIR API — DocumentReference. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/documentreference
      name: documentreference
      description: REST surface for DocumentReference.
      operations:
      - method: GET
        name: searchdocumentreferences
        description: Orion Health Search for document references
        call: fhir-documentreference.searchdocumentreferences
        with:
          patient: rest.patient
          type: rest.type
          category: rest.category
          date: rest.date
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documentreference/{id}
      name: documentreference-id
      description: REST surface for DocumentReference-id.
      operations:
      - method: GET
        name: getdocumentreference
        description: Orion Health Read a document reference by ID
        call: fhir-documentreference.getdocumentreference
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fhir-documentreference-mcp
    port: 9090
    transport: http
    description: MCP adapter for Orion Health FHIR API — DocumentReference. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: orion-health-search-document-references
      description: Orion Health Search for document references
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fhir-documentreference.searchdocumentreferences
      with:
        patient: tools.patient
        type: tools.type
        category: tools.category
        date: tools.date
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: orion-health-read-document-reference
      description: Orion Health Read a document reference by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fhir-documentreference.getdocumentreference
      outputParameters:
      - type: object
        mapping: $.