Provider Connect Australia (PCA) FHIR Implementation Guide 2.4.0

This is release 2.4.0 of Provider Connect Australia (PCA) FHIR Implementation Guide. It is based on FHIR version 4.0.1. See the Directory of published versions.

SD.12 StructureDefinition-pca-subscription [Draft]

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.

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:


SD.12.1 Formal views of profile content

The official URL for this profile is: 

http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/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.

This profile builds on Subscription.

This profile was published on 2023-09-15 10:45:26+1000 as a draft by Australian Digital Health Agency.

Description of profiles, differentials, snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id S0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... lastUpdated S0..1instantWhen the resource version last changed
... status S1..1coderequested | active | error | off
... reason S1..1stringDescription of why this subscription was created
Fixed Value: subscriber change notifications
... criteria S1..1stringRule for server push
... channel
.... type S1..1coderest-hook | websocket | email | sms | message
Fixed Value: rest-hook
.... endpoint S0..1urlWhere the channel points to
.... payload 0..0
.... header S0..*stringUsage depends on the channel type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required): The status of a subscription.

... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
... end Σ0..1instantWhen to automatically delete the subscription
... reason SΣ1..1stringDescription of why this subscription was created
Fixed Value: subscriber change notifications
... criteria SΣ1..1stringRule for server push
... error Σ0..1stringLatest error note
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Fixed Value: rest-hook
.... endpoint SΣ0..1urlWhere the channel points to
.... header SΣ0..*stringUsage depends on the channel type

doco Documentation for this format

Differential view

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id S0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... lastUpdated S0..1instantWhen the resource version last changed
... status S1..1coderequested | active | error | off
... reason S1..1stringDescription of why this subscription was created
Fixed Value: subscriber change notifications
... criteria S1..1stringRule for server push
... channel
.... type S1..1coderest-hook | websocket | email | sms | message
Fixed Value: rest-hook
.... endpoint S0..1urlWhere the channel points to
.... payload 0..0
.... header S0..*stringUsage depends on the channel type

doco Documentation for this format

Snapshot view

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required): The status of a subscription.

... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
... end Σ0..1instantWhen to automatically delete the subscription
... reason SΣ1..1stringDescription of why this subscription was created
Fixed Value: subscriber change notifications
... criteria SΣ1..1stringRule for server push
... error Σ0..1stringLatest error note
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Fixed Value: rest-hook
.... endpoint SΣ0..1urlWhere the channel points to
.... header SΣ0..*stringUsage depends on the channel type

doco Documentation for this format

 

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.12.2 - Search parameters

No additional search parameters defined for this resource profile.

 

SD.12.3 - Known issues

No known issues.