| Info |
|---|
Service endpoints depend Endpoints vary depending on the eHealth Infrastructure environment. Each service has a base URL specific to the environment (e.g., production, test). See service base URLs on the subpage for each environment linked from https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/488439810/Environments#List-of-eHealth-environments.on Environments. |
FHIR Server-based Services
The FHIR server-based services provide endpoints as described in according to the FHIR RESTful API section Service Base URL depending specification. These endpoints are based on the service's base URL and depend on which resource types and operations they support and their service base URLthe server supports. The FHIR resource types, supported operations supported, and more supported by other capabilities of a FHIR server-based service are described documented in it’s its Capability Statement.its
See FHIR RESTful API section Service Base URL
| Info |
|---|
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 provides storage for storing properties and configuration values that do not fit into cannot be stored within the FHIR-based infrastructure.
...
Service | API | Service Base URL | Endpoints | Description |
|---|---|---|---|---|
Key Value Store | https://kvstore. | {base url}/properties/{application} - see API | Variants for creating and reading the 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 creates, stores, and manages 128-bit encryption keys. The These keys issued by the service are meant for encrypting a user's Refresh Token and/or are designed to encrypt user Refresh Tokens and Client Credentials obtained from a during successful login flow to store the tokens securely on a device in a way that leaves accessing the tokens by flows. This encryption enables secure storage of tokens on devices while making brute force attacks infeasible.
Service | API | Service Base URL | Endpoints | Description |
|---|---|---|---|---|
Key Service | https://keyservice. | {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 ID - deletes a key associated with a key ID.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
. |
[environment].ehealth.sundhed.dk/v1{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
https://ssl-catalogue.{environment}.ehealth.sundhed.dk/v1
{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
Make 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