This API specification is defined in the context of the EJPRD project, complying with the latest Beacon v2 Specification.
In this work, we present API specification for querying RD patient registries, biobanks and similar resources at the safe record level (i.e, resources whose available assets are described by RD patient data). Resources that implement this specification would ideally collect data based on the set of common data elements for rare diseases registration, as recommended by the European commission Joint Research Centre.
The request and response conforms to the Beacon Reference Framework. This Specification defines two types of endpoints - The Query Endpoints and The Informational Endpoints.
Informational Endpoints are simple GET requests without needing a request body, and respond with information relavant to this Beacon Specification. These are: /info, /configuration, /entry_types, /filtering_terms and /map. A special /service-info endpoint (also a GET request), responds with metadata relevant to this Beacon using the GA4GH ServiceInfo format.
Query Endpoints require the requester to provide a JSON body and send request using the POST method. This document defines three query endpoints to query resources using filters - /individuals, /biosamples and /catalogs.
- Query Endpoints
- Authentication using Header(s)
- Understanding the query
- Understanding the response with ranges (for /individuals and /biospecimens)
- Informational Endpoints
- Authentication Using Header for Swagger
Latest version (v4.0) of this specification is available on Swagger here: https://app.swaggerhub.com/apis-docs/DVS6_1/virtual-platform_beacon_api/v4.0