PTS API Release Notes
All notable changes to the PTS API will be documented in this file.
Subscribe to notifications on #ext-utv-pts on Slack to be notified when we announce new releases.
You'll also notice we often use icons to visualize our changes and their effect, but we've limited ourselves to the following;
- ๐ฑ New Feature
- ๐ Improvement
- ๐ง Bug Fix
- ๐ฅ Breaking Change
- ๐ Security
PTS API v0.5
Changes to how associate-parent handles $.cause
These changes only affect POST /v0.5/access-restrictions/patient-safety/associate-parent, and you can still set $.cause for v0.3 and v0.4.
- ๐ The
$.causefield is no longer required- This value is automatically set to
Derivedif a child restriction was created from its parent. Behaviour has not changed, and as such$.delayDeliveryUntilis still calculated based on the associated parent's$.delayDaysand the specified$.delayFromTime. There are are also scenarios where this value isn't calculated, e.g. if the confidentiality code of the parent isN.
- This value is automatically set to
Changes to routes
These changes affect all routes.
- ๐ฅ The route for patient safety has changed from
/access-restrictions/patient-safetyto/v0.5/access-restrictions/patient-safety, and as such we no longer require theapi-versionheader. The older versions, e.g.v0.3andv0.4still live on the old route and requires theapi-versionheader to switch between the two.
Changes to $.createdBy and $.createdTime
These changes only affect POST /v0.5/access-restrictions/patient-safety
- ๐ Introduced stricter validation when creating restrictions for both
RekvisisjonandSvarrapportto ensure that only well-formed restrictions are created.$.causemust be one ofManualorAutomated$.delayDayscan only be used forRekvisisjon$.delayDeliveryUntilcan only be used forSvarrapport
- ๐ฅChanged type of
$.createdByfromHealthIdIdentifiersDtoV04toAuditablePartyDtoV05since neitherOffIdnorHprNumberare available through client credentials tokens, and thus haven't been persisted. Instead the new auditable party type consits ofclientId,orgNrParent,orgNrChildandorgNrSupplieras extracted from the Helse ID token used to create or update the resource. - ๐ฅ Replaced
$.createdTimewith$.createdDateTime
PTS API v0.4
TL;DR: This version removes support for Bearer tokens and adds support for DPoP tokens
Remove support for Bearer tokens; require DPoP
- ๐ฅ Removed Bearer authentication for
/access-restrictionsendpoints - ๐ฑ๐ Added DPoP authentication for
/access-restrictionsendpoints
PTS API v0.3
Improvements
- ๐ Results for
POST /access-restrictions/patient-safety/_searchis now ordered descending by created date