C_12718_Anlage

Änderungen in I_Information_Service_Accounts.yaml

Relocation:

Operation postPackageDeliveryIncident

alt:

      description: |
       Notify an export package requestor about problems preparing the export package.</br>
       **Client**:</br>
       A client shall always invoke this operation when export package provision is not possible
       or significantly delayed.
       
       **Provider**:</br>
       The information shall be passed to the responsible actors (insurance company associated to provider)
       by proprietary means to allow suitable reactions required by the actor.
       Incidents shall cause the following behaviour:
        - noRelocationConfirmation
          - The notification about successful relocation or about incidents has not been received yet.
          Request will be closed with (re-)activation of not transferred health record.
       - relocationAborted:
         - Export package can not (no longer) be provided (severe reason or repeated missing relocation confirmation).
        Request will be closed with (re-)activation of not transferred health record.
       
       | Conditions | Status code | Error code | Remarks |
       |------------|-------------|------------|---------|
       | Successful operation | 204 |||
       | Request does not match schema | 400 | malformedRequest ||
       | No mutual TLS channel used | 403 | accessDenied ||
       | Health record does not exist | 404 | noHealthRecord | _insurantid_ unknown |
       | Request unknown (_requestid_ ) | 404 | noResource | no ongoing relocation request for this id known |
       | Any other error | 500 | internalError ||
       </br>
       | Postconditions                        | Remarks |
       |---------------------------------------|---------|
       | Incident delivered internally ||
       | Request aborted ||
      requestBody:
        required: true
        content:
          application/json:
            examples:
              Export package generation waiting for bugfix:
                value:
                  'noRelocationConfirmation'
            schema:
              description: |
               An incident about request of an export package:
                - 'noRelocationConfirmation' : waiting for relocation confirmation (any result).
                - 'relocationAborted' : can not provide export package, relocation aborted. Retry of request recommended
              type: string
              enum:
                - 'noRelocationConfirmation'
                - 'relocationAborted'

neu:

      description: |
       Notify an export package requestor about relocation rejection or problems preparing the export package.</br>
       **Client**:</br>
       A client shall always invoke this operation when export package provision is not possible
       or significantly delayed.
       
       **Provider**:</br>
       The information shall be passed to the responsible actors (insurance company associated to provider)
       by proprietary means to allow suitable reactions required by the actor.

       Incidents shall cause the following behaviour:
        - noRelocationConfirmation
          - The notification about successful relocation or about incidents has not been received yet.
          Request will be closed with (re-)activation of not transferred health record.
       - relocationAborted:
         - Export package can not (no longer) be provided (severe technical reason or repeated missing relocation confirmation).
         Request will be closed with (re-)activation of not transferred health record.
       - relocationRejected:
         - Export package will not be provided for business reasons. The whole request is rejected by exporting provider.  
     

       | Conditions | Status code | Error code | Remarks |
       |------------|-------------|------------|---------|
       | Successful operation | 204 |||
       | Request does not match schema | 400 | malformedRequest ||
       | No mutual TLS channel used | 403 | accessDenied ||
       | Health record does not exist | 404 | noHealthRecord | _insurantid_ unknown |
       | Request unknown (_requestid_ ) | 404 | noResource | no ongoing relocation request for this id known |
       | Any other error | 500 | internalError ||
       </br>
       | Postconditions                        | Remarks |
       |---------------------------------------|---------|
       | Incident delivered internally ||
       | Request aborted ||
      requestBody:
        required: true
        content:
          application/json:
            examples:
              Export package generation waiting for bugfix:
                value:
                  'noRelocationConfirmation'
            schema:
              description: |
               An incident about request of an export package:
                - 'noRelocationConfirmation' : waiting for relocation confirmation (any result).
                - 'relocationAborted' : can not provide export package, relocation aborted. Retry of request recommended
                - 'relocationRejected' : will not provide export package for business reasons, relocation rejected and transaction (relocation) aborted.
              type: string
              enum:
                - 'noRelocationConfirmation'
                - 'relocationAborted'
                - 'relocationRejected'

Merge:

Operation postMergePackageDeliveryIncident

alt:

      description: |
       Notify a merge package requestor about problems preparing the merge package.</br>
       **Client**:</br>
       A client (merge provider) shall always invoke this operation when merge package provision is not possible,
       shall be revoked or is significantly delayed or success notification is pending too long, i.e a client either initiates the
       termination of the merge process due to client side problems or request the completion or even abortion
       carried out by the provider (the _merger_ side).
       A client sending a _mergeAborted_ incident shall invalidate _requestId_, _download-url_ and delete the merge package
       on client side.
       
       **Provider**:</br>
       The information shall be passed to the responsible actor (insurance company associated to provider)
       by proprietary means to allow suitable actions of the actor.
       Incidents shall cause the following behaviour:
        - noMergeConfirmation
          - The notification about a successful merge of content or about incidents has not been received yet.
          Request will be terminated after a suitable waiting period.
        - mergeAborted:
          - Merge package can not or no longer be provided.
          Request shall be terminated, _requestId_ shall be invalidated and a merge package shall be deleted (if any).
 
       
       | Conditions | Status code | Error code | Remarks |
       |------------|-------------|------------|---------|
       | Successful operation | 204 |||
       | Request does not match schema | 400 | malformedRequest ||
       | No mutual TLS channel used | 403 | accessDenied ||
       | Request unknown (_requestid_ ) | 404 | noResource | no ongoing relocation request for this id known |
       | Any other error | 500 | internalError ||
       </br>
       | Postconditions                        | Remarks |
       |---------------------------------------|---------|
       | Incident delivered internally ||
       | Request aborted | mergeAborted only |
      requestBody:
        required: true
        content:
          application/json:
            examples:
              Export package generation waiting for bugfix:
                value:
                  'noMergeConfirmation'
            schema:
              description: |
               An incident about request of a merge package:
                - 'noMergeConfirmation' : waiting for merge confirmation.
                - 'mergeAborted' : can not provide merge package or merge aborted. Retry of request recommended
              type: string
              enum:
                - 'noMergeConfirmation'
                - 'mergeAborted'

neu:

      description: |
       Notify a merge package requestor about merge rejection or problems preparing the merge package.</br>

       **Client**:</br>
       A client (merge provider) shall always invoke this operation when merge package provision is not possible,
       shall be revoked or is significantly delayed or success notification is pending too long, i.e a client either initiates the
       termination of the merge process due to client side problems or request the completion or even abortion
       carried out by the provider (the _merger_ side).
       A client sending a _mergeAborted_ incident shall invalidate _requestId_, _download-url_ and delete the merge package
       on client side.
       
       **Provider**:</br>
       The information shall be passed to the responsible actor (insurance company associated to provider)
       by proprietary means to allow suitable actions of the actor.

       Incidents shall cause the following behaviour:
        - noMergeConfirmation
          - The notification about a successful merge of content or about incidents has not been received yet.
          Request will be terminated after a suitable waiting period.
        - mergeAborted:
          - Merge package can not or no longer be provided (severe technical reason or repeated missing merge confirmation).
          Request shall be terminated, _requestId_ shall be invalidated and a merge package shall be deleted (if any).
        - mergeRejected:
          - Merge package will not be provided for business reasons. The whole request is rejected by exporting provider.  
 
       
       | Conditions | Status code | Error code | Remarks |
       |------------|-------------|------------|---------|
       | Successful operation | 204 |||
       | Request does not match schema | 400 | malformedRequest ||
       | No mutual TLS channel used | 403 | accessDenied ||
       | Request unknown (_requestid_ ) | 404 | noResource | no ongoing merge request for this id known |
       | Any other error | 500 | internalError ||
       </br>
       | Postconditions                        | Remarks |
       |---------------------------------------|---------|
       | Incident delivered internally ||
       | Request aborted | for mergeAborted and mergeRejected |
      requestBody:
        required: true
        content:
          application/json:
            examples:
              Export package generation waiting for bugfix:
                value:
                  'noMergeConfirmation'
            schema:
              description: |
               An incident about request of a merge package:
                - 'noMergeConfirmation' : waiting for merge confirmation.
                - 'mergeAborted' : can not provide merge package or merge aborted. Retry of request recommended
                - 'mergeRejected' : will not provide export package for business reasons, merge rejected and transaction (merge) aborted.
              type: string
              enum:
                - 'noMergeConfirmation'
                - 'mergeAborted'
                - 'mergeRejected'