Specifications of the Personal Health Record

Specifications of the Personal Health Record

The general specifications of Kanta PHR regardless of the data contents are presented on this page. The individual specifications for data contents are listed at the beginning of the page.

Specifications for individual data contents

Please click the link to access specifications for individual data contents.

General specifications for all data content

Functional specifications, data contents and interfaces regardless of the data content are described in the tables.​​​

Table: Use cases and requirements for citizen’s server applications as graphs
Specifications Description
Use case of access token retrieval (pdf, in Finnish)

Descriptions and requirements of the most common use cases from the point of view of a server application that can be integrated into PHR.

Similar descriptions and requirements will come later for the professional applications as well.

Use case of authorization (pdf, in Finnish) No description.
Use case of resource saving (pdf, in Finnish) No description.
Use case of resource updating (pdf, in Finnish) No description.
Use case of retrieving and reading resource (pdf, in Finnish) No description.

 

Table: Use cases and requirements for citizen’s server applications in accessible text format
Specifications Description
Use case of access token retrieval (pdf, in Finnish)

Descriptions and requirements of the most common use cases from the point of view of a server application that can be integrated into PHR.

Similar descriptions and requirements will come later for the professional applications as well.

Use case of authorization (pdf, in Finnish) No description.
Use case of resource saving (pdf, in Finnish) No description.
Use case of resource updating (pdf, in Finnish) No description.
Use case of retrieving and reading resource (pdf, in Finnish) No description.
Instructions related to the search function (pdf) No description.
Authorization guide (pdf) No description.
Instructions for the versioning data content (pdf, in Finnish). No description.
Table: PHR Data content
Data content Description
STU3 FHIR profiles of PHR (simplifier.net)

All PHR data contents are based on HL7 FHIR standard and all well-being data stored in PHR must comply the HL7 FHIR profiles approved in national data content of the PHR. All profiles can be found in the Finnish PHR project from Simplifier FHIR registry.

At the moment, PHR supports STU3 and R4 versions side by side.

R4 FHIR profiles of PHR (simplifier.net) At the moment, PHR supports STU3 and R4 versions side by side.
Different profile statuses can be found from this Simplifier table (simplifier.net) Not all profiles in Simplifier are yet in production use.
FHIR profiles and data content of PHR in implementation guide (simplifier.net)

More information from profiles can be found from PHR's implementation guide.

The information content is developed in cooperation with different actors. Read more about national data content development.

Table: PHR Interfaces
Interfaces Description
Capability Statement STU3 (simplifier.net) PHR's Capability Statement is available at the Simplifier-profile register Finnish PHR project. It describes the REST interactions supported by the platform and the available Search Parameters.
Capability Statement R4 (simplifier.net) PHR's Capability Statement is available at the Simplifier-profile register Finnish PHR project. It describes the REST interactions supported by the platform and the available Search Parameters.
FHIR-standard RESTful API (hl7.org) More information about the interfaces according to the FHIR standard can be found on the standard's own pages.
Last updated 27.04.2022