• Operations
• Example operations
• Search parameters
• Error messages
• Event message types
• Service event messages

Error messages

The following list contains the error messages that are defined for the eHealth Infrastructure. The error messages are grouped by profile and follows the pattern <PROFILENAME>_<OPERATION>_<ERROR>. The pattern is used to determine which operation can result in the specific error. Note that general errors follows the pattern GENERAL_<ERROR>.

If a requests result in an error, the error message can be obtained from the diagnostics element for the specific entry in the returned issue list:

{
    "resourceType": "OperationOutcome",
    ...
    "issue": [
        {
            "severity": "error",
            "code": "processing",
            "diagnostics": "Update is only allowed for PlanDefinition with status: DRAFT or ACTIVE."
        }
    ]
}

General errors

• GENERAL_RESOURCE_NOT_FOUND: Resource %s with id %s is not found.

• GENERAL_SUBJECT_AND_CONTEXT_NOT_PROVIDED: At least one of subject and context must be provided.

• GENERAL_VALUESET_VALIDATION_ERROR: Validation error: %s

• GENERAL_EXTERNAL_RESOURCE_REFERENCE_NOT_FOUND: External resource reference not found: %s

• GENERAL_ONLY_JSON_PATCH_ALLOWED: Only JSON PATCH is allowed

• GENERAL_JSON_PATCH_VALIDATION_FAILED: JSON patch validation failed: %s

• GENERAL_FORBIDDEN_JSON_PATCH_PATH: Forbidden JSON PATCH path: %s

• INSTANCE_VALIDATION_ERROR: Error during instance validation: %s

• GENERAL_INTERNAL_ERROR: Detailed error: %s

ehealth-activitydefinition

• ACTIVITYDEFINITION_UPDATE_ALLOWED_FOR_STATUS: Update is only allowed for ActivityDefinition with status: %s or %s.

• ACTIVITYDEFINITION_UPDATE_TO_NOT_ALLOWED_STATE: Update is not allowed for ActivityDefinition with %s status to different than %s status.

ehealth-assembler

• ASSEMBLER_QRD_COMPOSITION_MISSING_DOCUMENT_REFERENCE: eHealthComposition related to questionnaire is missing eHealthDocumentReference

• ASSEMBLER_QRD_INVALID_QUESTIONNAIRE_RELATED_COMPOSITION: There must be just 1 eHealthComposition related to eHealthQuestionnaire

ehealth-careplan

• CAREPLAN_APPLY_NO_PLANDEFINITION: There is no PlanDefinition with id %s

• CAREPLAN_APPLY_NOT_ACTIVE_PLANDEFINITION: The apply operation can only be performed on Plandefinitions with status “active”

• CAREPLAN_APPLY_EPISODE_OF_CARE_REFERENCE_NOT_SPECIFIED: EpisodeOfCare reference must be specified

• CAREPLAN_APPLY_PLAN_DEFINITION_REFERENCE_NOT_SPECIFIED: PlanDefinition reference must be specified

• CAREPLAN_APPLY_CAN_NOT_FIND_ACTIVITY_DEFINITION: Can not find activity definition with id :%s

• CAREPLAN_NOT_FOUND: CarePlan is not found.

• CAREPLAN_SEARCH_SUBJECT_CONTEXT_OR_RESPONSIBLE_ACTOR_IS_NOT_SPECIFIED: At least subject, context or responsible actor must be specified

ehealth-careteam

• CARETEAM_GENERAL_EXTERNAL_SECURITY_TOKEN_CARETEAM_IDENTIFIER_SYSTEM_IS_MISSING: The CareTeam must contain an identifier using system “urn:ietf:rfc:3986”

ehealth-context

• CONTEXT_VALIDATION_EPISODEOFCARE_EXCEPTION: Episode of care does not match the security token context

ehealth-definition

• DEFINITION_WITHOUT_SELF_TREATMENT_TOPIC: %s has to be with self-treatment topic

ehealth-device

• DEVICE_WRITE_WRONG_PATIENT_CONTEXT: User with patient context can only read devices that has been issued to the patient

• DEVICE_WRITE_WRONG_ORGANIZATION_CONTEXT: User must be logged into the organization that is the owner of the device

• DEVICE_METRIC_WRITE_WRONG_ORGANIZATION_CONTEXT: User must be logged into the organization that is the owner of the device

• DEVICE_USE_STATEMENT_WRITE_WRONG_ORGANIZATION_CONTEXT: User must be logged into the organization that is the owner of the device

ehealth-documentreference

• DOCUMENTREFERENCE_SUBJECT_REFER_TO_PATIENT: It is not possible to set a patient as a subject for a Document reference

ehealth-episodeofcare

• EPISODEOFCARE_CREATE_WRONG_EOC_COUNT: Bundle has to contain only one Episode of Care

• EPISODEOFCARE_CREATE_UNSUPPORTED_RESOURCE_TYPE: Bundle contains unsupported resource type

• EPISODEOFCARE_CREATE_INCORRECT_PROVENANCE_TARGET: Provenance has incorrect target

• EPISODEOFCARE_CREATE_NO_REQUIRED_PROVENANCE_POLICIES: No provenance with required policies

• EPISODEOFCARE_CREATE_INCORRECT_CONDITION_SUBJECT: EpisodeOfCare and Condition doesn’t point to the same Patient

• EPISODEOFCARE_PATCH_NO_CONSENT: No valid Episode Of Care related consent

• EPISODEOFCARE_CREATE_PATIENT_MUST_BE_ACTIVE_AND_NOT_DECEASED: Patient.active must be true and Patient.deceased must be false to create episode of care

• EPISODEOFCARE_CREATE_STATUS_HISTORY_NOT_EMPTY: It is not allowed to fill status history manually

• EPISODEOFCARE_CREATE_EPISODE_OF_CARE_IN_NON_PLANNED_STATUS: It is only possible to create an episode of care in status ‘Planned’

• EPISODEOFCARE_CREATE_TEAM_HISTORY_NOT_EMPTY: It is not allowed to fill team history manually

• EPISODEOFCARE_CREATE_PATIENT_DOESNT_MATCH_CONTEXT: Episode of care patient doesn’t match to the context

• EPISODEOFCARE_IS_CONTEXT_ALLOWED_MATCH_NOT_FOUND: It is not possible to set the Episode Of Care as a context

ehealth-library

• LIBRARY_EVALUATE_NO_INPUT_PARAMETER: An input parameter of type Parameters should be provided.

• LIBRARY_EVALUATE_INCORRECT_INPUT_PARAMETER: Input parameter ‘parameters’ should contain exactly one resource of type QuestionnaireResponse, Observation or Media.

• LIBRARY_EVALUATE_NO_RULE_DEFINED: Library with id %s do not contain a rule to use for evaluation.

• LIBRARY_EVALUATE_NO_CAREPLAN_REFERENCING_PROVIDED_PROCEDUREQUEST: CarePlan with reference to ProcedureRequest with id %s is not found.

• LIBRARY_EVALUATE_RULE_SYNTAX_ERRORS: Syntax for rule is invalid. %s

• LIBRARY_EVALUATE_OUTPUT_PARAMETER_NOT_SUPPORTED: Output parameter of type %s is not supported.

• LIBRARY_EVALUATE_INPUT_PARAMETER_NOT_SUPPORTED: Input parameter of type %s is not supported.

• LIBRARY_EVALUATE_UNEXPECTED_LIBRARY: Evaluate is invoked on Library with id %s. This Library is not the expected Library referenced by the ActivityDefinition.

• LIBRARY_EVALUATE_UNABLE_TO_RESOLVE_RESOURCE: Not able to resolve %s when input is of type %s.

• LIBRARY_EVALUATE_DURATION_UNIT_CODE_UNKNOWN: Unsupported code %s for Duration.code. Duration.code should be a valid UCUM code. Supported codes are (‘s’, ‘min’, ‘h’, ‘d’, ‘wk’, ‘mo’, ‘a’).

ehealth-measurement

• MEASUREMENT_SEARCHMEASUREMENT_PERIOD_NOT_SPECIFIED: Period must be specified

• MEASUREMENT_SEARCHMEASUREMENT_PATIENT_AND_EPISODE_NOT_SPECIFIED: At least patient or episodeOfCare must be specified

• MEASUREMENT_SEARCHMEASUREMENT_UNSUPPORTED_PATIENT_REFERENCE: Unsupported patient reference

• MEASUREMENT_SEARCHMEASUREMENT_UNSUPPORTED_EPISODEOFCARE_REFERENCE: Unsupported episodeOfCare reference

• MEASUREMENT_SEARCHMEASUREMENT_UNSUPPORTED_DEVICE_REFERENCE: Unsupported device reference

• MEASUREMENT_SEARCHMEASUREMENT_UNSUPPORTED_BASEDON_REFERENCE: Unsupported based-on reference: %s

• MEASUREMENT_SEARCHMEASUREMENT_REFERENCED_RESOURCE_NOT_FOUND: Referenced resource not found: %s

• MEASUREMENT_SUBMITMEASUREMENT_INVALID_OBSERVATION_CODE: The code of Observation with id %s does not match the code of the referenced ProcedureRequest with id %s.

• MEASUREMENT_SUBMITMEASUREMENT_INVALID_QUESTIONNAIRE_REFERENCE: Questionnaire reference with id %s is unexpected. Expected questionnaire reference to match questionnaire reference of related ActivityDefinition with id %s.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_SHOULD_REFERENCE_PATIENT: Input resources of type EHealthObservation, EHealthMedia and EHealthQuestionnaireResponse should reference a patient.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_SHOULD_REFERENCE_EPISODEOFCARE: Input resources of type EHealthObservation, EHealthMedia and EHealthQuestionnaireResponse should reference an episode of care.

• MEASUREMENT_SUBMITMEASUREMENT_EMPTY_INPUT_BUNDLE: The input bundle does not contain any resources.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_BUNDLE_CONTAINS_NONE_OF_EXPECTED_RESOURCES: The input bundle does not contain any resources of type EHealthObservation, EHealthMedia, EHealthQuestionnaireResponse.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_BUNDLE_CONTAINS_INVALID_RESOURCES: The input bundle contains resources which are not of type EHealthObservation, EHealthMedia, EHealthQuestionnaireResponse or EHealthProvenance.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_INVALID_POLICY: Submitted provenances should use the policy ‘Reuse of measurement chosen by citizen’

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_REFERENCE_MISSING: EHealthProvenance resource is referencing %s but it is not provided as part of the input.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_NOT_SINGLE_TARGET: Provenance.target should have exactly one reference.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_TARGET_AND_ENTITY_SHOULD_BE_SAME_TYPE: Provenance.target and Provenance.entity should be of same type.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_TARGET_AND_ENTITY_SHOULD_REFERENCE_SAME_PATIENT: Provenance.target and Provenance.entity should reference the same patient

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_TARGET_AND_ENTITY_SHOULD_USE_SAME_DATE: Provenance.target and Provenance.entity should use the same date.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_ENTITY_IS_REUSING: Provenance.entity is reusing another measurement and thus can not be used for reuse.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_INVALID: %s is invalid.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_PROVENANCE_NOT_SINGLE_ENTITY: Provenance.entity should have exactly one reference.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_FOR_DIFFERENT_PATIENTS: The resources provided are for different patients.

• MEASUREMENT_SUBMITMEASUREMENT_INPUT_NOT_PART_OF_SAME_EPISODEOFCARE: The resources provided are not all part of the same episode of care.

• MEASUREMENT_SUBMITMEASUREMENT_ACTIVITYDEFINITION_MISSING_QUESTIONNAIRE_REFERENCE: ActivityDefinition with id %s does not contain a relatedArtifact with a Questionnaire reference

• MEASUREMENT_SUBMITMEASUREMENT_DIFFERENT_PATIENT_REFERENCE: The patient referenced by the EpisodeOfCare is different than the patient referenced by the provided resources

• MEASUREMENT_SUBMITMEASUREMENT_REUSE_NOT_ALLOWED: Reuse of resource with id %s is not allowed.

• MEASUREMENT_SUBMITMEASUREMENT_ASSOCIATED_QUALITY_NOT_PRESENT: Associated quality %s is not present on submitted resource. Reuse of resource is not allowed.

• MEASUREMENT_SUBMITMEASUREMENT_QUALITY_IS_NOT_SUBSUMED: Quality %s does not subsume %s. Reuse of resource is not allowed.

• MEASUREMENT_SUBMITMEASUREMENT_RESOURCE_TO_OLD_TO_BE_USED_FOR_REUSE: Reuse of resource is not allowed due to the resource being too old.

• MEASUREMENT_SUBMITMEASUREMENT_DURATION_UNIT_CODE_UNKNOWN: Unsupported code %s for Duration.code. Duration.code should be a valid UCUM code. Supported codes are (‘s’, ‘min’, ‘h’, ‘d’, ‘wk’, ‘mo’, ‘a’).

ehealth-plandefinition

• PLANDEFINITION_UPDATE_ALLOWED_FOR_STATUS: Update is only allowed for PlanDefinition with status: %s or %s.

• PLANDEFINITION_UPDATE_TO_NOT_ALLOWED_STATE: Update is not allowed for PlanDefinition with %s status to different than %s status.

• PLANDEFINITION_VALIDATE_MANDATORY_ACTIVITYDEFINITION_OR_SUBPLAN_REFERENCE: At least one activity definition or subplan should be referenced.

• PLANDEFINITION_VALIDATE_ALL_REFERENCED_ACTIVITYDEFINITIONS_OR_SUBPLANS_SHOULD_BE_ACTIVE: All referenced activity definitions or subplans should be with state: “active”

ehealth-provenance

• PROVENANCE_NO_READ_PRIVILEGE: User must be logged in with the provenance read privilege

• PROVENANCE_NO_SEARCH_PRIVILEGE: User must be logged in with the provenance search privilege

• PROVENANCE_SEARCH_DATA_NOT_MATCH_CONTEXT: The target property should match to the episode of care in context

ehealth-questionnaire

• QUESTIONNAIRE_NOT_ALLOWED_TO_UPDATE_IN_STATUS: Update is not allowed for questionnaires with statuses: %s, %s

• QUESTIONNAIRE_NOT_ALLOWED_TO_UPDATE_STATUS: Update is not allowed for questionnaires with %s status to different than %s status

• QUESTIONNAIRE_NOT_ALLOWED_TO_DELETE_WITH_STATUS: Delete only possible for questionnaires with status: %s

ehealth-security

• SECURITY_TOKEN_CONTEXT_NOT_ALLOWED: Security token context not allowed: %s

• SECURITY_TOKEN_INSUFFICIENT_PERMISSION: Insufficient permission for %s for %s

• SECURITY_USER_NOT_ALLOWED: Resource not allowed for user: %s

• SECURITY_TOKEN_CONTEXT_MISSING: Security token context missing for user type: %s

• SECURITY_RESOURCE_NOT_MATCHING_TOKEN_CONTEXT: Resource not matching security token context: %s

• SECURITY_OPERATION_NOT_ALLOWED_FOR_USER_TYPE: Operation not allowed for user type: %s

• SECURITY_SEARCH_PARAM_NOT_MATCHING_TOKEN_CONTEXT: Search parameters not matching security token context: %s

• SECURITY_SEARCH_PARAMS_MANDATORY: Search parameters mandatory with current user type and combination of search parameters: %s

ehealth-task

• TASK_RESTRICTION_CATEGORY_NONE_CANT_BE_COMBINED: Restriction category ‘None’ can’t be combined with others

• TASK_MEASUREMENT_PROCESSING_FAILED: Measurement processing failed for Provenance %s

• TASK_AUTOMATED_PROCESSING_RESOURCE_HANDLER_INVALID_JSON: Unable to parse json string: %s.

• TASK_AUTOMATED_PROCESSING_INVALID_INPUT_RESOURCE: Resource of type %s is not a valid input resource.

• TASK_AUTOMATED_PROCESSING_MISSING_MEASUREMENT_PROCEDURE_REQUEST: Could not determine if measurement is missing for procedure request: %s.

• TASK_AUTOMATED_PROCESSING_FAILING_REQUESTS_JOB_TERMINATED: Limit of %s consecutive failing requests is reached. Scheduled audit job is terminated.

ehealth-transformation

• TRANSFORMATION_QRD_INVALID_INPUT_PARAMETERS: Input bundle should contain just one EHealthComposition, EHealthQuestionnaireResponse and EHealthQuestionnaire.

• TRANSFORMATION_QRD_UNSUPPORTED_QUESTION_TYPE: Unsupported Questionnaire type: %s.

• TRANSFORMATION_QRD_INVALID_NUMBER_OF_ANSWERS: QuestionnaireResponse item should contain from %s to %s answers.

• TRANSFORMATION_QRD_INVALID_NUMBER_OF_EXTENSIONS: Questionnaire item has invalid extensions.

• TRANSFORMATION_QRD_MISSING_IDENTIFIER: Identifier on composition is mandatory

• TRANSFORMATION_PHMR_MISSING_RESOURCE: Input bundle missing resource: %s

• TRANSFORMATION_PHMR_INVALID_OBSERVATION_CODING: Observation.code.coding.system must be urn:oid:1.2.208.176.2.1

• TRANSFORMATION_PHMR_INVALID_OBSERVATION_RANGES_CODING: Observation.observationRanges[x].type.coding.system should be http://www.example.com/medcom/message-codes

• TRANSFORMATION_PHMR_OBSERVATION_QUANTITY_MISSING: Observation value should be Quantity type and not null

• TRANSFORMATION_HEADER_MISSING_CONFIDENTIALITY_CODE: Composition.confidentiality is mandatory

• TRANSFORMATION_HEADER_WRONG_TYPE_COMPOSITION_SUBJECT: Composition.subject should be a Patient

• TRANSFORMATION_HEADER_MISSING_CUSTODIAN: Custodian is mandatory for transformation

• TRANSFORMATION_HEADER_MISSING_COMPOSITION: Composition expected for transformation is not found

• TRANSFORMATION_HEADER_WRONG_TYPE_COMPOSITION_AUTHOR: Composition.author should either be a Patient or Practitioner

• TRANSFORMATION_HEADER_MISSING_COMPOSITION_AUTHOR_ORGANIZATION: Composition.authorOrganization is mandatory for transformation

ehealth-patient

• PATIENT_OFFICIAL_NAME_CHANGE_NOT_ALLOWED: Official name change not allowed

• PATIENT_CPR_CHANGE_IS_NOT_ALLOWED: CPR change is not allowed

• PATIENT_HOME_ADDRESS_CHANGE_IS_NOT_ALLOWED: Home address change is not allowed

• PATIENT_ADDRESS_VALIDATION_FALIED: Patient address validation failed: %s

• PATIENT_IDENTIFIER_MUST_BE_OF_TYPE_CRN: Identifier must be of type ‘crn’

ehealth-message

• COMMUNICATION_EXACTLY_ONE_RECIPIENT_OR_CARE_TEAM_RECIPIENT_MUST_BE_SUPPLIED: Exactly one recipient or CareTeam recipient must be supplied

• COMMUNICATION_EXACTLY_ONE_SENDER_OR_CARE_TEAM_SENDER_MUST_BE_SUPPLIED: Exactly one sender or CareTeam sender must be supplied

• COMMUNICATION_UPDATE_TO_CATEGORY_IS_NOT_ALLOWED: Update to category is not allowed: %s

• COMMUNICATION_UPDATE_NON_ADMINISTRATIVE_STATUS_NOT_ALLOWED: Only update to administrative-status extension is allowed when status in completed

• COMMUNICATION_JSON_PATCH_IS_ONLY_ALLOWED_FOR_NOTE: This JSON patch type is only allowed for category ‘%s’ (current is ‘%s’)

• COMMUNICATION_EXACTLY_ONE_MESSAGE_CATEGORY_IS_EXPECTED_ACTUAL: Exactly one message category is expected. Actual: %s

• COMMUNICATION_MEDIUM_EBOKS_OR_NEMSMS_REQUIRES_PATIENT_RECIPIENT: A recipient of type Patient is required for this medium: %s

• COMMUNICATION_PATIENT_NEMSMS_NOT_ALLOWED: Patient does not allow telecom medium NemSMS