Directory folder in xml format

surfer · 20 December 2024 12:55

Hi,
I can create a directory in json and post it with success (in EHRBase) but I cannot write one in xml that works. Does anyone have a xml directory folder to share ?
I made several unsuccessful attempts at guessing the right format starting from the json one and from the directory response when using get folder in xml format.

pablo · 21 December 2024 20:47

Did you try generating XMLs in the openEHR toolkit?

https://toolkit.cabolabs.com/

surfer · 22 December 2024 13:56

I did not. I’ll try it thanks

surfer · 22 December 2024 14:02

Unfortunately it seems that the free version does not allow it "Your current plan doesn’t include generating instances for FOLDER. You can upgrade your plan from the menu on the left. "

pablo · 22 December 2024 16:58

Yes, some types are constrained. COMPOSITIONs are free.

You can also use the CLI from the open source openEHR SDK GitHub - CaboLabs/openEHR-SDK: Java/Groovy Support of openEHR Operational Templates, Reference Model, Data Generators and other tools for www.CaboLabs.com projects

It has generators for all the types, though it requires some setup.

Hope that helps.

HolgerReiseVSys · 15 January 2025 18:19

Might be a bit, late but there are example folders in the ehrbase openEHR SDK test data.
As the format is not part of the data model, you can just retrieve your working json example as xml.

surfer · 15 January 2025 19:28

not too late but unfortunately even the simple xml folder listed there does not pass. The error with EHRBase 2.11 is:

<?xml version='1.0' encoding='UTF-8'?>

Bad RequestContent is not allowed in prolog.

and I have no hidden leading characters before “<?xml etc” nor special characters in the file. The file is saved as UTF-8 without BOM.

ian.mcnicoll · 15 January 2025 22:11

Accept Header : wrong??

surfer · 16 January 2025 10:25

Hi Ian,
well I’m using similar parameter as the json one (for json directory replace in the following parameters XML with JSON and the directory is accepted.). In detail for xml directory creation:
header: ‘Content-Type’:‘application/xml’,
‘Prefer’: ‘return=representation’,
‘accept’:‘application/xml’},
params: {‘format’: ‘XML’}

Seref · 16 January 2025 11:22

I remember that error because it made me say out loud “WTF prolog has got to do with this?” Please check that your input is utf8 without hidden chars and especially utf BOM. In short, perform some char sanitisation check.

birger.haarbrandt · 16 January 2025 16:41

Taking a look at the controller, my understanding is that EHRbase only accepts JSON payload for folders?

github.com

ehrbase/ehrbase/blob/develop/rest-openehr/src/main/java/org/ehrbase/rest/openehr/OpenehrDirectoryController.java

/*
 * Copyright (c) 2024 vitasystems GmbH.
 *
 * This file is part of project EHRbase
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ehrbase.rest.openehr;

import static org.apache.commons.lang3.StringUtils.unwrap;

This file has been truncated. show original

Seref · 16 January 2025 16:43

Thanks for this. I think the last time I saw the prolog error was when I tried to push some json content to ehrbase using the swagger UI, while the content was set to XML in the UI, which should be easy enough to reproduce.

birger.haarbrandt · 16 January 2025 16:46

I got fantastic news for you though: It should be possible to use the Contribution endpoint to send the folder payload as XML to EHRbase…

surfer · 18 January 2025 12:12

From that file I understand that the default value is json but I can’t see xml in some way unsupported. Maybe I’m misreading it.

surfer · 18 January 2025 12:13

I’m quite sure I’m sending the xml file

surfer · 18 January 2025 12:18

The problem is that I was testing the post directory in XML format for the openEHR tool. I saw that in EHRBase you changed many endpoints and some header so I’m re-checking every method to guarantee that it leads to success.