diff --git a/input/fsh/FHIRcastSyncSuccessContext.fsh b/input/fsh/FHIRcastSyncSuccessContext.fsh new file mode 100644 index 00000000..465d6e6e --- /dev/null +++ b/input/fsh/FHIRcastSyncSuccessContext.fsh @@ -0,0 +1,33 @@ +Profile: FHIRcastSyncSuccessParameters +Parent: Parameters +Id: fhircast-parameters-syncsuccess +Title: "FHIRcast Parameters profile for syncSuccess events." +Description: "Contains the FHIRcast event id of the event that was successfully synchronized to." +* insert SetWorkgroupFmmAndStatusRule( #inm, 1, #active) +* ^experimental = false +* parameter 1..* MS +* parameter ^slicing.discriminator.type = #value +* parameter ^slicing.discriminator.path = "name" +* parameter ^slicing.rules = #open +* parameter ^slicing.ordered = false // can be omitted, since false is the default +* parameter ^slicing.description = "The related, successfully synchronized event." +* parameter contains relatedEvent 1..1 MS +* parameter[relatedEvent].name = "relatedEvent" +* parameter[relatedEvent] ^short = "The successfully synchronized event." +* parameter[relatedEvent] ^definition = "The FHIRcast event id of the event that was successfully synchronized to." +* parameter[relatedEvent].value[x] 1..1 +* parameter[relatedEvent].value[x] Identifier +* parameter[relatedEvent].value[x] ^short = "The FHIRcast event id of the related event." +* parameter[relatedEvent].valueIdentifier.system 1..1 MS +* parameter[relatedEvent].valueIdentifier.system = "http://hl7.org/fhir/uv/fhircast/eventid" (exactly) +* parameter[relatedEvent].valueIdentifier.system ^short = "The FHIRcast eventid identifier system." +* parameter[relatedEvent].valueIdentifier.value 1..1 MS + +Instance: FHIRcastSyncSuccessContext-Example +InstanceOf: FHIRcastSyncSuccessContext +Description: "Example FHIRcast syncSuccess event context." +Usage: #example +* parameter[relatedEvent] + * name = "relatedEvent" + * valueIdentifier.system = "http://hl7.org/fhir/uv/fhircast/eventid" + * valueIdentifier.value = "b9a4b2e1-3f4c-4d6a-8e7f-1a2b3c4d5e6f" diff --git a/input/pagecontent/3-2-6-syncSuccess.md b/input/pagecontent/3-2-6-syncSuccess.md new file mode 100644 index 00000000..96618dff --- /dev/null +++ b/input/pagecontent/3-2-6-syncSuccess.md @@ -0,0 +1,59 @@ +### Event-name: SyncSuccess + +eventMaturity | [0 - Draft](3-1-2-eventmaturitymodel.html) + +### Workflow + + +Unlike most of FHIRcast events, SyncSuccess is an infrastructural event and does not follow the FHIR-resource-[open|close|update|select] syntax and is directly referenced in the [underlying specification](2_Specification.html). + +A Subscriber is affirmatively acknowledging successful synchronization to a given context change. When generated by the Hub, all subscribers have affirmatively acknowledged a context change and this is indicated to Subscribers. + +A `SyncSuccess` MAY be sent by the Hub when all subscribers have either: +1. Responded to a context change event with a 200. +2. Responded to a context change event with a 202, followed by a SyncSuccess. + +`SyncSuccess` is not used when a Subscriber responds to an `*-update` or `*-select` event. + +### Context + +{:.grid} +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`parameters` | 1..1 | resource | A FHIR Parameters resource containg the FHIRcast event id of the event that was successfully synchronized to. + +### Examples + +```json +{ + "timestamp": "2018-01-08T01:37:05.14", + "id": "q9v3jubddqt63n1", + "event": { + "hub.topic": "7544fe65-ea26-44b5-835d-14287e46390b", + "hub.event": "syncsuccess", + "context": [ + { + "key": "parameters", + "resource": { + "resourceType": "Parameters", + "parameter": [ + { + "name": "relatedEvent", + "valueIdentifier": { + "system": "http://hl7.org/fhir/uv/fhircast/eventid", + "value": "b9a4b2e1-3f4c-4d6a-8e7f-1a2b3c4d5e6f" + } + } + ] + } + } + ] + } +} +``` + +## Change Log +{:.grid} +Version | Description +------- | ---- +1.0 | Initial Release diff --git a/sushi-config.yaml b/sushi-config.yaml index 01a5ab53..83b6517a 100644 --- a/sushi-config.yaml +++ b/sushi-config.yaml @@ -174,6 +174,13 @@ pages: valueCode: trial-use - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm valueInteger: 3 + 3-2-6-syncSuccess.md: + title: SyncSuccess Event + extension: + - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status + valueCode: trial-use + - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm + valueInteger: 1 3-3-0-patientevents.md: title: Patient Events extension: