Actors and Capabilities

This section describes the interoperability domains covered in this guide as well as the included actors and capabilities of each domain. Each domain includes a summary of the involved actors as well as detailed descriptions of each transaction. In addition to text descriptions, each actor and their needed capabilities are also structured on the resources ActorDefinition and CapabilityStatement on referred subpages.

Organizational structure

This section defines the actors and transactions covered in this implementation guide. The figure below shows the actors involved in exchanging organizational structures and the relevant transactions between them.

Descriptions of actors

Actor name	Description	Realization example
Organizational Unit Hierarchy Writer	The Organizational Unit Hierarchy Writer Actor can create and update information about the organizational units of an organization along with the businesses they operate and the services they provide.	System used by care giver to provide the VOK (Verksamhet- och organisationskatalogen) service with information.
Organization Repository	The Organization Repository Actor can store queryable information about organizations and organizational units along with the businesses they operate and the services they provide.	VOK (Verksamhet- och organisationskatalogen) developed by the Swedish eHealth Agency.

For further details on each actor and what capabilities they support, see sub pages Organizational Unit Hierarchy Writer and Organization Repository.

Transactions

Create

For an organizational unit hierarchy writer to create a HVOOrganizationalUnit, the CRUD operation create can be used. This transaction is made possible through the create operation. Please follow the link for more details.

The organization repository SHALL NOT allow for a HVOOrganization to be created this way.

Update

For an organizational unit hierarchy writer to update a HVOOrganizationalUnit or a HVOOrganization, the CRUD operation update can be used.

The organization repository SHALL apply business logic to allow only information not fetched from official sources to be updated on a HVOOrganization. Please see the update operation for HVOOrganization for more details.

For rules that apply for HVOOrganizationalUnits, see the update operation for HVOOrganizationalUnit.

Create/update with transaction

For an organizational unit hierarchy writer to create and/or update more than one Organization instance in one transaction, a transaction Bundle can be used. This is made possible through the create transaction of the HVOOrganizationTransactionBundle. Please follow the link for more details.

Read

FOr an organizational unit hierarchy writer to fetch an existing Organization instance, the CRUD operation read can be used. This transaction is made possible through the read operation. See reading HVOOrganizationalUnit by logical ID and reading HVOOrganizationalUnit by logical ID.

Note that the organization repository shall also support search using parameters. This may be used by an Organization Reader actor. The Organization Reader will be added in future versions.