Provider Connect Australia (PCA)

Provider Connect Australia (PCA) - Local Development build (v25.1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: PCA Subscription

This profile is used by subscribing systems to register for notifications from the PCA service when new or updated service offerings are available, or when publication of existing service offerings has been newly revoked.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

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
Subscription		0..*	Subscription	Server push subscription criteria dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!SΣ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. ele-1: All FHIR elements must have a @value or children
reason	SΣ	1..1	string	Description of why this subscription was created ele-1: All FHIR elements must have a @value or children Fixed Value: subscriber change notifications
criteria	SΣ	1..1	string	Rule for server push ele-1: All FHIR elements must have a @value or children
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. ele-1: All FHIR elements must have a @value or children Fixed Value: rest-hook
endpoint	SΣ	0..1	url	Where the channel points to ele-1: All FHIR elements must have a @value or children
header	SΣ	0..*	string	Usage depends on the channel type ele-1: All FHIR elements must have a @value or children
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

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
status	S	1..1	code	requested | active | error | off
reason	S	1..1	string	Description of why this subscription was created Fixed Value: subscriber change notifications
criteria	S	1..1	string	Rule for server push
channel
type	S	1..1	code	rest-hook | websocket | email | sms | message Fixed Value: rest-hook
endpoint	S	0..1	url	Where the channel points to
payload		0..0
header	S	0..*	string	Usage depends on the channel type
Documentation for this format

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
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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 Fixed Value: subscriber change notifications
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook
endpoint	SΣ	0..1	url	Where the channel points to
header	SΣ	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

This structure is derived from Subscription

Summary

Must-Support: 6 elements
Fixed: 2 elements
Prohibited: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!SΣ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. ele-1: All FHIR elements must have a @value or children
reason	SΣ	1..1	string	Description of why this subscription was created ele-1: All FHIR elements must have a @value or children Fixed Value: subscriber change notifications
criteria	SΣ	1..1	string	Rule for server push ele-1: All FHIR elements must have a @value or children
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. ele-1: All FHIR elements must have a @value or children Fixed Value: rest-hook
endpoint	SΣ	0..1	url	Where the channel points to ele-1: All FHIR elements must have a @value or children
header	SΣ	0..*	string	Usage depends on the channel type ele-1: All FHIR elements must have a @value or children
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

Differential View

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
status	S	1..1	code	requested | active | error | off
reason	S	1..1	string	Description of why this subscription was created Fixed Value: subscriber change notifications
criteria	S	1..1	string	Rule for server push
channel
type	S	1..1	code	rest-hook | websocket | email | sms | message Fixed Value: rest-hook
endpoint	S	0..1	url	Where the channel points to
payload		0..0
header	S	0..*	string	Usage depends on the channel type
Documentation for this format

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
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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 Fixed Value: subscriber change notifications
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook
endpoint	SΣ	0..1	url	Where the channel points to
header	SΣ	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

This structure is derived from Subscription

Summary

Must-Support: 6 elements
Fixed: 2 elements
Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron

Notes: