Services and Endpoints
- Erik Nielsen
- malthe lange
Service endpoints depend on the eHealth Infrastructure environment. See service base URLs on the subpage for each environment linked from Environments | List of eHealth environments.
FHIR Server-based Services
The FHIR server-based services provide endpoints as described in the FHIR RESTful API section Service Base URL depending on which resource types and operations they support and their service base URL. The FHIR resource types, operations supported and more supported by a FHIR server-based service are described in it’s Capability Statement.
The Capability Statement for a FHIR server-based service is available at {service base URL}/metadata.
Key Value Store
The Key/Value Store is available for storing properties and configuration values that do not fit into the FHIR based infrastructure.
Keys and values stored in this service MUST NOT and SHALL NOT contain any clinical or personal sensitive information.
Service | API | Service Base URL | Endpoints | Description |
|---|---|---|---|---|
Key Value Store | {base url}/properties/{application} - see API | Variants for creating and reading application property area | ||
{base url}/properties/{application}/{key} | Variants for creating, updating, reading and deleting key/values in an application property area. |
Key Service
The Key Service is a service for creating, storing and accessing 128 bit keys. The keys issued by the service are meant for encrypting a user's Refresh Token and/or Client Credentials obtained from a successful login flow, in order to store the tokens securely on a device in way that leaves accessing the tokens by brute force attacks infeasible.
Service | API | Service Base URL | Endpoints | Description |
|---|---|---|---|---|
Key Service | {base url}/createKey | Request key generation. Creates a 128 bit key from a user chosen password. | ||
{base url}/key | Retrieve a key by secret - access a key from a key ID and password. | |||
{base url}/longKey | Retrieve a key by long secret - access a key from a key ID and long secret. | |||
{base url}/management/deleteDevice | Delete a key, by verification of individual id - deletes a key associated with a key ID. | |||
{base url}/management/devices | Get devices registered for individual id - lists keys associated with a user. |
Service, Support & Logistics Domain Services
Service | API | Service Base URL | Endpoints | Description |
|---|---|---|---|---|
SSL-Order Service | {base url}/order | Variants for creating, updating, patching, retrieving and deleting orders and retrieving order details and creating order notes. | ||
{base url}/orders | Search orders | |||
{base url}/order-line | Variants for creating, updating, patching, retrieving, searching and deleting order lines. | |||
{base url}/order-lines | Variants for creating, updating and searching order lines. | |||
{base url}/party | Variants for creating, updating, retrieving and searching parties (a participating body). | |||
{base url}/system/findOrCreateParty | Find or create a Party for a given organization | |||
{base url}/custom/findOrCreateParty | Find or create a Party for a given organization | |||
{base url}/contract | Variants for creating, patching, retrieving and searching contracts. | |||
{base url}/custom/hasValidContract | Check if a valid contract exists between two parties. | |||
{base url}/system/hasOpenOrder | Check if an open order exists for a careplan. | |||
SSL-Catalogue Service | {base url}/catalogue | Variants for creating, updating and retrieving a catalogue and retrieving catalogue details. | ||
{base url}/catalogues | Get catalogues. | |||
{base url}/catalogue-item | Variants for creating, updating and retrieving a catalogue item. | |||
{base url}/catalogue-items | Get catalogue items. | |||
{base url}/annotation | Variants for creating, updating and deleting an annotation. | |||
{base url}/annotations | Get annotations. | |||
{base url}/white-list | Variants for creating, retrieving, searching and deleting white-lists. | |||
{base url}/black-list | Variants for creating, retrieving, searching and deleting black-lists. | |||
{base url}/problem | Variants for creating, patching, retrieving and deleting a problem and retrieving problem details. | |||
{base url}/problems | Get all problems accessible to the current user. | |||
{base url}/package | Variants for creating, patching, retrieving and deleting a package and retrieving package details. | |||
{base url}/packages | Get all packages accessible to the current user. | |||
{base url}/catalogue/template | Download a catalogue as an excel workbook. | |||
{base url}/catalogue/import | Variants for upload an catalogue as an excel workbook and retrieving the status of catalogue import. |