SRS-053: Provision of Clinical Parameter Endpoints
Identifier​
SRS-053
Software System​
- API Gateway
- Orchestrator
Category​
- Functional
- Input and output, interfaces
Description​
The software shall be extended to include new API endpoints for providing clinical master data to client applications under the /params/
path. These endpoints shall be protected and versioned consistently with the rest of the API.
-
Body sites endpoint: The system shall implement a
GET /params/body-sites
endpoint.- This endpoint shall return a complete, static list of all available body sites.
- Each object in the returned array shall contain a
code
and aname
object with multilingual translations.
-
Clinical signs endpoint: The system shall implement a
GET /params/clinical-signs
endpoint.- This endpoint shall return a complete list of all supported clinical signs, sourced from the system's master data.
-
Questionnaires endpoint: The system shall implement a
GET /params/questionnaires
endpoint.- This endpoint shall require a mandatory
pathology
query parameter. - It shall return a filtered list of questionnaire objects that are relevant to the specified pathology.
- If the pathology is not found or has no associated questionnaires, the endpoint shall return an empty array.
- This endpoint shall require a mandatory
Derived from PRS​
PRS-005
: Expose the device’s functionality through a versioned, network-accessible API