Search for organization by business identifier

General information

Purpose

Business identifiers are identifiers that exist outside of the Swedish Catalog of Organization, Offerings and Contract. While you can interact with HVOOrganizations and HVOOrganizationalUnits using their logical IDs as designated by the catalog, they can sometimes not be known. Since all organizations and organizational units in the healthcare sector have known business identifiers, these can be leveraged to interact with their corresponding records in the catalog.

Background

Organizations in Sweden can or must have different identifiers depending on where in the organizational hierarchy they are. Top level organizations or sole traders, represented in the catalog as HVOOrganizations, must have an organization identifier (sv: organisationsnummer) supplied by Bolagsverket. The ID can be either a 10 digit value or, for sole traders, a personal identity number (sv: personnummer). In the healthcare sector, organizations that are not top level but not considered units have one or more HSA identifiers.

Organizational units, represented in the catalog as HVOOrganizationalUnits, in the healthcare sector a HSA identifier.

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.

Common business identifiers for organizations in Sweden are

• organization identifier (sv: organisationsnummer) with system ID urn:oid:2.5.4.97.
• personal identity number (sv: personnummer) with system http://electronichealth.se/identifier/personnummer. This is technically also an organization identifier, but a different system ID is used so that the format of the value can be validated accordingly.
• HSA identifier with system ID urn:oid:1.2.752.29.4.19. Note that an organization can have multiple of these.

When using the Identifier datatype to consume the API, the identifier system should always be provided. This is done in the following format:

GET <base>/Organization?identifier=<system>|<value>

Examples

Search using organization identifier

Invocation

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

GET <base>/Organization?identifier=urn:oid:2.5.4.97|5565932521

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 199509203303. The system for organization identifier is http://electronichealth.se/identifier/personnummer.

GET <base>/Organization?identifier=http://electronichealth.se/identifier/personnummer|199509203303

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.