Skip to main content

Discovery of organizations and endpoints

TODODiscovery of Organizations and Endpoints

Once organizations have activated themselves for a use case (covered in previous chapters), they become discoverable. This chapter focuses exclusively on how clients find organizations and their service endpoints using the Service Discovery API:

GET /internal/discovery/v1/{serviceID}

This API returns all organizations registered for a given service, optionally filtered by search parameters. It is the primary mechanism for discovering:

  • Which organizations participate in your use case
  • What endpoints they expose (FHIR URL, OAuth server, etc.)

Example

For instance, to search the "eOverdracht" service for a care organization that contains "Thuiszorg" in its name, perform the following HTTP query:

GET /internal/discovery/v1/eOverdracht?credentialSubject.organization.name=*Thuiszorg*

Could yield (some fields omitted for brevity):

[
  {
    "credential_subject_id": "did:web:example.com",
    "fields": {
       "organization_name": "Thuiszorg de Zonnebloem"
    },
    "id": "did:web:example.com#1",
    "registrationParameters": {
      "fhirBaseURL": "https://example.com/fhir"
    },
    "vp": {
      // etc
    }
  }
]

What fields and registrationParameters are returned depends on the use case. Review the use case's Discovery Service's Presentation Definition for more information.

Back to top