Organization identifiers

General information

Purpose

Business identifiers are identifiers that are used outside of a given system. These can be leveraged to interact with their corresponding instances instead of the logical IDs assigned by a server.

Structure

Business identifiers are always defined by a system ID, for example an OID or a URI. In FHIR, this is the ID that goes in the Identifier.system element. The value of the identifier goes in the Identifier.value element.

When performing search queries using a business identifier, the identifier system should always be provided. This is done in the following format:

GET [base]/Organization?identifier=[system]|[value]

Identifiers

Organizations in Sweden can or must have different identifiers depending on where in the organizational hierarchy they are.

Root organizations or sole traders, represented in this guide as HVOOrganizations, must have an identifier that is either a 10-digit organizational identifier (sv: organisationsnummer) or a 12 digit personal identity number (sv: personnummer) or coordination number (sv: samordningsnummer) as registered in Bolagsverket.

In the healthcare sector, organizations (HVOOrganization) and organizational units (HVOOrganizationalUnit) can have one or more HSA identifiers since they can occur in multiple regional catalogs. All HSA identifiers SHALL be aggregated in one instance in order to adhere to the profiles of this guide.

This guide introduces an organizational unit identifier that can be used to uniquely identify any organizational unit. The value is assigned by the Swedish National Catalog of Organizations and Businesses from the Swedish eHealth Agency, in which the same UUID is assigned both as the value of the business identifier and as the logical ID of the organizational unit in the catalog.

Summary

Examples

Search using organization identifier

Invocation

The following example shows how to search for a HVOOrganization with an organization identifier with value 5560269986. The system for organization identifier is urn:oid:2.5.4.97.

GET [base]/Organization?identifier=urn:oid:2.5.4.97|5560269986

Result

The following example shows the return body of the search above. All search queries return a Bundle, even though it is expected only to find one Organization from the query. Note that the returned Organization has the corresponding identifier.system and identifier.value as the query searched for. The link.url element shows the query as the server interpreted it.

Search using personal identity number

Invocation

The following examples shows how to search for a HVOOrganization with a personal identitiy number as an organization identifier, with value 198001032385. The system for organization identifier is http://electronichealth.se/identifier/personnummer.

GET [base]/Organization?identifier=http://electronichealth.se/identifier/personnummer|198001032385

Result

The following example shows the return body of the search above. All search queries return a Bundle, even though it is expected only to find one Organization from the query. Note that the returned Organization has the corresponding identifier.system and identifier.value as the query searched for. The link.url element shows the query as the server interpreted it.

Search using organizational unit identifier

Invocation

The following examples shows how to search for a HVOOrganizationalUnit with an organizational unit identifier with value 37b169e7-a706-40ad-ae98-3037449442a2. The system for organization identifier is http://electronichealth.se/identifier/organizationalUnit.

GET [base]/Organization?identifier=http://electronichealth.se/identifier/organizationalUnit|37b169e7-a706-40ad-ae98-3037449442a2

Result

The following example shows the return body of the search above. All search queries return a Bundle, even though it is expected only to find one Organization from the query. Note that the returned Organization has the corresponding identifier.system and identifier.value as the query searched for. The link.url element shows the query as the server interpreted it.