ONCOnnectTumorboardIG - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Error Codes

​The registration API returns an HTTP code together with an OperationOutcome. If the transaction was successful, the OperationOutcome will contain an informational issue with the ServiceRequest ID of the created request. If any error occurs, the OperationOutcome will contain an error issue with a code from the ONCOnnect_PR_TB_RequestOutcomeErrorDetails code system in the details field, and a human readable error message in the diagnostics field. There can be cases where the transaction was successful, but a side effect like sending e-mail notifications failed. In this case, there will be more than one issue in the OperationOutcome.

Code	Details	Diagnostics	Description
200	ServiceRequest ID		The transaction was completed successfully. Store the ID, since you may need it for file uploads.
	serviceRequestIdNotFound	The transaction Bundle was processed successfully, but the ServiceRequest ID could not be found.	The data was saved in the FHIR server, the request should appear in the request list, but for unknown reasons the ID of the ServiceRequest could not be found. This should never happen in practice.
	emailNotificationFailed	Failed to send email notification to tumorboard correspondent.	The registration was saved successfully, but the email notification to the tumorboard correspondent could not be sent. The registration is still valid. If this persists, please get in contact with us.
400	invalidJson	Invalid JSON body	The body of the request is not a valid JSON. Make sure to send a valid FHIR Bundle in the body of the request.
	validationFailed	Bundle validation failed: Not a FHIR bundle	The body of the request is a valid JSON, but it does not follow the FHIR specification for a Bundle resource. Make sure to send a valid FHIR Bundle in the body of the request.
		Bundle validation failed: Bundle type must be 'transaction', found <bundle type>	The body of the request is a valid FHIR Bundle, but the type field of the Bundle is not set to transaction. Make sure to set the type field of the Bundle to transaction.
		Bundle validation failed: Bundle has no entries	The body of the request is a valid FHIR Bundle, but it does not contain any entries.
		Bundle validation failed: The bundle does not contain a ServiceRequest resource	The body of the request is a valid FHIR Bundle, but it does not contain a ServiceRequest resource. Make sure to include a ServiceRequest resource in the entries of the Bundle.
		Bundle validation failed: The number of supportingInfo entries <supportingInfo length> does not match the number of other entries in the bundle <bundle entry length>.	Every entry in the transaction bundle, expect the ServiceRequest itself, must be referenced in the supportingInfo field of the ServiceRequest. Make sure to include a supportingInfo reference for every entry in the bundle, except for the ServiceRequest itself.
		Bundle validation failed: All entries must have a request with method POST or PUT.	At least one entry in your transaction bundle has a request with a method other than POST or PUT. Make sure that all entries in your transaction bundle have a request with method POST or PUT.
		Bundle validation failed: PUT entry for <resourceType> is missing a resource id.	A PUT entry in your transaction bundle does not have a resource id. Every PUT entry must include the id of the resource being updated.
		Bundle validation failed: PUT request URL '<url>' does not match resource <expectedUrl>.	The request.url of a PUT entry does not match the resourceType/id of the resource in the entry. Make sure the request URL matches the resource being updated.
		Bundle validation failed: If ServiceRequest uses POST, all other resources must also use POST.	When creating a new registration (POST ServiceRequest), all other resources in the bundle must also use POST. You cannot reference existing resources in a new registration.
		Bundle validation failed: supportingInfo entry is missing a reference.	A supportingInfo entry in the ServiceRequest does not have a reference field. Make sure every supportingInfo entry contains a reference to a resource in the bundle.
		Bundle validation failed: Duplicate supportingInfo reference '<ref>'.	The ServiceRequest contains duplicate references in supportingInfo. Each reference must be unique.
		Bundle validation failed: supportingInfo reference '<ref>' does not match any resource in the bundle.	A supportingInfo reference in the ServiceRequest does not point to any resource in the bundle. Make sure every supportingInfo reference matches a resource entry in the bundle.
		Bundle validation failed: PUT ServiceRequest is missing an id.	When updating an existing registration (PUT ServiceRequest), the ServiceRequest must have an id field.
		Bundle validation failed: ServiceRequest/<id> not found on the server. Cannot update a non-existing ServiceRequest.	The ServiceRequest you are trying to update does not exist on the server. Make sure the id refers to an existing registration.
		Bundle validation failed: Resource '<ref>' is not referenced by ServiceRequest/<id>. Cannot update resources belonging to another registration.	A PUT entry targets a resource that is not owned by the ServiceRequest being updated. You can only update resources that belong to your own registration.
		Bundle validation failed: This registration cannot be updated.	The ServiceRequest you are trying to update cannot be updated through this request. This is returned both when the original author of the registration does not match the requester in the bundle, and when the registration belongs to a different tumorboard than the one in the request URL.
403	forbidden	Forbidden	Your API key is missing or invalid, or you don't have access to the specified tumorboard. Make sure to include your API key in the request header as Authorization: Bearer <your_api_key> and check that you have access to the tumorboard you are trying to register for.
	lanrNotAllowed	The provided LANR is not authorized for this API key.	The LANR provided in the requester.identifier of the ServiceRequest is not in the list of allowed LANRs for your API key. Each API key is restricted to a predefined set of practitioner LANRs. Contact an administrator to update the allowed LANRs for your API key.
	noAllowedLanrs	This API key has no allowed LANRs configured. Contact an administrator to configure allowed LANRs.	Your API key does not have any allowed LANRs configured. Every API key must have at least one allowed LANR before it can be used for registrations. Contact an administrator to configure the allowed LANRs for your API key.
404	noTumorboardProfile	Method not allowed for tumorboard: <tumorboard name>	The tumorboard that was used in the request url does not exist. Check for typos in the tumorboard name.
415	unsupportedContentType	Unsupported Content-Type: <content type>. Expected one of …	The Content-Type header of the request is not valid. Make sure to set it to one of the following values: application/fhir+json, application/json, application/fhir+xml or application/xml.
500	failedToSetDefaults	Failed to set default values in the bundle. Error: Error fetching the profile version. Is the IG https://tumorboards-ig.app.ccc-onconnect.de online?	The server couldn't reach this IG to fetch the current profile version. If this persists, this is a problem on our side, so please get in contact with us.
		Failed to set default values in the bundle. Error: ServiceRequest.requester.identifier is missing	We couldn't find the requester.identifier field in the ServiceRequest. Make sure that your ServiceRequest contains a requester.identifier with a logical reference based on the requester's LANR.
		Failed to set default values in the bundle. Error: ServiceRequest.requester.identifier.system must be 'https://fhir.kbv.de/NamingSystem/KBV_NS_Base_ANR', found <system>	The logical reference in the requester.identifier field of the ServiceRequest used a wrong system.
		Failed to set default values in the bundle. Error: Practitioner not found for identifier <LANR identifier>	The logical reference in the requester.identifier field of the ServiceRequest does not match any practitioner in our system. Every requester must have an ONCOnnect account, and their LANR must be registered in our system. (Setting the LANR is currently a manual task by us. Please get in contact with us to fix this.)
		Failed to set default values in the bundle. Error: A crash occured while searching for the requesting Practitioner	Something went wrong on our side while trying to find the practitioner based on the LANR provided in the requester.identifier field of the ServiceRequest. If this persists, please get in contact with us.
	unexpectedError	Failed to process FHIR Bundle	Something went wrong on our side while processing the registration bundle, which wasn't caught by any of the more specific error handling. If this persists, please get in contact with us.

Encrypted routes

There are a few more error codes that can be returned, when you are using the encrypted routes.

Code	Details	Diagnostics	Description
400	invalidEnvelope	Invalid envelope format	The body of the request does not follow the expected format for encrypted requests. Make sure to send a valid FHIR Bundle in the body of the request, and that it is properly encrypted according to the specifications.
	decryptionFailed	Envelope decryption failed: <message>	The server was not able to decrypt the request body. Make sure that you are using the correct keys and that the encryption process is done correctly according to the specifications.