Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: NZCentralRegionSubscription

Local flavour of Subscription for Te Whatu Ora, Central Region SmileCDR implementation.

Usage:

• Examples for this Resource Profile: Subscription/CustomQuery

Formal Views of Profile Content

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

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

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payload-query	S	1..1	(Complex)	HAPI FHIR Payload Search Query URL: http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria
value[x]	C	0..1	string	Value of extension nzcr-invariant-subscription-query-nospaces: Subscription extension field 'subscription-payload-search-criteria' must not contain spaces
status	S	1..1	code	requested | active | error | off
reason	S	1..1	string	Description of why this subscription was created
criteria	S	1..1	string	Rule for server push
channel
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
retry-count	S	1..1	integer	HAPI FHIR REST Hook Retry Count URL: http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count
custom-delivery-class	S	0..1	string	SmileCDR Subscription Custom Delivery Class URL: https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class
modifierExtension		0..0
type	S	1..1	code	rest-hook | websocket | email | sms | message Required Pattern: rest-hook
endpoint	S	1..1	url	Where the channel points to
payload	S	1..1	code	MIME type to send, or omit for no payload Required Pattern: application/json
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
nzcr-invariant-subscription-query-nospaces	error	Subscription.extension:payload-query.value[x]	Subscription extension field 'subscription-payload-search-criteria' must not contain spaces : contains(' ').not()

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payload-query	S	1..1	(Complex)	HAPI FHIR Payload Search Query URL: http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria
extension		0..0
url		1..1	uri	"http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria"
value[x]	C	0..1	string	Value of extension nzcr-invariant-subscription-query-nospaces: Subscription extension field 'subscription-payload-search-criteria' must not contain spaces
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
reason	SΣ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Rule for server push
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
retry-count	S	1..1	integer	HAPI FHIR REST Hook Retry Count URL: http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count
custom-delivery-class	S	0..1	string	SmileCDR Subscription Custom Delivery Class URL: https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Required Pattern: rest-hook
endpoint	SΣ	1..1	url	Where the channel points to
payload	SΣ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
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	Pattern: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 from the FHIR Standard
Subscription.channel.payload	required	Pattern: application/json http://hl7.org/fhir/ValueSet/mimetypes|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()
nzcr-invariant-subscription-query-nospaces	error	Subscription.extension:payload-query.value[x]	Subscription extension field 'subscription-payload-search-criteria' must not contain spaces : contains(' ').not()

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payload-query	S	1..1	(Complex)	HAPI FHIR Payload Search Query URL: http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria"
value[x]	C	0..1	string	Value of extension nzcr-invariant-subscription-query-nospaces: Subscription extension field 'subscription-payload-search-criteria' must not contain spaces
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	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	SΣ	1..1	string	Description of why this subscription was created
criteria	SΣ	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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
retry-count	S	1..1	integer	HAPI FHIR REST Hook Retry Count URL: http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count
custom-delivery-class	S	0..1	string	SmileCDR Subscription Custom Delivery Class URL: https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Required Pattern: rest-hook
endpoint	SΣ	1..1	url	Where the channel points to
payload	SΣ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
header	Σ	0..*	string	Usage depends on the channel type
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	Pattern: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 from the FHIR Standard
Subscription.channel.payload	required	Pattern: application/json http://hl7.org/fhir/ValueSet/mimetypes|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()
nzcr-invariant-subscription-query-nospaces	error	Subscription.extension:payload-query.value[x]	Subscription extension field 'subscription-payload-search-criteria' must not contain spaces : contains(' ').not()

This structure is derived from Subscription

Summary

Mandatory: 6 elements
Must-Support: 9 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria
• http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count
• https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class

Differential View

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payload-query	S	1..1	(Complex)	HAPI FHIR Payload Search Query URL: http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria
value[x]	C	0..1	string	Value of extension nzcr-invariant-subscription-query-nospaces: Subscription extension field 'subscription-payload-search-criteria' must not contain spaces
status	S	1..1	code	requested | active | error | off
reason	S	1..1	string	Description of why this subscription was created
criteria	S	1..1	string	Rule for server push
channel
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
retry-count	S	1..1	integer	HAPI FHIR REST Hook Retry Count URL: http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count
custom-delivery-class	S	0..1	string	SmileCDR Subscription Custom Delivery Class URL: https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class
modifierExtension		0..0
type	S	1..1	code	rest-hook | websocket | email | sms | message Required Pattern: rest-hook
endpoint	S	1..1	url	Where the channel points to
payload	S	1..1	code	MIME type to send, or omit for no payload Required Pattern: application/json
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
nzcr-invariant-subscription-query-nospaces	error	Subscription.extension:payload-query.value[x]	Subscription extension field 'subscription-payload-search-criteria' must not contain spaces : contains(' ').not()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payload-query	S	1..1	(Complex)	HAPI FHIR Payload Search Query URL: http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria
extension		0..0
url		1..1	uri	"http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria"
value[x]	C	0..1	string	Value of extension nzcr-invariant-subscription-query-nospaces: Subscription extension field 'subscription-payload-search-criteria' must not contain spaces
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
reason	SΣ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Rule for server push
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
retry-count	S	1..1	integer	HAPI FHIR REST Hook Retry Count URL: http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count
custom-delivery-class	S	0..1	string	SmileCDR Subscription Custom Delivery Class URL: https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Required Pattern: rest-hook
endpoint	SΣ	1..1	url	Where the channel points to
payload	SΣ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
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	Pattern: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 from the FHIR Standard
Subscription.channel.payload	required	Pattern: application/json http://hl7.org/fhir/ValueSet/mimetypes|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()
nzcr-invariant-subscription-query-nospaces	error	Subscription.extension:payload-query.value[x]	Subscription extension field 'subscription-payload-search-criteria' must not contain spaces : contains(' ').not()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payload-query	S	1..1	(Complex)	HAPI FHIR Payload Search Query URL: http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria"
value[x]	C	0..1	string	Value of extension nzcr-invariant-subscription-query-nospaces: Subscription extension field 'subscription-payload-search-criteria' must not contain spaces
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	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	SΣ	1..1	string	Description of why this subscription was created
criteria	SΣ	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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
retry-count	S	1..1	integer	HAPI FHIR REST Hook Retry Count URL: http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count
custom-delivery-class	S	0..1	string	SmileCDR Subscription Custom Delivery Class URL: https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Required Pattern: rest-hook
endpoint	SΣ	1..1	url	Where the channel points to
payload	SΣ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
header	Σ	0..*	string	Usage depends on the channel type
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	Pattern: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 from the FHIR Standard
Subscription.channel.payload	required	Pattern: application/json http://hl7.org/fhir/ValueSet/mimetypes|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()
nzcr-invariant-subscription-query-nospaces	error	Subscription.extension:payload-query.value[x]	Subscription extension field 'subscription-payload-search-criteria' must not contain spaces : contains(' ').not()

This structure is derived from Subscription

Summary

Mandatory: 6 elements
Must-Support: 9 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria
• http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count
• https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class

Other representations of profile: CSV, Excel, Schematron