Organization identifiers
General information
Purpose
Business identifiers are identifiers that are used outside of a given system. Since all Swedish organizations and organizational units in the healthcare sector have known business identifiers, these can be leveraged to interact with their corresponding instances instead of the logical IDs assigned by a server.
Background
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 organization identifier (sv: organisationsnummer) supplied by Bolagsverket. The organization identifier can be either a 10 digit value or, for sole traders, a 12 digit personal identity number (sv: personnummer). In the healthcare sector, organizations that are not root organizations but not considered units have one or more HSA identifiers. Organizational units, represented in this guide as HVOOrganizationalUnits, have one or more HSA identifiers in the healthcare sector.
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 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]
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.
| Bundle |
| id : SearchResultOrganizationIdentifier |
| type : searchset |
| total : 1 |
| link |
| relation : self |
| url : [base]/Organization?identifier=urn%3Aoid%3A2.5.4.97%7C5560269986 |
| entry |
| resource |
| id : OrganizationInstance1 |
| meta |
| profile : http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization |
| extension |
| url : http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension |
| value : True |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/organization-period |
| value |
| start : 2000-06-14 |
| extension |
| url : http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationLegalFormExtension |
| value |
| system : http://electronichealth.se/CodeSystem/skatteverket-jurform |
| code : 49 |
| display : Övriga aktiebolag |
| extension |
| url : http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationOwnershipExtension |
| value |
| system : http://electronichealth.se/CodeSystem/organization-ownership-scb |
| code : 42 |
| display : Privat svenskkontrollerade enheter med koncerntillhörighet |
| identifier |
| system : urn:oid:2.5.4.97 |
| value : 5565932521 |
| type |
| coding |
| system : http://snomed.info/sct |
| version : http://snomed.info/sct/45991000052106 |
| code : 143591000052106 |
| display : vårdgivare |
| name : Meliva Vårdcentral Söderdoktorn AB |
| contact |
| purpose |
| coding |
| system : http://terminology.hl7.org/CodeSystem/contactentity-type |
| code : ADMIN |
| display : Administrativt |
| address |
| line : Wollmar Yxkullsgatan 25 |
| city : Stockholm |
| postalCode : 118 50 |
| country : Sverige |
| period |
| start : 2000-06-14T00:00:00+01:00 |
| contact |
| purpose |
| coding |
| system : http://terminology.hl7.org/CodeSystem/contactentity-type |
| code : PATINF |
| display : Patient |
| telecom |
| system : url |
| value : https://meliva.se/vardcentral-soderdoktorn/ |
| period |
| start : 2022-01-01T00:00:00+01:00 |
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.
| Bundle |
| id : SearchResultPersonalIdentityNumber |
| type : searchset |
| total : 1 |
| link |
| relation : self |
| url : [base]/Organization?identifier=http%3A%2F%2Felectronichealth.se%2Fidentifier%2Fpersonnummer%7C198001032385 |
| entry |
| resource |
| id : SoleTraderOrganization1 |
| meta |
| profile : http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization |
| extension |
| url : http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension |
| value : True |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/organization-period |
| value |
| start : 1970-01-01T00:00:00+01:00 |
| extension |
| url : http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationLegalFormExtension |
| value |
| system : http://electronichealth.se/CodeSystem/skatteverket-jurform |
| code : 10 |
| extension |
| url : http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationOwnershipExtension |
| value |
| system : http://electronichealth.se/CodeSystem/organization-ownership-scb |
| code : 41 |
| identifier |
| system : http://electronichealth.se/identifier/personnummer |
| value : 198001032385 |
| type |
| coding |
| system : http://snomed.info/sct |
| version : http://snomed.info/sct/45991000052106 |
| code : 143591000052106 |
| name : SoleTrader |