| Develop | Master |
|---|---|
This repository implements a plug-in for the Firely Server (server.fire.ly).
It provides the $document operation defined by the FHIR standard (STU3). For more information see [1].
A client can ask a server to generate a fully bundled document from a composition resource. The server takes the composition resource, locates all the referenced resources and other additional resources as configured or requested and either returns a full document bundle, or returns an error. Note that since this is a search operation, the document bundle is wrapped inside the search bundle. If some of the resources are located on other servers, it is at the discretion of the server whether to retrieve them or return an error. If the correct version of the document that would be generated already exists, then the server can return the existing one.
For instruction on how to run the plug-in and the Firely Server, please see the offical Firely Server documentation.
The following configuration has been succesfully tested for building and running the project:
- Firely server (Vonk) - Version 4.0.0
- Visual Studio for Mac - Version 8.x.x
- Visual Studio for Windows - Version 16.x.x
- .Net Core - Version 3.1
Currently the following limitations exist in the implemenation:
- No digital signature is added on the created document
- Absolute (remote) references are not included in a document
- _graph parameter is not implemented
The $document operation is defined in FHIR for multiple interactions:
-
Type level interaction:
POST [base]/Composition/$document with a Parameters resource in the body
-
Instance level interaction:
GET [base]/Composition/[id]/$document
To test the operation:
- POST the TransactionWithExampleComposition.json to your endpoint.
- Inspect the result for the id that the Composition resource got.
- Generate a document with
GET [base]/Composition/[id]/$document
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