SFM product version
The product version is to provide step-wise introduction of new features for the systems using the SFM GUI. This must not be confused with the API versioning (see below).
Version of the API is not necessarily mapped to product versions of functionality in SFM. SFM changes may be also be reflected in the content of resources in this API, without change in the API version. Major changes in SFM will be announced in SFM roadmap. In addition NHN informs in Vendor Webinars, NHN status pages and slack channels. Minor changes will be analyzed for consequences and communicated to relevant system vendors and users.
See Release notes for SFM product versions.
API version
A new api versioning strategy has been introduced for all endpoints with introduction of DPoP authentication. Be aware that API versioning is separate from SFM product version. There might be breaking changes without new api versions.
API version 2 (requires DPoP authentication)
Api v2 is dependent on mininum product version 4.32.
1) Endpoints that contain /api i url path will be versioned by adding /v2 after /api
/api/path → /api/v2/pathExamples:
/api/v2/Session/create
/api/v2/PatientTicket
api/v2/user/clearPin
2) Endpoints that do not contain /api will be versioned by adding /v2 at the beginning
Example:
/files →/v2/files
Example:
/Organization → /v2/Organization
This ensures a consistent and predictable structure for all new endpoints.