Page History
...
This usage scenario is supported by the operation ConsentRegistrationsGet in the original version of the consent administration interface.
This usage scenario is supported by the operation ConsentRegistrationsGetV2 in the new version of the consent administration interfaceConsentRegistrationsGet.
The result of the operation is a complete list of all active and inactive consent registrations for the citizen in question.
...
Another person than the citizen can, on behalf of the citizen, perform the activity. As the action entails an entry in the citizen’s Min-log, the citizen will later be able to learn of the action performed by the person.
This usage scenario is supported by the operation ConsentAdd in the original version of the consent administration interface.
This usage scenario is supported by the operation ConsentAdd ConsentAddPositiveV2 in the new version of the consent administration interface.
Registration of Positive Consent
...
This usage scenario is supported by the operation ConsentAdd.ConsentAdd in the original version of the consent administration interface.
This usage scenario is supported by the operation ConsentAddConstraintV2 in the new version of the consent administration interface.
Citizen Modifies Citizen Modifies Consent
A citizen can change one or more positive or negative consent registrations.
...
This usage scenario is supported by the operation ConsentModifyConsentModify in the original version of the consent administration interface.
This usage scenario is supported by the operations ConsentModifyPositiveV2 or ConsentModifyConstraintV2 in the new version of the consent administration interface.
Citizen Nullifies Consent
...
This usage scenario is supported by the operation ConsentRevoke.
Consent Administration Web Service
Reading Guide
ConsentRevoke in the original version of the consent administration interface.
This usage scenario is supported by the operation ConsentRevokeV2 in the new version of the consent administration interface.
Consent Administration Web Service
Reading Guide
The template below is The template below is used to document the operations that are offered in the Consent Administration Web Service. The most important elements for input and output are described in section 5.
Name: <operation header> | |
---|---|
Description: | Description of the function’s purpose. |
Input: | Input parameters. |
Output: | Output parameters. |
Error handling: | Description of error handling; typically refers to the general description of error handling in 4.7. |
Roles: | Description of necessary roles. |
Prerequisites: | Description of prerequisites that must be met for the function to complete successfully. |
Web Service - Consent_Administration (Original)
Operation – ConsentRegistrationsGet
Name: ConsentRegistrationsGet | |
---|---|
Description: | Retrieves descriptions of all registrations of consents applicable to given citizen. |
Input: | ConsentRegistrationsGetRequest which consists of: PatientPersonCivilRegistrationIdentifier Identification of the citizen for which consent registrations are desired |
Output: | ConsentRegistrationsGetResponse which consists of: ConsentRegistrations Collection of all active and inactive consent registrations registered for citizen in question. |
Error handling: | See section 4.7. |
Roles: | Citizen, person (on behalf of citizen) |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. |
Operation – ConsentAdd
in section 4.2.1. |
Operation – ConsentAdd
Name: ConsentAdd | |
---|---|
Description: | Adds active consent/active consents applicable to given citizen. |
Input: | ConsentAddRequest which consists of: ConsentAdds Collection of descriptions of registrations of consents, that are to be added. Note that the citizen is identified in ConsentAdds. |
Output: | Nothing |
Error handling: | See section 4.7. |
Roles: | Citizen, health professional, person (on behalf of citizen). |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. The operation is not idempotent and on repeated calls with identical parameters, multiple identical consents will be created (see section 1.6). |
Operation – ConsentModify
Name: ConsentModify | |
---|---|
Description: | Updates consent(s) from the collection of consents applicable to given citizen. |
Input: | ConsentModifyRequest which consists of: ConsentModifications Collection of descriptions of consents, that are desired modified. Note that the citizen is identified in ConsentModification. |
Output: | Nothing |
Error handling: | See section 4.7. |
Roles: | Citizen, person (on behalf of the citizen) |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. |
Operation – ConsentRevoke
Name: ConsentRevoke | |
---|---|
Description: | Revokes given consent(s) from the collection of consents applicable to the provided citizen. This takes place by inactivation of the revoked consents. |
Input: | PatientConsentRevokeRequest which consists of: ConsentRevocations Collection of descriptions of consents, that are to be revoked. Note that the citizen is identified in ConsentRevocation. |
Output: | Nothing |
Error handling: | See section 4.7. |
Roles: | Citizen |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. |
Web Service - Consent_Administration (V2)
Operation – ConsentRegistrationsGetV2
Name: ConsentRegistrationsGet | |
---|---|
Description: | Retrieves descriptions of all registrations of consents applicable to given citizen. |
Input: | ConsentRegistrationsGetRequest which consists of: PatientPersonCivilRegistrationIdentifier Identification of the citizen for which consent registrations are desired |
Output: | ConsentRegistrationsGetResponse which consists of: ConsentRegistrations Collection of all active and inactive consent registrations registered for citizen in question. |
Error handling: | See section 4.7. |
Roles: | Citizen, person (on behalf of citizen) |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. |
Operation – ConsentAddPositiveV2
Name: ConsentAddPositiveV2 | |
---|---|
Description: | Adds a positive active consent/active consents applicable to given citizen. |
Input: | ConsentAddPositiveV2Request which consists of: ConsentAdds Collection of descriptions of registrations of consents, that are to be added. Note that the citizen is identified in ConsentAdds. |
Output: | Nothing |
Error handling: | See section 4.7. |
Roles: | Citizen, health professional, person (on behalf of citizen). |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. The operation is not idempotent and on repeated calls with identical parameters, multiple identical consents will be created (see section 1.6). |
Operation – ConsentAddConstraintV2
Name: ConsentAddPositiveV2 | |
---|---|
Description: | Adds a constraining active consent/active consents applicable to given citizen. |
Input: | ConsentAddConstraintV2Request which consists of: ConsentAdds Collection of descriptions of registrations of consents, that are to be added. Note that the citizen is identified in ConsentAdds. |
Output: | Nothing |
Error handling: | See section 4.7. |
Roles: | Citizen, health professional, person (on behalf of citizen). |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. The operation is not idempotent and on repeated calls with identical parameters, multiple identical consents will be created (see section 1.6). |
Operation – ConsentModifyPositiveV2
Name: ConsentModifyPositiveV2 | |
---|---|
Description: | Updates consent(s) from the collection of |
Name: ConsentAdd
Description:
consents applicable to given citizen. |
Input: |
---|
ConsentModifyPositiveV2Request which consists of: |
ConsentModifications Collection of descriptions of |
consents, that are |
desired modified. Note that the citizen is identified in |
ConsentModification. | |
Output: | Nothing |
---|---|
Error handling: | See section 4.7. |
Roles: | Citizen |
, person (on behalf of the citizen) |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. |
---|
Operation –
...
ConsentModifyConstraintV2
Name: |
---|
ConsentModifyConstraintV2 | |
---|---|
Description: | Updates consent(s) from the collection of consents applicable to given citizen. |
Input: |
ConsentModifyConstraintV2Request which consists of: ConsentModifications Collection of descriptions of consents, that are desired modified. Note that the citizen is identified in ConsentModification. | |
Output: | Nothing |
---|---|
Error handling: | See section 4.7. |
Roles: | Citizen, person (on behalf of the citizen) |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. |
Operation –
...
ConsentRevokeV2
Name: ConsentRevoke | |
---|---|
Description: | Revokes given consent(s) from the collection of consents applicable to the provided citizen. This takes place by inactivation of the revoked consents. |
Input: | PatientConsentRevokeRequest which consists of: ConsentRevocations Collection of descriptions of consents, that are to be revoked. Note that the citizen is identified in ConsentRevocation. |
Output: | Nothing |
Error handling: | See section 4.7. |
Roles: | Citizen |
Prerequisites: | Both user system and user must be authenticated and authorized as described in section 4.2.1. |
Consent Administration Web Service Semantics
...