HelseID Authorization
In order to be authorized to use SFM, the client must first be authenticated using HelseID.
SFM is secured with using Authorization Code Flow.
See HelseId Selfservice documentation and developer portal to get started with HelseId.
SFM Scopes
There are two scopes that are relevant for SFM.
Scopes supporting Bearer authentication will be decommissioned and will only be available in a transition phase. |
Authentication with DPoP is only available for dedicated scopes below and version 2 of SFM apis.
Read more about DPoP on HelseID pages: DPoP.
Description | Scope | Authentication | Api version |
SFM portaler og integrasjoner2 Used for SFM Portals: SFM Data Sharing API and SFM Basis API. Requires DPoP. | e-helse:sfm.api/sfm.api2 | DPoP | v2 |
SFM migrering2 Used for the first time uploading patient and organization data from the EPJ system to SFM. Requires DPoP. | e-helse:sfm.api/sfm-migrering.api2 | DPoP | v2 |
SFM portaler og integrasjoner Used for SFM Portals: SFM Data Sharing API and SFM Basis API. Deprecated, supports only Bearer. | e-helse:sfm.api/sfm.api
| bearer | -- |
SFM migrering Used for the first time uploading patient and organization data from the EPJ system to SFM. Deprecated, supports only Bearer. | e-helse:sfm.api/sfm-migrering.api
| bearer | -- |
See versioning strategy.
Claims
Claim | Description | Mandatory |
|
| Yes |
| Must contain one of the SFM scopes | Yes |
| Mandatory for multitennant clients | Yes* |
| Only used for singletenant clients | Yes* |
| Represents national id of person that is logged in. This needs to be a Fnr or Dnr. | Yes |
| Yes | |
| Must be | Yes |
| Must always contain the top level of an organization in Brreg. | Yes |
| Recommended to be a suborganization (underenhet). | Optional |
| Indicates the owner of the HelseID client, usually vendor or supplier org. For multitennant, this number MUST correspond to a preregistered supplier in SFM. | Yes |
| is | Optional |
*Either journal-id or sfm-id must be provided
Claims documentation for HelseID can be found here.