BackportSubscriptionStatusR4Fixed (Parameters)
R4 Backported R5 SubscriptionStatus
Profil auf der FHIR-R4-Resource Parameters zur Unterstützung themenbasierter Subscription-Benachrichtigungen in R4.
Dieses Profil ist funktional identisch mit http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4
.
Die Version 1.1.0 des offiziellen Profils weist jedoch technische Fehler auf. Daher wurde es hier als Workaround erneut implementiert.
Diese lokale Definition wird durch das offizielle backport-subscription-status-r4
Profil ersetzt, sobald eine korrigierte Version veröffentlicht wurde.
Bestätigungsrelevanz
Verbindlichkeit | SHALL |
---|
Metadaten
Canonical | https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionStatusR4Fixed |
---|---|
Status | active |
Version | 1.1.0 |
Basis | http://hl7.org/fhir/StructureDefinition/Parameters |
Inhalt
BackportSubscriptionStatusR4Fixed (Parameters) | Parameters | ||
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
parameter | Σ I | 3..* | BackboneElement |
(All Slices) | |||
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | string |
value[x] | Σ I | 0..1 | |
valueBase64Binary | base64Binary | ||
valueBoolean | boolean | ||
valueCanonical | canonical() | ||
valueCode | code | ||
valueDate | date | ||
valueDateTime | dateTime | ||
valueDecimal | decimal | ||
valueId | id | ||
valueInstant | instant | ||
valueInteger | integer | ||
valueMarkdown | markdown | ||
valueOid | oid | ||
valuePositiveInt | positiveInt | ||
valueString | string | ||
valueTime | time | ||
valueUnsignedInt | unsignedInt | ||
valueUri | uri | ||
valueUrl | url | ||
valueUuid | uuid | ||
valueAddress | Address | ||
valueAge | Age | ||
valueAnnotation | Annotation | ||
valueAttachment | Attachment | ||
valueCodeableConcept | CodeableConcept | ||
valueCoding | Coding | ||
valueContactPoint | ContactPoint | ||
valueCount | Count | ||
valueDistance | Distance | ||
valueDuration | Duration | ||
valueHumanName | HumanName | ||
valueIdentifier | Identifier | ||
valueMoney | Money | ||
valuePeriod | Period | ||
valueQuantity | Quantity | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueSampledData | SampledData | ||
valueSignature | Signature | ||
valueTiming | Timing | ||
valueContactDetail | ContactDetail | ||
valueContributor | Contributor | ||
valueDataRequirement | DataRequirement | ||
valueExpression | Expression | ||
valueParameterDefinition | ParameterDefinition | ||
valueRelatedArtifact | RelatedArtifact | ||
valueTriggerDefinition | TriggerDefinition | ||
valueUsageContext | UsageContext | ||
valueDosage | Dosage | ||
valueMeta | Meta | ||
valueReference | Reference() | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
subscription | S Σ I | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 1..1 | |
valueReference | Reference(Subscription) | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
topic | S Σ I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 0..1 | |
valueCanonical | canonical() | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
status | S Σ I | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 1..1 | Binding |
valueCode | code | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
type | S Σ I | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 1..1 | Binding |
valueCode | code | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
eventsSinceSubscriptionStart | S Σ I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 0..1 | |
valueString | string | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
notificationEvent | S Σ I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | Σ I | 0..1 | |
valueBase64Binary | base64Binary | ||
valueBoolean | boolean | ||
valueCanonical | canonical() | ||
valueCode | code | ||
valueDate | date | ||
valueDateTime | dateTime | ||
valueDecimal | decimal | ||
valueId | id | ||
valueInstant | instant | ||
valueInteger | integer | ||
valueMarkdown | markdown | ||
valueOid | oid | ||
valuePositiveInt | positiveInt | ||
valueString | string | ||
valueTime | time | ||
valueUnsignedInt | unsignedInt | ||
valueUri | uri | ||
valueUrl | url | ||
valueUuid | uuid | ||
valueAddress | Address | ||
valueAge | Age | ||
valueAnnotation | Annotation | ||
valueAttachment | Attachment | ||
valueCodeableConcept | CodeableConcept | ||
valueCoding | Coding | ||
valueContactPoint | ContactPoint | ||
valueCount | Count | ||
valueDistance | Distance | ||
valueDuration | Duration | ||
valueHumanName | HumanName | ||
valueIdentifier | Identifier | ||
valueMoney | Money | ||
valuePeriod | Period | ||
valueQuantity | Quantity | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueSampledData | SampledData | ||
valueSignature | Signature | ||
valueTiming | Timing | ||
valueContactDetail | ContactDetail | ||
valueContributor | Contributor | ||
valueDataRequirement | DataRequirement | ||
valueExpression | Expression | ||
valueParameterDefinition | ParameterDefinition | ||
valueRelatedArtifact | RelatedArtifact | ||
valueTriggerDefinition | TriggerDefinition | ||
valueUsageContext | UsageContext | ||
valueDosage | Dosage | ||
valueMeta | Meta | ||
valueReference | Reference() | ||
resource | Σ I | 0..1 | Resource |
part | S Σ | 1..* | see (parameter) |
eventNumber | S Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 1..1 | |
valueString | string | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
eventTimestamp | S Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 0..1 | |
valueInstant | instant | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
eventFocus | S Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 0..1 | |
valueReference | Reference() | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
eventAdditionalContext | S Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 0..1 | |
valueReference | Reference() | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
error | S Σ I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 1..1 | stringFixed Value |
value[x] | S Σ I | 0..1 | |
valueCodeableConcept | CodeableConcept | ||
resource | Σ I | 0..1 | Resource |
part | Σ | 0..* | see (parameter) |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="BackportSubscriptionStatusR4Fixed" /> <url value="https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionStatusR4Fixed" /> <version value="1.1.0" /> <name value="BackportSubscriptionStatusR4Fixed" /> <title value="R4 Backported R5 SubscriptionStatus" /> <status value="active" /> <experimental value="false" /> <date value="2023-01-11T15:34:32+11:00" /> <publisher value="gematik GmbH" /> <contact> <name value="HL7 FHIR Infrastructure WG" /> <telecom> <system value="url" /> <value value="https://hl7.org/Special/committees/fiwg" /> </telecom> </contact> <contact> <name value="Gino Canessa" /> <telecom> <system value="email" /> <value value="mailto:gino.canessa@microsoft.com" /> </telecom> </contact> <contact> <name value="Eric Haas" /> <telecom> <system value="email" /> <value value="mailto:ehaas@healthedatainc.com" /> </telecom> </contact> <description value="Profil auf der FHIR-R4-Resource Parameters zur Unterstützung themenbasierter Subscription-Benachrichtigungen in R4.\n\nDieses Profil ist funktional identisch mit `http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4`. \nDie Version 1.1.0 des offiziellen Profils weist jedoch technische Fehler auf. Daher wurde es hier als Workaround erneut implementiert.\nDiese lokale Definition wird durch das offizielle `backport-subscription-status-r4` Profil ersetzt, sobald eine korrigierte Version veröffentlicht wurde." /> <jurisdiction> <coding> <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="Parameters" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Parameters" /> <derivation value="constraint" /> <differential> <element id="Parameters"> <path value="Parameters" /> <short value="Parameter containing subscription status information" /> </element> <element id="Parameters.parameter"> <path value="Parameters.parameter" /> <slicing> <discriminator> <type value="value" /> <path value="name" /> </discriminator> <description value="Slice on parameter name" /> <ordered value="false" /> <rules value="open" /> </slicing> <short value="Slices containing subscription status information" /> <min value="3" /> </element> <element id="Parameters.parameter:subscription"> <path value="Parameters.parameter" /> <sliceName value="subscription" /> <short value="Parameter containing the reference to a subscription" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:subscription.name"> <path value="Parameters.parameter.name" /> <short value="Slice discriminator: the reference to a subscription" /> <fixedString value="subscription" /> </element> <element id="Parameters.parameter:subscription.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="Reference to the Subscription responsible for this notification" /> <definition value="The reference to the Subscription which generated this notification." /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Subscription" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:topic"> <path value="Parameters.parameter" /> <sliceName value="topic" /> <short value="Parameter containing the canonical reference to a subscription topic" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:topic.name"> <path value="Parameters.parameter.name" /> <short value="Slice discriminator: the canonical reference to a subscription topic" /> <fixedString value="topic" /> </element> <element id="Parameters.parameter:topic.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="Canonical reference to the SubscriptionTopic this notification relates to" /> <definition value="Canonical reference to the SubscriptionTopic for the Subscription which generated this notification." /> <comment value="This value SHOULD NOT be present when using `empty` payloads, MAY be present when using id-only payloads, and SHOULD be present when using `full-resource` payloads." /> <type> <code value="canonical" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:status"> <path value="Parameters.parameter" /> <sliceName value="status" /> <short value="Parameter containing the subscription status" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:status.name"> <path value="Parameters.parameter.name" /> <short value="Slice discriminator: the subscription status" /> <fixedString value="status" /> </element> <element id="Parameters.parameter:status.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="Status of the subscription when this notification was generated" /> <definition value="The status of the subscription, which marks the server state for managing the subscription." /> <min value="1" /> <type> <code value="code" /> </type> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-status" /> </binding> </element> <element id="Parameters.parameter:type"> <path value="Parameters.parameter" /> <sliceName value="type" /> <short value="Parameter containing the type of event for this notification" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:type.name"> <path value="Parameters.parameter.name" /> <short value="Slice discriminator: the type of event for this notification" /> <fixedString value="type" /> </element> <element id="Parameters.parameter:type.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="The type of event being conveyed with this notificaiton." /> <min value="1" /> <type> <code value="code" /> </type> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-notification-type" /> </binding> </element> <element id="Parameters.parameter:eventsSinceSubscriptionStart"> <path value="Parameters.parameter" /> <sliceName value="eventsSinceSubscriptionStart" /> <short value="Parameter containing the number of events since this subscription started" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:eventsSinceSubscriptionStart.name"> <path value="Parameters.parameter.name" /> <short value="Slice discriminator: the number of events since this subscription started" /> <fixedString value="events-since-subscription-start" /> </element> <element id="Parameters.parameter:eventsSinceSubscriptionStart.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="Events since the Subscription was created" /> <definition value="The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications." /> <type> <code value="string" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent"> <path value="Parameters.parameter" /> <sliceName value="notificationEvent" /> <short value="Parameter containing the event notification details" /> <min value="0" /> <max value="*" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.name"> <path value="Parameters.parameter.name" /> <short value="Parameter containing notification event details" /> <fixedString value="notification-event" /> </element> <element id="Parameters.parameter:notificationEvent.part"> <path value="Parameters.parameter.part" /> <slicing> <discriminator> <type value="value" /> <path value="name" /> </discriminator> <description value="Slice on notification event parameter name" /> <ordered value="false" /> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventNumber"> <path value="Parameters.parameter.part" /> <sliceName value="eventNumber" /> <short value="Parameter containing the event number" /> <min value="1" /> <max value="1" /> <type> <code value="BackboneElement" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventNumber.name"> <path value="Parameters.parameter.part.name" /> <short value="Slice discriminator: the event number" /> <fixedString value="event-number" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventNumber.value[x]"> <path value="Parameters.parameter.part.value[x]" /> <short value="Event number" /> <definition value="The sequential number of this event in this subscription context." /> <min value="1" /> <type> <code value="string" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventTimestamp"> <path value="Parameters.parameter.part" /> <sliceName value="eventTimestamp" /> <short value="Parameter containing the event timestamp" /> <min value="0" /> <max value="1" /> <type> <code value="BackboneElement" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventTimestamp.name"> <path value="Parameters.parameter.part.name" /> <short value="Slice discriminator: the event timestamp" /> <fixedString value="timestamp" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventTimestamp.value[x]"> <path value="Parameters.parameter.part.value[x]" /> <short value="The instant this event occurred" /> <definition value="The actual time this event occured on the server." /> <type> <code value="instant" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventFocus"> <path value="Parameters.parameter.part" /> <sliceName value="eventFocus" /> <short value="Parameter containing the event focus" /> <min value="0" /> <max value="1" /> <type> <code value="BackboneElement" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventFocus.name"> <path value="Parameters.parameter.part.name" /> <short value="Slice discriminator: the event focus" /> <fixedString value="focus" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventFocus.value[x]"> <path value="Parameters.parameter.part.value[x]" /> <short value="The focus of this event" /> <definition value="The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object." /> <type> <code value="Reference" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventAdditionalContext"> <path value="Parameters.parameter.part" /> <sliceName value="eventAdditionalContext" /> <short value="Parameter containing additional context for this event" /> <min value="0" /> <max value="*" /> <type> <code value="BackboneElement" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventAdditionalContext.name"> <path value="Parameters.parameter.part.name" /> <short value="Slice discriminator: additional context for this event" /> <fixedString value="additional-context" /> </element> <element id="Parameters.parameter:notificationEvent.part:eventAdditionalContext.value[x]"> <path value="Parameters.parameter.part.value[x]" /> <short value="Additional context for this event" /> <definition value="Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects." /> <type> <code value="Reference" /> </type> <mustSupport value="true" /> </element> <element id="Parameters.parameter:error"> <path value="Parameters.parameter" /> <sliceName value="error" /> <short value="Parameter containing errors on the subscription" /> <min value="0" /> <max value="*" /> <mustSupport value="true" /> </element> <element id="Parameters.parameter:error.name"> <path value="Parameters.parameter.name" /> <short value="Slice discriminator: errors on the subscription" /> <fixedString value="error" /> </element> <element id="Parameters.parameter:error.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="An error on the subscription" /> <definition value="A record of errors that occurred when the server processed a notification." /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "BackportSubscriptionStatusR4Fixed", "url": "https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionStatusR4Fixed", "version": "1.1.0", "name": "BackportSubscriptionStatusR4Fixed", "title": "R4 Backported R5 SubscriptionStatus", "status": "active", "experimental": false, "date": "01/11/2023 04:34:32", "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 Parameters zur Unterstützung themenbasierter Subscription-Benachrichtigungen in R4.\n\nDieses Profil ist funktional identisch mit `http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4`. \nDie Version 1.1.0 des offiziellen Profils weist jedoch technische Fehler auf. Daher wurde es hier als Workaround erneut implementiert.\nDiese lokale Definition wird durch das offizielle `backport-subscription-status-r4` Profil ersetzt, sobald eine korrigierte Version veröffentlicht wurde.", "jurisdiction": [ { "coding": [ { "code": "001", "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "display": "World" } ] } ], "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Parameters", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters", "derivation": "constraint", "differential": { "element": [ { "id": "Parameters", "path": "Parameters", "short": "Parameter containing subscription status information" }, { "id": "Parameters.parameter", "path": "Parameters.parameter", "slicing": { "discriminator": [ { "type": "value", "path": "name" } ], "description": "Slice on parameter name", "ordered": false, "rules": "open" }, "short": "Slices containing subscription status information", "min": 3 }, { "id": "Parameters.parameter:subscription", "path": "Parameters.parameter", "sliceName": "subscription", "short": "Parameter containing the reference to a subscription", "min": 1, "max": "1", "mustSupport": true }, { "id": "Parameters.parameter:subscription.name", "path": "Parameters.parameter.name", "short": "Slice discriminator: the reference to a subscription", "fixedString": "subscription" }, { "id": "Parameters.parameter:subscription.value[x]", "path": "Parameters.parameter.value[x]", "short": "Reference to the Subscription responsible for this notification", "definition": "The reference to the Subscription which generated this notification.", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Subscription" ] } ], "mustSupport": true }, { "id": "Parameters.parameter:topic", "path": "Parameters.parameter", "sliceName": "topic", "short": "Parameter containing the canonical reference to a subscription topic", "min": 0, "max": "1", "mustSupport": true }, { "id": "Parameters.parameter:topic.name", "path": "Parameters.parameter.name", "short": "Slice discriminator: the canonical reference to a subscription topic", "fixedString": "topic" }, { "id": "Parameters.parameter:topic.value[x]", "path": "Parameters.parameter.value[x]", "short": "Canonical reference to the SubscriptionTopic this notification relates to", "definition": "Canonical reference to the SubscriptionTopic for the Subscription which generated this notification.", "comment": "This value SHOULD NOT be present when using `empty` payloads, MAY be present when using id-only payloads, and SHOULD be present when using `full-resource` payloads.", "type": [ { "code": "canonical" } ], "mustSupport": true }, { "id": "Parameters.parameter:status", "path": "Parameters.parameter", "sliceName": "status", "short": "Parameter containing the subscription status", "min": 1, "max": "1", "mustSupport": true }, { "id": "Parameters.parameter:status.name", "path": "Parameters.parameter.name", "short": "Slice discriminator: the subscription status", "fixedString": "status" }, { "id": "Parameters.parameter:status.value[x]", "path": "Parameters.parameter.value[x]", "short": "Status of the subscription when this notification was generated", "definition": "The status of the subscription, which marks the server state for managing the subscription.", "min": 1, "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/subscription-status" } }, { "id": "Parameters.parameter:type", "path": "Parameters.parameter", "sliceName": "type", "short": "Parameter containing the type of event for this notification", "min": 1, "max": "1", "mustSupport": true }, { "id": "Parameters.parameter:type.name", "path": "Parameters.parameter.name", "short": "Slice discriminator: the type of event for this notification", "fixedString": "type" }, { "id": "Parameters.parameter:type.value[x]", "path": "Parameters.parameter.value[x]", "short": "The type of event being conveyed with this notificaiton.", "min": 1, "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/subscription-notification-type" } }, { "id": "Parameters.parameter:eventsSinceSubscriptionStart", "path": "Parameters.parameter", "sliceName": "eventsSinceSubscriptionStart", "short": "Parameter containing the number of events since this subscription started", "min": 0, "max": "1", "mustSupport": true }, { "id": "Parameters.parameter:eventsSinceSubscriptionStart.name", "path": "Parameters.parameter.name", "short": "Slice discriminator: the number of events since this subscription started", "fixedString": "events-since-subscription-start" }, { "id": "Parameters.parameter:eventsSinceSubscriptionStart.value[x]", "path": "Parameters.parameter.value[x]", "short": "Events since the Subscription was created", "definition": "The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.", "type": [ { "code": "string" } ], "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent", "path": "Parameters.parameter", "sliceName": "notificationEvent", "short": "Parameter containing the event notification details", "min": 0, "max": "*", "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.name", "path": "Parameters.parameter.name", "short": "Parameter containing notification event details", "fixedString": "notification-event" }, { "id": "Parameters.parameter:notificationEvent.part", "path": "Parameters.parameter.part", "slicing": { "discriminator": [ { "type": "value", "path": "name" } ], "description": "Slice on notification event parameter name", "ordered": false, "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.part:eventNumber", "path": "Parameters.parameter.part", "sliceName": "eventNumber", "short": "Parameter containing the event number", "min": 1, "max": "1", "type": [ { "code": "BackboneElement" } ], "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.part:eventNumber.name", "path": "Parameters.parameter.part.name", "short": "Slice discriminator: the event number", "fixedString": "event-number" }, { "id": "Parameters.parameter:notificationEvent.part:eventNumber.value[x]", "path": "Parameters.parameter.part.value[x]", "short": "Event number", "definition": "The sequential number of this event in this subscription context.", "min": 1, "type": [ { "code": "string" } ], "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.part:eventTimestamp", "path": "Parameters.parameter.part", "sliceName": "eventTimestamp", "short": "Parameter containing the event timestamp", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.part:eventTimestamp.name", "path": "Parameters.parameter.part.name", "short": "Slice discriminator: the event timestamp", "fixedString": "timestamp" }, { "id": "Parameters.parameter:notificationEvent.part:eventTimestamp.value[x]", "path": "Parameters.parameter.part.value[x]", "short": "The instant this event occurred", "definition": "The actual time this event occured on the server.", "type": [ { "code": "instant" } ], "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.part:eventFocus", "path": "Parameters.parameter.part", "sliceName": "eventFocus", "short": "Parameter containing the event focus", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.part:eventFocus.name", "path": "Parameters.parameter.part.name", "short": "Slice discriminator: the event focus", "fixedString": "focus" }, { "id": "Parameters.parameter:notificationEvent.part:eventFocus.value[x]", "path": "Parameters.parameter.part.value[x]", "short": "The focus of this event", "definition": "The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.", "type": [ { "code": "Reference" } ], "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.part:eventAdditionalContext", "path": "Parameters.parameter.part", "sliceName": "eventAdditionalContext", "short": "Parameter containing additional context for this event", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "mustSupport": true }, { "id": "Parameters.parameter:notificationEvent.part:eventAdditionalContext.name", "path": "Parameters.parameter.part.name", "short": "Slice discriminator: additional context for this event", "fixedString": "additional-context" }, { "id": "Parameters.parameter:notificationEvent.part:eventAdditionalContext.value[x]", "path": "Parameters.parameter.part.value[x]", "short": "Additional context for this event", "definition": "Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.", "type": [ { "code": "Reference" } ], "mustSupport": true }, { "id": "Parameters.parameter:error", "path": "Parameters.parameter", "sliceName": "error", "short": "Parameter containing errors on the subscription", "min": 0, "max": "*", "mustSupport": true }, { "id": "Parameters.parameter:error.name", "path": "Parameters.parameter.name", "short": "Slice discriminator: errors on the subscription", "fixedString": "error" }, { "id": "Parameters.parameter:error.value[x]", "path": "Parameters.parameter.value[x]", "short": "An error on the subscription", "definition": "A record of errors that occurred when the server processed a notification.", "type": [ { "code": "CodeableConcept" } ], "mustSupport": true } ] } }
Constraints/Invarianten
Terminology-Bindings
Element | Staerke | ValueSet |
---|---|---|
Parameters.parameter:status.value[x] | required | http://hl7.org/fhir/ValueSet/subscription-status |
Parameters.parameter:type.value[x] | required | http://hl7.org/fhir/ValueSet/subscription-notification-type |
Anmerkungen zu Must-Support-Feldern
Feldname | Kurzbeschreibung | Hinweise |
---|---|---|
Parameters.parameter:subscription | Parameter containing the reference to a subscription | |
Parameters.parameter:subscription.value[x] | Reference to the Subscription responsible for this notification | |
Parameters.parameter:topic | Parameter containing the canonical reference to a subscription topic | |
Parameters.parameter:topic.value[x] | Canonical reference to the SubscriptionTopic this notification relates to | This value SHOULD NOT be present when using |
Parameters.parameter:status | Parameter containing the subscription status | |
Parameters.parameter:status.value[x] | Status of the subscription when this notification was generated | |
Parameters.parameter:type | Parameter containing the type of event for this notification | |
Parameters.parameter:type.value[x] | The type of event being conveyed with this notificaiton. | |
Parameters.parameter:eventsSinceSubscriptionStart | Parameter containing the number of events since this subscription started | |
Parameters.parameter:eventsSinceSubscriptionStart.value[x] | Events since the Subscription was created | |
Parameters.parameter:notificationEvent | Parameter containing the event notification details | |
Parameters.parameter:notificationEvent.part | ||
Parameters.parameter:notificationEvent.part:eventNumber | Parameter containing the event number | |
Parameters.parameter:notificationEvent.part:eventNumber.value[x] | Event number | |
Parameters.parameter:notificationEvent.part:eventTimestamp | Parameter containing the event timestamp | |
Parameters.parameter:notificationEvent.part:eventTimestamp.value[x] | The instant this event occurred | |
Parameters.parameter:notificationEvent.part:eventFocus | Parameter containing the event focus | |
Parameters.parameter:notificationEvent.part:eventFocus.value[x] | The focus of this event | |
Parameters.parameter:notificationEvent.part:eventAdditionalContext | Parameter containing additional context for this event | |
Parameters.parameter:notificationEvent.part:eventAdditionalContext.value[x] | Additional context for this event | |
Parameters.parameter:error | Parameter containing errors on the subscription | |
Parameters.parameter:error.value[x] | An error on the subscription |
Beispiele
Parameters |
id : ISiKSubscriptionStatusExample |
meta |
profile : https://gematik.de/fhir/isik/StructureDefinition/ISiKSubscriptionStatus |
parameter |
name : subscription |
value |
reference : Subscription/1 |
parameter |
name : status |
value : active |
parameter |
name : type |
value : event-notification |
parameter |
name : topic |
value : https://gematik.de/fhir/isik/SubscriptionTopic/patient-merge |
parameter |
name : events-since-subscription-start |
value : 1 |
parameter |
name : notification-event |
part |
name : event-number |
value : 1 |
part |
name : timestamp |
value : 2024-02-22T18:30:05+01:00 |
part |
name : focus |
value |
reference : Patient/DorisQuelle |
<Parameters xmlns="http://hl7.org/fhir"> <id value="ISiKSubscriptionStatusExample" /> <meta> <profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKSubscriptionStatus" /> </meta> <parameter> <name value="subscription" /> <valueReference> <reference value="Subscription/1" /> </valueReference> </parameter> <parameter> <name value="status" /> <valueCode value="active" /> </parameter> <parameter> <name value="type" /> <valueCode value="event-notification" /> </parameter> <parameter> <name value="topic" /> <valueCanonical value="https://gematik.de/fhir/isik/SubscriptionTopic/patient-merge" /> </parameter> <parameter> <name value="events-since-subscription-start" /> <valueString value="1" /> </parameter> <parameter> <name value="notification-event" /> <part> <name value="event-number" /> <valueString value="1" /> </part> <part> <name value="timestamp" /> <valueInstant value="2024-02-22T18:30:05+01:00" /> </part> <part> <name value="focus" /> <valueReference> <reference value="Patient/DorisQuelle" /> </valueReference> </part> </parameter> </Parameters>
{ "resourceType": "Parameters", "id": "ISiKSubscriptionStatusExample", "meta": { "profile": [ "https://gematik.de/fhir/isik/StructureDefinition/ISiKSubscriptionStatus" ] }, "parameter": [ { "name": "subscription", "valueReference": { "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", "valueString": "1" }, { "part": [ { "name": "event-number", "valueString": "1" }, { "name": "timestamp", "valueInstant": "02/22/2024 17:30:05" }, { "name": "focus", "valueReference": { "reference": "Patient/DorisQuelle" } } ], "name": "notification-event" } ] }