CommunicationParty API (Adresseregisteret)
The CommunicationParty API contains information used to send or receive electronic communication or physical parcels in the health care sector. The CommunicationParty API will eventually replace the older SOAP API offered as part of the legacy Grunndata plattform.
The CommunicationParty API offers functionality for
- Looking up information on a single communication party using a unique identifier (herId)
- Exporting a complete local copy of the data
- Keeping the local copy up to date with events
- Looking up signing and encryption certificates used for electronic communication
- Certificate history for a communication party
Authentication and authorization
The API is secured with HelseID, and all API endpoints require a valid access
token and DPoP proof with the audience nhn:cp-api and the scope nhn:cp-api/access-v2-dpop.
For more information on HelseID and DPoP, we refer to the HelseID documentation on the NHN developer portal. Information is available in both Norwegian and English.
Datamodel
The CommunicationParty API offers both the legacy datamodel used in the Adresseregisteret SOAP API, in addition to a new and simplified datamodel.
CommunicationParty types
An entity in the communication party API can be one of the following types:
| Type | Description | Additional data |
|---|---|---|
| Organization | A top level node in the registry, connected to an organization in Brreg. Information added to the organization will be inherited by all services and persons that are connected to it. |
|
| Service | A specific service being provided by a department/group of people within an organization, for instance surgery or pediatric services. Connected to an organization with a parent herId. | Service type. This code can be from multiple code lists within the code collection S62 - "Tjenestebasert adressering" |
| Person | A specific person providing healthcare services within an organization, for instance a general practicioner ("Fastlege"). Connected to an organization with a parent herId. | HPR number from Helsepersonellregisteret. |
Use the Swagger UI to get sample responses from the API. In the test environment, these entities can be used to obtain sample data from the API:
| HerId | Name | Type | Parent organization |
|---|---|---|---|
| 59 | St. Olavs hospital HF | Organization | N/A |
| 8091120 | Røntgen - Trondheim | Service | St. Olavs hospital HF |
| 8142448 | KORREKT KARTLEGGING | Person | Flucom |
Environments
| Environment | API URL |
|---|---|
| Test | cpapi.test.grunndata.nhn.no |
| Production | cpapi.grunndata.nhn.no |