Tutorial for cql plugin #412
Conversation
aswathikrishnan24
requested review from
alexzautke,
baseTwo,
cheng13231,
richfirely and
Sieuwkje-firely
features_and_tools/cql.rst
Outdated
| Introduction | ||
| ------------ | ||
|
|
||
| Firely Server CQL Plugin is a means to use the Firely Server to run the CQL engine. |
There was a problem hiding this comment.
Maybe good to explain a little bit on CQL here, it would be good to mention some basic principles.
There was a problem hiding this comment.
I can add a link to https://cql.hl7.org/. Rather than us repeating information in our document, we can point to the source itself.
There was a problem hiding this comment.
I will check in the team if CQL explanation have to come in this page. But i added a link to the main cql documentation at the top.
features_and_tools/cql.rst
Outdated
| Create a CQL File | ||
| ----------------- | ||
|
|
||
| To start working with Firely Server CQL Plugin, you would need a CQL File. |
There was a problem hiding this comment.
Maybe good to refer to documentation were people can find more information on creating a CQL file. Also good to mention the criteria for such a file here.
There was a problem hiding this comment.
The idea was that customers come up with their own CQL or use the example we provided. I can attach https://cql.hl7.org/03-developersguide.html or https://cql.hl7.org/examples.html. @cheng13231 Do you have a better document?
| ------------------------ | ||
|
|
||
| This chapter details setting up Firely Server CQL Plugin and provides you with an example to get some hands-on experience with CQL library with Postman tool. | ||
|
|
There was a problem hiding this comment.
How does the CQL plugin relate to the steps you mentioned before? It is good to explain that here, what is it exactly that the CQL plugin does with regard to what you already mentioned?
There was a problem hiding this comment.
Hmm, I am not sure if your changes came through here....
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| * Edit appsettings.instance.json: | ||
|
|
||
| 1. Set Repository to ``SQL`` and add the database configuration |
There was a problem hiding this comment.
Is it correct that CQL is currently only supported in combination with SQL? Then it is good to make a note/warning of that under the Firely Server CQL Plugin header
There was a problem hiding this comment.
@paul-l-fire can you confirm if this is true?
| CQL Plugin in Firely Server uses the ``$evaluate-measure`` operation to execute a CQL measure on a resource. | ||
| To verify the result of our CQL measure, we use Postman tool | ||
|
|
||
| Create a postman collection |
There was a problem hiding this comment.
Maybe better to point to a link where a ready made postman collection can be found?
There was a problem hiding this comment.
I see you do that already below, in that case maybe the part you describe here is not necessary? Unless, as you state below, you add extra explanation on each step of the Postman collection.
There was a problem hiding this comment.
I will check this with rest of the team, either switch the order in which this is displayed or map the explanation of the steps based on the collection.
| * Install Firely Server using `Basic installation — Firely Server documentation <https://docs.fire.ly/projects/Firely-Server/en/latest/getting_started/basic_installation.html>`_ | ||
|
|
||
| .. warning:: | ||
| Make sure that the license contains CQL Plugin. |
There was a problem hiding this comment.
Best to show how the plugin would look like, such as "Your license permits the use of the CQL plugin if it contains the following entry: http://fire.ly/vonk/plugins/cql"
Please check if this is the correct plugin though!
Also, I would not make this a warning, it can be a note I think.
| ------------------------ | ||
|
|
||
| This chapter details setting up Firely Server CQL Plugin and provides you with an example to get some hands-on experience with CQL library with Postman tool. | ||
|
|
There was a problem hiding this comment.
Hmm, I am not sure if your changes came through here....
No description provided.