Skip to content

Unified Directory

Text indexed fields (used for $search op)

  • name
  • description

Facets (therefore optimized for exact filtering):

  • type
  • ref.* except ref.id
  • tags

Read ops

  • $search: string. filter entries using a searchstring
    sh
    GET /bff/unified-directory?$search=foo
    GET /bff/unified-directory?$search=foo
  • location: string <lat>,<lng>,<radius-in-km-defaults-to-5>. filter entries w/in a given radius. requires $search op to work
    sh
     GET /bff/unified-directory?$search=*&location=48.86093481609114,2.33698396872901,10
     GET /bff/unified-directory?$search=*&location=48.86093481609114,2.33698396872901,10

Tags

Additional tags that can be used for searching

for type=organization, service types offered are tags with prefix sto:

typescript
type UnifiedDirectoryEntry {
 type: 'organization'
 ref: {
   id: 'some-org-id'
   type: 'facility'
   types: ['clinic',
 }
 tags: ['sto:clinic-consultation', 'sto:dignostic', 'sto:dental']
}
type UnifiedDirectoryEntry {
 type: 'organization'
 ref: {
   id: 'some-org-id'
   type: 'facility'
   types: ['clinic',
 }
 tags: ['sto:clinic-consultation', 'sto:dignostic', 'sto:dental']
}

Released under the MIT License.