FHIR Document Handling
Note
The features described on this page are available in all Firely Server editions.
Firely Server supports submitting FHIR document bundles to the base endpoint of the server. The current version of Firely Server will only extract the unstructured part of the document, i.e. the narrative of the document bundle. The submission of the document will return a DocumentReference containing an attachment linking to a Binary resource containing the original narrative. Please note that only the top-level narrative will be extracted. No section narrative will be handled. Updates to narratives from documents with the same document identifier will result in an Update interaction on the DocumentReference.
Please make sure that Vonk.Plugin.DocumentHandling.DocumentHandlingConfiguration is enabled in the pipeline options to use this feature.
Retrieving the DocumentReference
When a document bundle is submitted to the base endpoint, Firely Server creates a DocumentReference with a predictable identifier derived from the document bundle’s identifier. To retrieve this DocumentReference afterward:
Take the
identifiervalue from your original document bundleGenerate a SHA-512 hash of this identifier value
Take the first 64 characters of the hexadecimal representation of this hash
Use this value as the ID to retrieve the DocumentReference:
GET [base]/DocumentReference/[hash-derived-id]