Skip to content

Commit 7746d20

Browse files
committed
[#7233] Document entry extensions (entryActionCode, entryVersionId) in topic-based subscriptions
1 parent 108c000 commit 7746d20

1 file changed

Lines changed: 24 additions & 24 deletions

File tree

docs/modules/topic-based-subscriptions/aidbox-topic-based-subscriptions.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -320,30 +320,6 @@ graph TD
320320
Notification is a [FHIR Bundle](https://build.fhir.org/bundle.html) resource with `history` type, containing relevant resources in its entries. The first entry is a `AidboxSubscriptionStatus` resource, which describes the payload.\
321321
The other entries depend on `AidboxTopicDestination` `content` parameter. This parameter is the binding to the FHIR [subscription-payload-content](https://hl7.org/fhir/valueset-subscription-payload-content.html) value set: `full-resource` | `id-only` | `empty`
322322

323-
### Entry extensions
324-
325-
When `includeEntryAction` or `includeVersionId` is enabled on the `AidboxTopicDestination`, each resource `Bundle.entry` (except the `AidboxSubscriptionStatus` entry) will include an `extension` array with the corresponding values:
326-
327-
```json
328-
{
329-
"resource": { ... },
330-
"fullUrl": "...",
331-
"request": { ... },
332-
"extension": [
333-
{
334-
"url": "http://health-samurai.io/fhir/core/StructureDefinition/bundle-entryActionCode",
335-
"valueCode": "create"
336-
},
337-
{
338-
"url": "http://health-samurai.io/fhir/core/StructureDefinition/bundle-entryVersionId",
339-
"valueId": "1970"
340-
}
341-
]
342-
}
343-
```
344-
345-
Only the extensions corresponding to the enabled flags are included. The extensions appear on entries for both `full-resource` and `id-only` content modes. In `empty` mode there are no resource entries, so extensions are not included.
346-
347323
{% tabs %}
348324
{% tab title="full-resource" %}
349325
```json
@@ -504,3 +480,27 @@ Only the extensions corresponding to the enabled flags are included. The extensi
504480
```
505481
{% endtab %}
506482
{% endtabs %}
483+
484+
### Entry extensions
485+
486+
When `includeEntryAction` or `includeVersionId` is enabled on the `AidboxTopicDestination`, each resource `Bundle.entry` (except the `AidboxSubscriptionStatus` entry) will include an `extension` array with the corresponding values:
487+
488+
```json
489+
{
490+
"resource": { ... },
491+
"fullUrl": "...",
492+
"request": { ... },
493+
"extension": [
494+
{
495+
"url": "http://health-samurai.io/fhir/core/StructureDefinition/bundle-entryActionCode",
496+
"valueCode": "create"
497+
},
498+
{
499+
"url": "http://health-samurai.io/fhir/core/StructureDefinition/bundle-entryVersionId",
500+
"valueId": "1970"
501+
}
502+
]
503+
}
504+
```
505+
506+
Only the extensions corresponding to the enabled flags are included. The extensions appear on entries for both `full-resource` and `id-only` content modes. In `empty` mode there are no resource entries, so extensions are not included.

0 commit comments

Comments
 (0)