Merge branch 'master' into do-20230609-trivy

.gitignore

@@ -380,4 +380,5 @@ gradle-app.setting
 source/patient/Patient-rendering.liquid.x
 
 # VS Code local settings
-.vscode/
+.vscode/
+/fhir-error-dump.html

.project

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
-	<name>fhir</name>
+	<name>fhir-r6</name>
 	<comment></comment>
 	<projects>
 	</projects>

gradle.properties

@@ -1,5 +1,5 @@
 # Versions
-kindlingVersion=1.8.9-SNAPSHOT
+kindlingVersion=1.9.7-SNAPSHOT
 
 org.gradle.parallel=true
 org.gradle.daemon=true

images/source/rest.plantuml

@@ -2,6 +2,6 @@
 hide footbox
 participant "Data Consumer" as Consumer
 participant "Data Source" as Source
-Consumer -> Source: 1a. POST/PUT/PATCH resource/Bundle
-Consumer <-- Source: 1b. HTTP 200/201 (possibly with result resource/Bundle)
+Source -> Consumer: 1a. POST/PUT/PATCH resource/Bundle
+Source <-- Consumer: 1b. HTTP 200/201 (possibly with result resource/Bundle)
 @enduml

images/subscriptions/subscription-channel-email.plantuml

@@ -0,0 +1,42 @@
+@startuml
+skin rose
+skinparam NoteTextAlignment left
+skinparam Padding 2
+skinparam ParticipantPadding 40
+skinparam LifelineStrategy solid
+autonumber
+
+participant "FHIR Server\nREST API"     as S
+participant "Client"                    as C
+participant "Email Server\n(SMTP/S, Direct)" as E
+
+
+group Negotiating a Subscription
+  C -> S: Create Subscription\n""channelType: email""
+else Without handshake
+  S --> C: Success\n""Subscription.status: active""
+  |||
+else With handshake
+  S --> C: Success\n""Subscription.status: requested""
+
+  S -> E: Message with verification, opt-in, opt-out, etc.
+  return SMTP Success, e.g.:\n""250: OK""
+
+  ...
+
+  note right of S
+    Server updates Subscription:
+    ""Subscription.status: active""
+  end note
+
+end
+
+group Email Subscription Processing
+else Server sends heartbeat
+    S -> E: Message with readable content and attached Bundle:\n""            Bundle.type: history""\n""SubscriptionStatus.type: heartbeat""
+    ...
+else Server sends event-notification
+    S -> E: Message with readable content and attached Bundle:\n""            Bundle.type: history""\n""SubscriptionStatus.type: event-notification""
+    ...
+end
+@enduml

images/subscriptions/subscription-channel-messaging.plantuml

@@ -0,0 +1,37 @@
+@startuml
+skin rose
+skinparam NoteTextAlignment left
+skinparam Padding 2
+skinparam ParticipantPadding 40
+skinparam LifelineStrategy solid
+autonumber
+
+participant "FHIR Server\nREST API"     as S
+participant "Client"                    as C
+participant "Client FHIR Server\nREST Endpoint" as E
+
+group Subscription Negotiation
+  C -> S: Create Subscription\n""channelType: message""
+  return Success\n""Subscription.status: requested""
+
+  S ->> E: POST ""$process-message"" (handshake)\n""Bundle:""\n""  Bundle.type: message""\n""  entry[1]: Bundle: subscription-notification""\n""    SubscriptionStatus.type: handshake""
+  return Success, e.g.:\n""200: OK""
+
+  note right of S
+    Server updates Subscription:
+    ""Subscription.status: active""
+  end note
+
+end
+
+group FHIR Messaging Subscription Processing
+else Server sends heartbeat
+  S ->> E: POST ""$process-message"" (heartbeat)\n""Bundle:""\n""  Bundle.type: message""\n""  entry[1]: Bundle: subscription-notification""\n""    SubscriptionStatus.type: heartbeat""
+  return Success, e.g.:\n""200: OK""
+  ...
+else Server sends event-notification
+  S ->> E: POST ""$process-message"" (event-notification)\n""Bundle:""\n""  Bundle.type: message""\n""  entry[1]: Bundle: subscription-notification""\n""    SubscriptionStatus.type: event-notification""
+  return Success, e.g.:\n""200: OK""
+  ...
+end
+@enduml

images/subscriptions/subscription-channel-rest-hook.plantuml

@@ -0,0 +1,36 @@
+@startuml
+skin rose
+skinparam NoteTextAlignment left
+skinparam Padding 2
+skinparam ParticipantPadding 50
+skinparam LifelineStrategy solid
+autonumber
+
+participant "FHIR Server\nREST API"     as S
+participant "Client"                    as C
+participant "Client Endpoint\n(HTTP/S)" as E
+
+group Subscription Negotiation
+  C ->> S: Create Subscription\n""channelType: rest-hook""
+  return Success\n""Subscription.status: requested""
+
+  S ->> E: HTTP POST - Handshake\n""Bundle:""\n""            Bundle.type: history""\n""SubscriptionStatus.type: handshake""
+  return HTTP Success, e.g.:\n""200: OK""
+
+  note right of S
+    Server updates Subscription:
+    ""Subscription.status: active""
+  end note
+end
+
+group REST Subscription Processing
+else Server sends heartbeat
+  S ->> E: HTTP POST - Heartbeat\n""Bundle:""\n""            Bundle.type: history""\n""SubscriptionStatus.type: heartbeat""
+  return HTTP Success, e.g.:\n""200: OK""
+  ...
+else Server sends event-notification
+  S ->> E: HTTP POST - Notification\n""Bundle:""\n""            Bundle.type: history""\n""SubscriptionStatus.type: event-notification""
+  return HTTP Success, e.g.:\n""200: OK""
+  ...
+end
+@enduml