SFM Basis API Implementation Guide

Organization

Oganizations will have to be registered to SFM in advance of normal operations. SFM needs information about the Organization presented in access token to populate information needed in communication with Reseptformidleren and Kjernejournal.

There is business logic in the SFM to register organisations as a part of SFM to Reseptformidleren whenever necessary.

The sfm-Organization profile on Organization shall be used.

Access to operation on this resource is granted by presenting a token with a personal identity matching a known Person(sfm-Person) written to SFM in advance.

Organization

  • create
  • read
  • update
  • delete - Operation is avaliable, but will generally report error.

When creating or updating an organization resource, the minimum required fields are:

  • Profile: sfm-Organization

  • Identifier (ENH) - The organisations id in Enhetsregisteret (Organisasjonsnummer/Virksomhetsnummer)

  • active (true or false)

  • name (as registered in Enhetsregisteret) If an organisation registered in Reseptformidleren:

  • Identifier (HERid) - The ID used by the organisation to communicate with Reseptformidleren (may be an organisation or a service (Forskrivning) If the Organisation is a part of another organisation:

  • partOf (with reference to already registered "parent"

Seach operations supported:

GET [base]/Organization?name=<string> - match for resources containing the string in Organization name

GET [base]/Organization?identifier=<string> - match for resources containing the string in identifier (ENH/RSH/HERid)

GET [base]/Organization - return all organisations within the actual domain

active=true|false may be given as a parameter to limit the search.

To search for an identifier within a specific set, these special searches are implemented:

GET [base]/Organization?identifier=<system>|<string>

where <system> is one of:

urn:oid:2.16.578.1.12.4.1.4.101 for ENH

urn:oid:2.16.578.1.12.4.1.4.102 for RSH (=RESH)

urn:oid:2.16.578.1.12.4.1.2 for HERid

For more info see info page for OID in Norway: https://ehelse.no/teknisk-dokumentasjon/oid-identifikatorserier-i-helse-og-omsorgstjenesten

Result paging is not supported.

Profile

sfm-Organization

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
id0..1
id0..1
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueDateTimedateTime
url1..1Fixed Value
id0..1
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
id0..1
extensionI0..*Extension
url1..1Fixed Value
valueStringstring
url1..1Fixed Value
url1..1Fixed Value
modifierExtension?! I0..*Extension
id0..1
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeS Σ ?!0..1boolean
id0..1
extensionI0..*Extension
id0..1
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameS Σ I0..1string
alias0..*string
telecomS I0..*ContactPoint
addressS I0..*no-basis-Address
partOfS Σ I0..1Reference(Organization | no-basis-Organization)
id0..1
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1no-basis-Address
endpointI0..*Reference(Endpoint)