Response Code

Overview

When PKB returns an error, we will try to include an OperationOutcome with a meaningful error code.

Definition

CodeDisplayDefinition
ACC_TOKEN_EXPIREDAccess token expiredYour access token has expired. If you have a refresh token, you can use this to try to obtain a new access token.
ACCESS_FROZEN_INWARDAccess frozen inwardThe medical record you are trying to access has had its access frozen.
ACCESS_FROZEN_OUTWARDAccess frozen outwardThe patient who is making the request has had their access frozen.
API_SESSION_EXPIREDAPI session expiredSome API sessions expire after a predefined amount of time. If your session has expired you are not able to use an existing access token, and you are not able to use a refresh token to obtain a new access token.
API_SESSION_INVALIDAPI session invalidAn API session can be invalidated for a few reasons. For example, if a refresh token is used more than once.
BAD_AUTHENTICATIONBad authenticationYou did not provide a valid access token. For example, perhaps you forgot to include the Authorization header with your request.
NO_ASSOCIATIONNo associationYou have no association to the target data.
NO_CONSENTNo consentYou do not have consent to access the target data, and BTG is not active.
NO_DECRYPT_KEYNo decrypt keyYou do not have decryption access to the target data.
SHARING_DISABLEDSharing disabledSharing has been disabled for the target medical record.
USER_TYPE_NOT_PERMUser type not permittedThe FHIR endpoint is not available to your user type.
Comments