Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v1.4.5-beta.002) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: KT2_Subscription

The (FHIR) Subscription (resource) is used to define a push-based subscription from a server to another system. Once a Subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

Usages:

• Examples for this Profile: Subscription/subscription-123

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Server push subscription criteria
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
reason	Σ	1..1	string	Description of why this subscription was created
criteria	Σ	1..1	string	Rule for server push
error	Σ	0..1	string	Latest error note
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	rest-hook Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Subscription.status	required	SubscriptionStatus http://hl7.org/fhir/ValueSet/subscription-status|4.0.1 From the FHIR Standard
Subscription.channel.type	required	Fixed Value: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Subscription	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Subscription	If 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-4	error	Subscription	If 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-5	error	Subscription	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Subscription	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Server push subscription criteria
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
error		0..1	string	Latest error note
channel
type		1..1	code	rest-hook Fixed Value: rest-hook
payload		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Server push subscription criteria
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
contact	Σ	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
end	Σ	0..1	instant	When to automatically delete the subscription
reason	Σ	1..1	string	Description of why this subscription was created
criteria	Σ	1..1	string	Rule for server push
error	Σ	0..1	string	Latest error note
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	rest-hook Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook
endpoint	Σ	0..1	url	Where the channel points to
header	Σ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Subscription.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Subscription.status	required	SubscriptionStatus http://hl7.org/fhir/ValueSet/subscription-status|4.0.1 From the FHIR Standard
Subscription.channel.type	required	Fixed Value: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Subscription	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Subscription	If 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-4	error	Subscription	If 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-5	error	Subscription	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Subscription	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Subscription

Summary

Fixed: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

• http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Server push subscription criteria
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
reason	Σ	1..1	string	Description of why this subscription was created
criteria	Σ	1..1	string	Rule for server push
error	Σ	0..1	string	Latest error note
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	rest-hook Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Subscription.status	required	SubscriptionStatus http://hl7.org/fhir/ValueSet/subscription-status|4.0.1 From the FHIR Standard
Subscription.channel.type	required	Fixed Value: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Subscription	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Subscription	If 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-4	error	Subscription	If 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-5	error	Subscription	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Subscription	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Server push subscription criteria
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
error		0..1	string	Latest error note
channel
type		1..1	code	rest-hook Fixed Value: rest-hook
payload		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Server push subscription criteria
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
contact	Σ	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
end	Σ	0..1	instant	When to automatically delete the subscription
reason	Σ	1..1	string	Description of why this subscription was created
criteria	Σ	1..1	string	Rule for server push
error	Σ	0..1	string	Latest error note
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	rest-hook Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook
endpoint	Σ	0..1	url	Where the channel points to
header	Σ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Subscription.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Subscription.status	required	SubscriptionStatus http://hl7.org/fhir/ValueSet/subscription-status|4.0.1 From the FHIR Standard
Subscription.channel.type	required	Fixed Value: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Subscription	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Subscription	If 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-4	error	Subscription	If 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-5	error	Subscription	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Subscription	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Subscription

Summary

Fixed: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

• http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Other representations of profile: CSV, Excel, Schematron

Notes: