BackportSubscriptionNotificationR4Fixed (Bundle)

Profil auf der FHIR-R4-Resource Bundle, um R5-ähnliche, themenbasierte Subscription-Benachrichtigungen in FHIR R4 zu ermöglichen.

Dieses Profil ist funktional identisch mit http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4.
Die Version 1.1.0 des offiziellen Profils enthält jedoch technische Fehler. Daher wurde dieses Profil lokal als temporärer Workaround nachgebildet. Es wird durch das offizielle backport-subscription-notification-r4 Profil ersetzt, sobald eine korrigierte Version veröffentlicht wurde.

Bestätigungsrelevanz

VerbindlichkeitSHALL

Metadaten

Canonicalhttps://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionNotificationR4Fixed
Statusactive
Version1.1.0
Basishttp://hl7.org/fhir/StructureDefinition/Bundle

Inhalt

idS Σ0..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ0..1Identifier
typeΣ1..1codeBindingPattern
timestampΣ0..1instant
totalΣ C0..1unsignedInt
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ0..1uri
resourceΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ0..1uri
resourceS1..1BackportSubscriptionStatusR4Fixed
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="BackportSubscriptionNotificationR4Fixed" />
<url value="https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionNotificationR4Fixed" />
<version value="1.1.0" />
<name value="BackportSubscriptionNotificationR4Fixed" />
<title value="R4 Topic-Based Subscription Notification Bundle" />
<status value="active" />
<experimental value="false" />
<date value="2023-01-11T15:35:36+11:00" />
<publisher value="gematik GmbH" />
<name value="HL7 FHIR Infrastructure WG" />
<system value="url" />
<value value="https://hl7.org/Special/committees/fiwg" />
</telecom>
</contact>
<name value="Gino Canessa" />
<system value="email" />
<value value="mailto:gino.canessa@microsoft.com" />
</telecom>
</contact>
<name value="Eric Haas" />
<system value="email" />
<value value="mailto:ehaas@healthedatainc.com" />
</telecom>
</contact>
<description value="Profil auf der FHIR-R4-Resource Bundle, um R5-ähnliche, themenbasierte Subscription-Benachrichtigungen in FHIR R4 zu ermöglichen.\n\nDieses Profil ist funktional identisch mit `http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4`. \nDie Version 1.1.0 des offiziellen Profils enthält jedoch technische Fehler. Daher wurde dieses Profil lokal als temporärer Workaround nachgebildet.\nEs wird durch das offizielle `backport-subscription-notification-r4` Profil ersetzt, sobald eine korrigierte Version veröffentlicht wurde." />
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm" />
<code value="001" />
<display value="World" />
</coding>
</jurisdiction>
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Bundle" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
<derivation value="constraint" />
<element id="Bundle">
<path value="Bundle" />
<key value="backport-notification-bundle-r4-1" />
<severity value="error" />
<human value="A notification bundle MUST have a Parameters as the first entry" />
<expression value="(entry.first().resource.is(Parameters))" />
<source value="https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionNotificationR4Fixed" />
</constraint>
</element>
<element id="Bundle.id">
<path value="Bundle.id" />
<short value="serverseitige, interne ID des Datensatzes" />
<comment value="**bedingtes Pflichtfeld/bedingtes MS:** Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine `id` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `id`verfügen." />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.versionId">
<path value="Bundle.meta.versionId" />
<short value="Eindeutiger Name der serverseitigen Version des Datensatzes" />
<comment value="Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine `versionID` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `versionID`verfügen." />
</element>
<element id="Bundle.meta.lastUpdated">
<path value="Bundle.meta.lastUpdated" />
<short value="Zeitpunkt der letzten Änderung" />
<comment value="Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein `lastUpdate` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein `lastUpdate`verfügen." />
</element>
<element id="Bundle.type">
<path value="Bundle.type" />
<patternCode value="history" />
</element>
<element id="Bundle.entry">
<path value="Bundle.entry" />
<type value="type" />
<path value="resource" />
</discriminator>
<description value="Slice based on resource" />
<ordered value="false" />
<rules value="open" />
</slicing>
<min value="1" />
</element>
<element id="Bundle.entry:subscriptionStatus">
<path value="Bundle.entry" />
<sliceName value="subscriptionStatus" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry:subscriptionStatus.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<code value="Parameters" />
<profile value="https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionStatusR4Fixed" />
</type>
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "BackportSubscriptionNotificationR4Fixed",
"url": "https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionNotificationR4Fixed",
"version": "1.1.0",
"name": "BackportSubscriptionNotificationR4Fixed",
"title": "R4 Topic-Based Subscription Notification Bundle",
"status": "active",
"experimental": false,
"date": "2023-01-11T15:35:36+11:00",
"publisher": "gematik GmbH",
"contact": [
{
"name": "HL7 FHIR Infrastructure WG",
"telecom": [
{
"system": "url",
"value": "https://hl7.org/Special/committees/fiwg"
}
]
},
{
"name": "Gino Canessa",
"telecom": [
{
"system": "email",
"value": "mailto:gino.canessa@microsoft.com"
}
]
},
{
"name": "Eric Haas",
"telecom": [
{
"system": "email",
"value": "mailto:ehaas@healthedatainc.com"
}
]
}
],
"description": "Profil auf der FHIR-R4-Resource Bundle, um R5-ähnliche, themenbasierte Subscription-Benachrichtigungen in FHIR R4 zu ermöglichen.\n\nDieses Profil ist funktional identisch mit `http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4`. \nDie Version 1.1.0 des offiziellen Profils enthält jedoch technische Fehler. Daher wurde dieses Profil lokal als temporärer Workaround nachgebildet.\nEs wird durch das offizielle `backport-subscription-notification-r4` Profil ersetzt, sobald eine korrigierte Version veröffentlicht wurde.",
{
"coding": [
{
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Bundle",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
"derivation": "constraint",
"element": [
{
"id": "Bundle",
"path": "Bundle",
{
"key": "backport-notification-bundle-r4-1",
"human": "A notification bundle MUST have a Parameters as the first entry",
"source": "https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionNotificationR4Fixed",
"severity": "error",
"expression": "(entry.first().resource.is(Parameters))"
}
]
},
{
"id": "Bundle.id",
"path": "Bundle.id",
"short": "serverseitige, interne ID des Datensatzes",
"comment": "**bedingtes Pflichtfeld/bedingtes MS:** Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine `id` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `id`verfügen.",
"mustSupport": true
},
{
"id": "Bundle.meta.versionId",
"path": "Bundle.meta.versionId",
"short": "Eindeutiger Name der serverseitigen Version des Datensatzes",
"comment": "Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine `versionID` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `versionID`verfügen."
},
{
"id": "Bundle.meta.lastUpdated",
"path": "Bundle.meta.lastUpdated",
"short": "Zeitpunkt der letzten Änderung",
"comment": "Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein `lastUpdate` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein `lastUpdate`verfügen."
},
{
"id": "Bundle.type",
"path": "Bundle.type",
"patternCode": "history"
},
{
"id": "Bundle.entry",
"path": "Bundle.entry",
"slicing": {
{
"type": "type",
"path": "resource"
}
],
"description": "Slice based on resource",
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Bundle.entry:subscriptionStatus",
"path": "Bundle.entry",
"sliceName": "subscriptionStatus",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Bundle.entry:subscriptionStatus.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Parameters",
"profile": [
"https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionStatusR4Fixed"
]
}
],
"mustSupport": true
}
]
}
}

Constraints/Invarianten

NameSchweregradBeschreibungAusdruck
backport-notification-bundle-r4-1errorA notification bundle MUST have a Parameters as the first entry(entry.first().resource.is(Parameters))

Terminology-Bindings

Anmerkungen zu Must-Support-Feldern

FeldnameKurzbeschreibungHinweise
Bundle.idserverseitige, interne ID des Datensatzes

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.

Bundle.entry:subscriptionStatus
Bundle.entry:subscriptionStatus.resource

Beispiele

Bundle
<Bundle xmlns="http://hl7.org/fhir">
<id value="SubscriptionNotificationBundleExample" />
<profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKSubscriptionNotification" />
</meta>
<type value="history" />
<fullUrl value="urn:uuid:9bb6fcbd-8391-4e35-bd4c-620a2db47af0" />
<Parameters>
<id value="ISiKSubscriptionStatusExample" />
<profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKSubscriptionStatus" />
</meta>
<name value="subscription" />
<reference value="Subscription/1" />
</valueReference>
</parameter>
<name value="status" />
<valueCode value="active" />
</parameter>
<name value="type" />
<valueCode value="event-notification" />
</parameter>
<name value="topic" />
<valueCanonical value="https://gematik.de/fhir/isik/SubscriptionTopic/patient-merge" />
</parameter>
<name value="events-since-subscription-start" />
<valueString value="1" />
</parameter>
<name value="notification-event" />
<name value="event-number" />
<valueString value="1" />
</part>
<name value="timestamp" />
<valueInstant value="2024-02-22T18:30:05+01:00" />
</part>
<name value="focus" />
<reference value="Patient/DorisQuelle" />
</valueReference>
</part>
</parameter>
</Parameters>
</resource>
<method value="GET" />
<url value="https://gematik.de/fhir/isik/SubscriptionTopic/patient-merge/$status" />
</request>
<status value="200" />
</response>
</entry>
<fullUrl value="http://example.org/fhir/Patient/DorisQuelle" />
<Patient>
<id value="DorisQuelle" />
<profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKPatient" />
</meta>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203" />
<code value="MR" />
</coding>
</type>
<system value="https://fhir.krankenhaus.example/sid/PID" />
<value value="654321" />
</identifier>
<system value="http://fhir.de/CodeSystem/identifier-type-de-basis" />
<code value="KVZ10" />
</coding>
</type>
<system value="http://fhir.de/sid/gkv/kvid-10" />
<value value="A123456789" />
</identifier>
<active value="false" />
<use value="official" />
<family value="Duplikat" />
<given value="Doris" />
</name>
<gender value="female" />
<birthDate value="1964-08-12" />
</Patient>
</resource>
<method value="PUT" />
<url value="Patient" />
</request>
<status value="201" />
</response>
</entry>
</Bundle>
{
"resourceType": "Bundle",
"id": "SubscriptionNotificationBundleExample",
"meta": {
"profile": [
"https://gematik.de/fhir/isik/StructureDefinition/ISiKSubscriptionNotification"
]
},
"type": "history",
"entry": [
{
"fullUrl": "urn:uuid:9bb6fcbd-8391-4e35-bd4c-620a2db47af0",
"resourceType": "Parameters",
"id": "ISiKSubscriptionStatusExample",
"meta": {
"profile": [
"https://gematik.de/fhir/isik/StructureDefinition/ISiKSubscriptionStatus"
]
},
{
"name": "subscription",
"reference": "Subscription/1"
}
},
{
"name": "status",
"valueCode": "active"
},
{
"name": "type",
"valueCode": "event-notification"
},
{
"name": "topic",
"valueCanonical": "https://gematik.de/fhir/isik/SubscriptionTopic/patient-merge"
},
{
"name": "events-since-subscription-start",
},
{
"part": [
{
"name": "event-number",
},
{
"name": "timestamp",
"valueInstant": "2024-02-22T18:30:05+01:00"
},
{
"name": "focus",
"reference": "Patient/DorisQuelle"
}
}
],
"name": "notification-event"
}
]
},
"request": {
"method": "GET",
"url": "https://gematik.de/fhir/isik/SubscriptionTopic/patient-merge/$status"
},
"status": "200"
}
},
{
"fullUrl": "http://example.org/fhir/Patient/DorisQuelle",
"resourceType": "Patient",
"id": "DorisQuelle",
"meta": {
"profile": [
"https://gematik.de/fhir/isik/StructureDefinition/ISiKPatient"
]
},
{
"type": {
"coding": [
{
"code": "MR",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
}
]
},
"system": "https://fhir.krankenhaus.example/sid/PID",
"value": "654321"
},
{
"system": "http://fhir.de/sid/gkv/kvid-10",
"type": {
"coding": [
{
"code": "KVZ10",
"system": "http://fhir.de/CodeSystem/identifier-type-de-basis"
}
]
},
"value": "A123456789"
}
],
"name": [
{
"use": "official",
"family": "Duplikat",
"given": [
"Doris"
]
}
],
"active": false,
"gender": "female",
"birthDate": "1964-08-12"
},
"request": {
"method": "PUT",
"url": "Patient"
},
"status": "201"
}
}
]
}