Services and Endpoints

Services and Endpoints

Endpoints vary depending on the eHealth Infrastructure environment.

Each service has a base URL specific to the environment (e.g., production, test).

See base URLs on the subpage for each environment on Environments | List of eHealth environments.

FHIR Server-based Services

FHIR server-based services provide endpoints according to the FHIR RESTful API specification. These endpoints are based on the service's base URL and depend on which resource types and operations the server supports. The FHIR resource types, supported operations, and other capabilities of a FHIR server-based service are documented in its Capability Statement.

See FHIR RESTful API section Service Base URL

The Capability Statement for a FHIR server-based service is available at {service base URL}/metadata.

Service

FHIR Capability Statement

FHIR Service Base URL

Service

FHIR Capability Statement

FHIR Service Base URL

Careplan Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-careplan.html

https://careplan.[environment].ehealth.sundhed.dk/fhir

Device Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-device.html

https://device.[environment].ehealth.sundhed.dk/fhir

Document Query Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-document-query.html

https://document-query.[environment].ehealth.sundhed.dk/fhir

Document Transformation Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-document-transformation.html

https://document-transformation.[environment].ehealth.sundhed.dk/fhir

Library Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-library.html

https://library.[environment].ehealth.sundhed.dk/fhir

Measurement Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-measurement.html

https://measurement.[environment].ehealth.sundhed.dk/fhir

Organization Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-organization.html

https://organization.[environment].ehealth.sundhed.dk/fhir

Patient Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-patient.html

https://patient.[environment].ehealth.sundhed.dk/fhir

Plan Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-plan.html

https://plan.[environment].ehealth.sundhed.dk/fhir

Questionnaire Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-questionnaire.html

https://questionnaire.[environment].ehealth.sundhed.dk/fhir

Reporting Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-reporting.html

https://reporting.[environment].ehealth.sundhed.dk/fhir

Task Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-task.html

https://task.[environment].ehealth.sundhed.dk/fhir

Terminology Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-terminology.html

https://terminology.[environment].ehealth.sundhed.dk/fhir

Questionnaire Terminology Service

https://ehealth.sundhed.dk/fhir/CapabilityStatement-terminology.html

https://questionnaireterminology.[environment].ehealth.sundhed.dk/fhir

Key Value Store

The Key/Value Store provides storage for properties and configuration values that cannot be stored within 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

Service

API

Service Base URL

Endpoints

Description

Key Value Store

Key Value Store API

https://kvstore.[environment].ehealth.sundhed.dk

{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 creates, stores, and manages 128-bit encryption keys. These keys are designed to encrypt user Refresh Tokens and Client Credentials obtained during successful login flows. This encryption enables secure storage of tokens on devices while making brute force attacks infeasible.

Service

API

Service Base URL

Endpoints

Description

Service

API

Service Base URL

Endpoints

Description

Key Service

Key Service API

https://keyservice.{environment}.ehealth.sundhed.dk

{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.ID

{base url}/management/devices

Get devices registered for individual id - lists keys associated with a user.