Event rewrite

docs/events/imagingstudy-close.md

@@ -0,0 +1,74 @@
+# ImagingStudy-close
+
+eventMaturity | [2 - Tested](../../specification/1.0/#event-maturity-model)
+
+## Workflow
+
+User opened record of imaging study. 
+
+User closed patient's medical record. A previously open and in context study is no longer open nor in context. The previously open study may have been associated with a specific patient, or not. 
+
+## Context
+
+Key | Optionality | Fhir operation to generate context | Description
+----- | -------- | ---- | ---- 
+`patient` | REQUIRED | `Patient/{id}?_elements=identifier` | FHIR Patient resource describing the patient associated with the study currently in context.
+`study` | REQUIRED | `ImagingStudy/{id}?_elements=identifier,accession` | FHIR ImagingStudy resource previously in context. Note that in addition to the request identifier and accession elements, the DICOM uid and FHIR patient reference are included because they're required by the FHIR specification.
+
+
+### Examples
+
+<mark>
+```json
+{
+  "timestamp": "2018-01-08T01:37:05.14",
+  "id": "q9v3jubddqt63n1",
+  "event": {
+    "hub.topic": "fdb2f928-5546-4f52-87a0-0648e9ded065",
+    "hub.event": "imagingstudy-close",
+    "context": [
+      {
+        "key": "patient",
+        "resource": {
+          "resourceType": "Patient",
+          "id": "ewUbXT9RWEbSj5wPEdgRaBw3",
+          "identifier": [
+            {
+              "system": "urn:oid:1.2.840.114350",
+              "value": "185444"
+            },
+            {
+              "system": "urn:oid:1.2.840.114350.1.13.861.1.7.5.737384.27000",
+              "value": "2667"
+            }
+          ]
+        }
+      },
+      {
+        "key": "study",
+        "resource": {
+          "resourceType": "ImagingStudy",
+          "id": "8i7tbu6fby5ftfbku6fniuf",
+          "uid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045",
+          "identifier": [
+            {
+              "system": "7678",
+              "value": "185444"
+            }
+          ],
+          "patient": {
+            "reference": "Patient/ewUbXT9RWEbSj5wPEdgRaBw3"
+          }
+        }
+      }
+    ]
+  }
+}
+```
+</mark>
+
+## Change Log
+
+Version | Description
+---- | ----
+1.0 | Initial Release

docs/events/imagingstudy-open.md

@@ -0,0 +1,72 @@
+# ImagingStudy-open
+
+eventMaturity | [2 - Tested](../../specification/1.0/#event-maturity-model)
+
+## Workflow
+
+User opened record of imaging study. The newly open study may have been associated with a specific patient, or not. 
+
+## Context
+
+Key | Optionality | Fhir operation to generate context | Description
+----- | -------- | ---- | ---- 
+`patient` | REQUIRED | `Patient/{id}?_elements=identifier` | FHIR Patient resource describing the patient associated with the study currently in context.
+`study` | REQUIRED | `ImagingStudy/{id}?_elements=identifier,accession` | FHIR ImagingStudy resource in context. Note that in addition to the request identifier and accession elements, the DICOM uid and FHIR patient reference are included because they're required by the FHIR specification.
+
+
+### Examples
+
+<mark>
+```json
+{
+  "timestamp": "2018-01-08T01:37:05.14",
+  "id": "q9v3jubddqt63n1",
+  "event": {
+    "hub.topic": "fdb2f928-5546-4f52-87a0-0648e9ded065",
+    "hub.event": "imagingstudy-open",
+    "context": [
+      {
+        "key": "patient",
+        "resource": {
+          "resourceType": "Patient",
+          "id": "ewUbXT9RWEbSj5wPEdgRaBw3",
+          "identifier": [
+            {
+              "system": "urn:oid:1.2.840.114350",
+              "value": "185444"
+            },
+            {
+              "system": "urn:oid:1.2.840.114350.1.13.861.1.7.5.737384.27000",
+              "value": "2667"
+            }
+          ]
+        }
+      },
+      {
+        "key": "study",
+        "resource": {
+          "resourceType": "ImagingStudy",
+          "id": "8i7tbu6fby5ftfbku6fniuf",
+          "uid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045",
+          "identifier": [
+            {
+              "system": "7678",
+              "value": "185444"
+            }
+          ],
+          "patient": {
+            "reference": "Patient/ewUbXT9RWEbSj5wPEdgRaBw3"
+          }
+        }
+      }
+    ]
+  }
+}
+```
+</mark>
+
+## Change Log
+
+Version | Description
+---- | ----
+1.0 | Initial Release

docs/events/patient-close.md

@@ -0,0 +1,58 @@
+# Patient-close
+
+eventMaturity | [2 - Tested](../../specification/1.0/#event-maturity-model)
+
+## Workflow
+
+User closed patient's medical record. A previously open and in context patient chart is no longer open nor in context. The previously open patient may have been within the context of a specific encounter, or not. 
+
+## Context
+
+Key | Optionality | Fhir operation to generate context | Description
+----- | -------- | ---- | ---- 
+`patient` | REQUIRED | `Patient/{id}?_elements=identifier` | FHIR Patient resource describing the patient whose chart was previously in context.
+`encounter` | REQUIRED, if exists | `Encounter/{id}?_elements=identifier	` | FHIR Encounter resource previously in context in the now closed patient's chart.
+
+
+### Examples
+
+<mark>
+```json
+{
+  "timestamp": "2018-01-08T01:37:05.14",
+  "id": "q9v3jubddqt63n1",
+  "event": {
+    "hub.topic": "fdb2f928-5546-4f52-87a0-0648e9ded065",
+    "hub.event": "patient-close",
+    "context": [
+      {
+        "key": "patient",
+        "resource": {
+          "resourceType": "Patient",
+          "id": "ewUbXT9RWEbSj5wPEdgRaBw3",
+          "identifier": [
+            {
+              "type": {
+                "coding": [
+                  {
+                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
+                    "value": "MR",
+                    "display": "Medication Record Number"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      }
+    ]
+  }
+}
+```
+</mark>
+
+## Change Log
+
+Version | Description
+---- | ----
+1.0 | Initial Release

docs/events/patient-open.md

@@ -0,0 +1,58 @@
+# Patient-open
+
+eventMaturity | [2 - Tested](../../specification/1.0/#event-maturity-model)
+
+## Workflow
+
+User opened patient's medical record. Only a single patient is currently in context. This event may be within the context of a specific encounter, or not. 
+
+## Context
+
+Key | Optionality | Fhir operation to generate context | Description
+----- | -------- | ---- | ---- 
+`patient` | REQUIRED | `Patient/{id}?_elements=identifier` | FHIR Patient resource describing the patient whose chart is currently in context.
+`encounter` | REQUIRED, if exists | `Encounter/{id}?_elements=identifier	` | FHIR Encounter resource in context in the newly opened patient's chart.
+
+
+### Examples
+
+<mark>
+```json
+{
+  "timestamp": "2018-01-08T01:37:05.14",
+  "id": "q9v3jubddqt63n1",
+  "event": {
+    "hub.topic": "fdb2f928-5546-4f52-87a0-0648e9ded065",
+    "hub.event": "patient-open",
+    "context": [
+      {
+        "key": "patient",
+        "resource": {
+          "resourceType": "Patient",
+          "id": "ewUbXT9RWEbSj5wPEdgRaBw3",
+          "identifier": [
+            {
+              "type": {
+                "coding": [
+                  {
+                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
+                    "value": "MR",
+                    "display": "Medication Record Number"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      }
+    ]
+  }
+}
+```
+</mark>
+
+## Change Log
+
+Version | Description
+---- | ----
+1.0 | Initial Release

docs/events/syncerror.md

@@ -0,0 +1,54 @@
+# syncerror
+
+eventMaturity | [2 - Tested](../../specification/1.0/#event-maturity-model)
+
+## Workflow
+
+A synchronization error has been detected. Inform subscribed clients. 
+
+Unlike most of FHIRcast events, `syncerror` is an infrastructural event and does not follow the `FHIR-resource`-`[open|close]` syntax and is directly referenced in the [underlying specification](../../specification/STU1/#event-notification-errors).
+
+## Context
+
+Key | Optionality | Fhir operation to generate context | Description
+----- | -------- | ---- | ---- 
+`operationoutcome` | OPTIONAL | `OperationOutcome` | FHIR resource describing an outcome of an unsuccessful system action.
+
+
+### Examples
+
+<mark>
+```json
+{
+  "timestamp": "2018-01-08T01:37:05.14",
+  "id": "q9v3jubddqt63n1",
+  "event": {
+    "hub.topic": "fdb2f928-5546-4f52-87a0-0648e9ded065",
+    "hub.event": "syncerror",
+    "context": [
+      {
+        "key": "operationoutcome",
+        "resource": {
+          "resourceType": "OperationOutcome",
+          "issue": [
+            {
+              "severity": "warning",
+              "code": "processing",
+              "diagnostics": "AppId3456 failed to follow context"
+            }
+          ]
+        }
+      }
+    ]
+  }
+}
+```
+
+
+</mark>
+
+## Change Log
+
+Version | Description
+---- | ----
+1.0 | Initial Release

docs/events/template.md

@@ -0,0 +1,50 @@
+# <mark>[FHIR resource]-[open|close]</mark>
+
+eventMaturity | [0 - Draft](../../specification/1.0/#event-maturity-model)
+
+## Workflow
+
+<mark>Describe when this event occurs in a workflow. Describe how the context fields relate to one another. Event creators SHOULD include as much detail and clarity as possible to minimize any ambiguity or confusion amongst implementors.</mark>
+
+## Context
+
+<mark>Define context values that are provided when this event occurs, and indicate whether they must be provided, and the FHIR query used to generate the resource. </mark>
+
+Key | Optionality | FHIR operation to generate context | Description
+----- | -------- | ---- | ---- 
+<mark>`example`</mark> | REQUIRED | `FHIRresource/{id}?_elements=identifer` | <mark>Describe the context value</mark>
+<mark>`encounter`</mark> | OPTIONAL | `Encounter/{id}` | <mark>Describe the context value</mark>
+
+### Examples
+
+<mark>
+```json
+{
+  "timestamp": "2018-01-08T01:37:05.14",
+  "id": "q9v3jubddqt63n1",
+  "event": {
+    "hub.topic": "fdb2f928-5546-4f52-87a0-0648e9ded065",
+    "hub.event": "patient-open",
+    "context": [
+    {
+      "key": "key-from-above",
+      "resource": {
+        "resourceType": "resource-type-from-above"
+    },
+    {
+      "key": "encounter",
+      "resource": {
+        "resourceType": "Encounter"
+      } 
+    }
+  }]
+  }
+}
+```
+</mark>
+
+## Change Log
+
+Version | Description
+---- | ----
+1.0 | Initial Release