| Develop | Master |
|---|---|
A template for creating plugins for the Firely server (server.fire.ly).
This project was designed to help you get started with developing a plug-in for Firely Server.
It's a skeleton which you can adopt to create more complex custom operations.
For more details about developing a Firely Server plug-in, please consult Firely Server documentation - Firely Server Plugins.
For instructions on how to run the plug-in and the Firely Server, please consult the offical Firely Server documentation. After the plugin was installed, make sure to include '$test' within the supported interactions of your appsettings. Find the 'Operations' section in your appsettings.json and add the '$test' operation like shown below:
"Operations": {
"$test": {
"Name": "$test",
"Level": [
"System",
"Type",
"Instance"
],
"Enabled": true,
"RequireAuthorization": "WhenAuthEnabled",
"RequireTenant": "WhenTenancyEnabled"
},
},
(Truncated for better overview)
The following configuration has been succesfully tested for building and running the project:
- Firely Server (Vonk) - Version 6.6.0+
- Visual Studio for Mac - Version 8.x.x
- Visual Studio for Windows - Version 16.x.x
- .NET 8
The $test operation is defined for multiple interactions:
Type level interaction:
POST [base]/[Resource]/$test
Instance level interaction:
GET [base]/[Resource]/[id]/$test
You should get a response back from the FHIR server containing an OperationOutcome.
It should report that $test was executed sucessfully. Executing $test using FHIR STU3 and R4 is supported.
A Postman collection for all the requests mentioned above can also be found in the 'data' folder.
This project is licensed under the MIT License - see the LICENSE file for details