Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.

Commit 2e1b78e

Browse files
committed
CCDA: Add Document Reference structure hint as per qa-bot
1 parent 5eb9625 commit 2e1b78e

File tree

1 file changed

+10
-0
lines changed
  • docs/modules/integration-toolkit/ccda-converter

1 file changed

+10
-0
lines changed

docs/modules/integration-toolkit/ccda-converter/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,16 @@ Persisting is heavily based on C-CDA's `<id root="...">` element. If some entity
290290
In addition to the FHIR resources that are converted from C-CDA data, the `/ccda/v2/persist` endpoint also creates a [Provenance](https://build.fhir.org/provenance.html) resource that contains references to all of the resources that are created or updated during a single call. This list is useful for identifying all FHIR resources that are related to a specific C-CDA document, such as for deleting them from the database.
291291

292292
If the `create-docref` option is provided, this endpoint will also create a [DocumentReference](https://build.fhir.org/documentreference.html) resource that contains a base64-encoded copy of the original C-CDA XML document in its `content` attribute. This feature is useful if you want to store the original document in the Aidbox database for rare use cases. By default, the `create-docref` option is set to false, so no DocumentReference resource is created.
293+
The created DocumentReference has the following structure in its content:
294+
295+
{
296+
"content": [{
297+
"attachment": {
298+
"contentType": "application/cda+xml",
299+
"data": "<base64-encoded C-CDA XML>"
300+
}
301+
}]
302+
}
293303

294304
#### Endpoint Options
295305

0 commit comments

Comments
 (0)