openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build

openIMIS FHIR R4 Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions

Resource Profile: openIMIS Subscription

Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/openimis-subscription Version: 1.0.0
Active as of 2022-05-31 Responsible: openIMIS Initiative Computable Name: OpenIMISSubscription

Allows to subscribe to notification of new or updates entitities.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Subscription

Summary

Mandatory: 1 element
Prohibited: 2 elements

This structure is derived from Subscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id 0..1stringSubcription UUID
... contact 0..0
... end 0..1instantWhen to automatically disable the subscription
.... type 1..1codeOnly Rest Hook is supported
Required Pattern: rest-hook
.... endpoint 1..1urlWhere to send notifications
.... payload 0..0
.... header 0..*stringHeaders to send

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id Σ0..1stringSubcription UUID
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required): The status of a subscription.

... end Σ0..1instantWhen to automatically disable the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria Σ1..1stringRule for server push
... error Σ0..1stringLatest error note
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codeOnly Rest Hook is supported
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Required Pattern: rest-hook
.... endpoint Σ1..1urlWhere to send notifications
.... header Σ0..*stringHeaders to send

doco Documentation for this format

This structure is derived from Subscription

Summary

Mandatory: 1 element
Prohibited: 2 elements

Differential View

This structure is derived from Subscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id 0..1stringSubcription UUID
... contact 0..0
... end 0..1instantWhen to automatically disable the subscription
.... type 1..1codeOnly Rest Hook is supported
Required Pattern: rest-hook
.... endpoint 1..1urlWhere to send notifications
.... payload 0..0
.... header 0..*stringHeaders to send

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id Σ0..1stringSubcription UUID
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required): The status of a subscription.

... end Σ0..1instantWhen to automatically disable the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria Σ1..1stringRule for server push
... error Σ0..1stringLatest error note
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codeOnly Rest Hook is supported
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Required Pattern: rest-hook
.... endpoint Σ1..1urlWhere to send notifications
.... header Σ0..*stringHeaders to send

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Subscription.languagepreferredCommonLanguages
Max Binding: AllLanguages
Subscription.statusrequiredSubscriptionStatus
Subscription.channel.typerequiredPattern: rest-hook

Constraints

IdGradePathDetailsRequirements
dom-2errorSubscriptionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubscriptionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSubscriptionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSubscriptionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeSubscriptionA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorSubscription.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSubscription.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSubscription.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSubscription.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSubscription.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.endAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.criteriaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.errorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.channelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.channel.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSubscription.channel.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSubscription.channel.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSubscription.channel.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSubscription.channel.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.channel.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSubscription.channel.headerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())