Provider Connect Australia (PCA) - Local Development build (v2.4.3) 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.

• 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
id	S	0..1	id	Logical id of this artifact
meta		0..1	Meta	Metadata about the resource
lastUpdated	S	0..1	instant	When the resource version last changed
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	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
lastUpdated	SΣ	0..1	instant	When the resource version last changed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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 Fixed Value: subscriber change notifications
criteria	SΣ	1..1	string	Rule for server push
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	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.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

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Subscription.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Subscription.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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: 8 elements
Fixed Value: 2 elements
Prohibited: 1 element

Differential View

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
id	S	0..1	id	Logical id of this artifact
meta		0..1	Meta	Metadata about the resource
lastUpdated	S	0..1	instant	When the resource version last changed
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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
lastUpdated	SΣ	0..1	instant	When the resource version last changed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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 Fixed Value: subscriber change notifications
criteria	SΣ	1..1	string	Rule for server push
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	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.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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Subscription.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Subscription.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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: 8 elements
Fixed Value: 2 elements
Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron

Notes: