Provider Connect Australia (PCA)
24.1.0.0 - active

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

## Resource Profile: PCA Subscription

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-subscription | Version: 24.1.0.0
Active as of 2024-05-28 | Computable Name: PcaSubscription
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

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.

### Must support

The meaning of the presence or absence of the must support flag is described in Must support.

### Extensions

No extensions have been introduced in this profile.

### Supported interactions

Supported service interactions for this profile are defined in the following capability statement:

- For subscribing systems: PCA Subscriber Agent

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
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
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 | Σ | 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
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: 6 elements
Fixed: 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
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
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 | Σ | 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
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: 6 elements
Fixed: 2 elements
Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron

### Notes:

No additional search parameters defined for this resource profile.