Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

prasannakumarramani
Copy link

Added Changes to Event Payload Bundle Resource with Comments

Added Changes to Event Payload Bundle Resource with Comments
@prasannakumarramani
Copy link
Author

@sjatwood review this PR

In addition to the focus resource ID, some events MAY also contain additional context such as the related Patient ID and/or Department ID (see example below).

As per the Subscriptions R5 Backport IG, the first entry in each notification Bundle will always be a SubscriptionStatus resource which contains metadata about the Subscription associated with the event as well as metadata about the event(s) contained in the Bundle (see `entry[0].resource.notificationEvent[*].focus` below). At present this will be the only entry in the Bundle since `full-resource` payload is not supported at this time.
As per the Subscriptions R5 Backport IG, the first entry in each notification Bundle will always be a SubscriptionStatus resource which contains metadata about the Subscription associated with the event as well as metadata about the event(s) contained in the Bundle (see `entry[0].resource.notificationEvent[*].focus` below). The second entry will be `AuditEvent` resource which will have information about the event. Additional Detail of the event would be part of the `extension[]` array. Note that extensions would be different for different events.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't say "second entry" here because we want to leave open the expectation that a single Bundle may contain multiple events. I would rephrase along these lines:

The Bundle will also contain one AuditEvent resource corresponding to each entry in the entry[0].resource.notificationEvent array. This resource captures some additional metadata about the event such as the user/agent whose action triggered the event as well as topic-specific extensions (where applicable) with additional context such as the related Patient, Department, etc. For a list of which extensions are provided for each subscription topic, see Subscription Topics below.

(and we should add those details below)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prasannakumarramani we should also update the example payloads in the sample code (see https://github.com/athenahealth/aone-fhir-subscriptions/blob/main/samplecode/java/send-appointment-notification.sh for example) to include the new payload structure, i.e. extensions instead of additionalContext.

Remove additional context from the example
Add Text to inform the timeout exceeding 2min
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants