Projo FHIR Documentation - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: Projo Subscription ( Experimental )

One of the four managed Subscriptions that wire the orchestrator and sidecar together. Each carries a meta.tag from the managed-subscription code system identifying its role. Reconciliation is by _tag search (always indexed in HAPI), NOT by criteria — so criteria changes are recoverable without duplicates. Channel type is message; endpoint is channel:fire-arrow-azure-queue:. Projo never resets Subscription.status (would tear down the live subscription).

Documentation-only artifact. Projo's runtime extensions, code systems, identifier systems and search parameter are TypeScript constants and bootstrap-time resources, NOT deployed StructureDefinitions. This StructureDefinition exists to document the contract; the source of truth is src/functions/src/lib/fhir/types.ts and docs/FHIR_EXTENSIONS.md.

Usages:

• Examples for this Profile: Subscription/ExampleSubscription

You can also check for usages in the FHIR IG Statistics

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    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Managed FHIR Subscription (one of four)
Subscription.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Subscription.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Subscription.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	requested | active Binding: SubscriptionStatus (required): The status of a subscription.
Subscription.reason	Σ This element is included in summaries.	1..1	string	Description of why this subscription was created
Subscription.criteria	Σ This element is included in summaries.	1..1	string	Resource query criteria (recoverable via _tag reconciliation)
Subscription.channel	Σ This element is included in summaries.	1..1	BackboneElement	The channel on which to report matches to the criteria
Subscription.channel.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Subscription.channel.type	Σ This element is included in summaries.	1..1	code	message (always) Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: message (no extensions allowed)
Subscription.channel.endpoint	Σ This element is included in summaries.	1..1	url	channel:fire-arrow-azure-queue:<queueName>
Subscription.channel.payload	Σ This element is included in summaries.	1..1	code	application/fhir+json (always) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/fhir+json (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Subscription.status	Base	required	SubscriptionStatus	📍4.0.1	FHIR Std.
Subscription.channel.​type	Base	required	SubscriptionChannelType	📍4.0.1	FHIR Std.
Subscription.channel.​payload	Base	required	MimeType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Managed FHIR Subscription (one of four)
Subscription.meta
Subscription.meta.tag		1..1	Coding	managed-subscription code (identifies the subscription role)
Subscription.meta.tag.system		1..1	uri	Identity of the terminology system Fixed Value: https://firearrow.io/fhir/CodeSystem/managed-subscription (no extensions allowed)
Subscription.meta.tag.code		1..1	code	Symbol in syntax defined by the system Binding: Fire Arrow Managed Subscription Value Set (required)
Subscription.status		1..1	code	requested | active
Subscription.criteria		1..1	string	Resource query criteria (recoverable via _tag reconciliation)
Subscription.channel
Subscription.channel.type		1..1	code	message (always) Fixed Value: message (no extensions allowed)
Subscription.channel.endpoint		1..1	url	channel:fire-arrow-azure-queue:<queueName>
Subscription.channel.payload		1..1	code	application/fhir+json (always) Fixed Value: application/fhir+json (no extensions allowed)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Subscription.meta.tag.​code	Base	required	Fire Arrow Managed Subscription Value Set	📦0.1.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Managed FHIR Subscription (one of four)
Subscription.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Subscription.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Subscription.meta.id		0..1	string	Unique id for inter-element referencing
Subscription.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Subscription.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Subscription.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Subscription.meta.source	Σ This element is included in summaries.	0..1	uri	Identifies where the resource comes from
Subscription.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Subscription.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Subscription.meta.tag	Σ This element is included in summaries.	1..1	Coding	managed-subscription code (identifies the subscription role) Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Subscription.meta.tag.id		0..1	string	Unique id for inter-element referencing
Subscription.meta.tag.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Subscription.meta.tag.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://firearrow.io/fhir/CodeSystem/managed-subscription (no extensions allowed)
Subscription.meta.tag.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Subscription.meta.tag.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Binding: Fire Arrow Managed Subscription Value Set (required)
Subscription.meta.tag.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Subscription.meta.tag.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Subscription.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Subscription.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Subscription.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Subscription.contained		0..*	Resource	Contained, inline Resources
Subscription.extension		0..*	Extension	Additional content defined by implementations
Subscription.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Subscription.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	requested | active Binding: SubscriptionStatus (required): The status of a subscription.
Subscription.contact	Σ This element is included in summaries.	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
Subscription.end	Σ This element is included in summaries.	0..1	instant	When to automatically delete the subscription
Subscription.reason	Σ This element is included in summaries.	1..1	string	Description of why this subscription was created
Subscription.criteria	Σ This element is included in summaries.	1..1	string	Resource query criteria (recoverable via _tag reconciliation)
Subscription.error	Σ This element is included in summaries.	0..1	string	Latest error note
Subscription.channel	Σ This element is included in summaries.	1..1	BackboneElement	The channel on which to report matches to the criteria
Subscription.channel.id		0..1	string	Unique id for inter-element referencing
Subscription.channel.extension		0..*	Extension	Additional content defined by implementations
Subscription.channel.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Subscription.channel.type	Σ This element is included in summaries.	1..1	code	message (always) Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: message (no extensions allowed)
Subscription.channel.endpoint	Σ This element is included in summaries.	1..1	url	channel:fire-arrow-azure-queue:<queueName>
Subscription.channel.payload	Σ This element is included in summaries.	1..1	code	application/fhir+json (always) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/fhir+json (no extensions allowed)
Subscription.channel.header	Σ This element is included in summaries.	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Subscription.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Subscription.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Subscription.meta.tag.​code	Base	required	Fire Arrow Managed Subscription Value Set	📦0.1.0	This IG
Subscription.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Subscription.status	Base	required	SubscriptionStatus	📍4.0.1	FHIR Std.
Subscription.channel.​type	Base	required	SubscriptionChannelType	📍4.0.1	FHIR Std.
Subscription.channel.​payload	Base	required	MimeType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()

This structure is derived from Subscription

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Fixed: 3 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Managed FHIR Subscription (one of four)
Subscription.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Subscription.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Subscription.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	requested | active Binding: SubscriptionStatus (required): The status of a subscription.
Subscription.reason	Σ This element is included in summaries.	1..1	string	Description of why this subscription was created
Subscription.criteria	Σ This element is included in summaries.	1..1	string	Resource query criteria (recoverable via _tag reconciliation)
Subscription.channel	Σ This element is included in summaries.	1..1	BackboneElement	The channel on which to report matches to the criteria
Subscription.channel.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Subscription.channel.type	Σ This element is included in summaries.	1..1	code	message (always) Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: message (no extensions allowed)
Subscription.channel.endpoint	Σ This element is included in summaries.	1..1	url	channel:fire-arrow-azure-queue:<queueName>
Subscription.channel.payload	Σ This element is included in summaries.	1..1	code	application/fhir+json (always) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/fhir+json (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Subscription.status	Base	required	SubscriptionStatus	📍4.0.1	FHIR Std.
Subscription.channel.​type	Base	required	SubscriptionChannelType	📍4.0.1	FHIR Std.
Subscription.channel.​payload	Base	required	MimeType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Differential View

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Managed FHIR Subscription (one of four)
Subscription.meta
Subscription.meta.tag		1..1	Coding	managed-subscription code (identifies the subscription role)
Subscription.meta.tag.system		1..1	uri	Identity of the terminology system Fixed Value: https://firearrow.io/fhir/CodeSystem/managed-subscription (no extensions allowed)
Subscription.meta.tag.code		1..1	code	Symbol in syntax defined by the system Binding: Fire Arrow Managed Subscription Value Set (required)
Subscription.status		1..1	code	requested | active
Subscription.criteria		1..1	string	Resource query criteria (recoverable via _tag reconciliation)
Subscription.channel
Subscription.channel.type		1..1	code	message (always) Fixed Value: message (no extensions allowed)
Subscription.channel.endpoint		1..1	url	channel:fire-arrow-azure-queue:<queueName>
Subscription.channel.payload		1..1	code	application/fhir+json (always) Fixed Value: application/fhir+json (no extensions allowed)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Subscription.meta.tag.​code	Base	required	Fire Arrow Managed Subscription Value Set	📦0.1.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription	Managed FHIR Subscription (one of four)
Subscription.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Subscription.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Subscription.meta.id		0..1	string	Unique id for inter-element referencing
Subscription.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Subscription.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Subscription.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Subscription.meta.source	Σ This element is included in summaries.	0..1	uri	Identifies where the resource comes from
Subscription.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Subscription.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Subscription.meta.tag	Σ This element is included in summaries.	1..1	Coding	managed-subscription code (identifies the subscription role) Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Subscription.meta.tag.id		0..1	string	Unique id for inter-element referencing
Subscription.meta.tag.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Subscription.meta.tag.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://firearrow.io/fhir/CodeSystem/managed-subscription (no extensions allowed)
Subscription.meta.tag.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Subscription.meta.tag.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Binding: Fire Arrow Managed Subscription Value Set (required)
Subscription.meta.tag.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Subscription.meta.tag.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Subscription.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Subscription.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Subscription.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Subscription.contained		0..*	Resource	Contained, inline Resources
Subscription.extension		0..*	Extension	Additional content defined by implementations
Subscription.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Subscription.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	requested | active Binding: SubscriptionStatus (required): The status of a subscription.
Subscription.contact	Σ This element is included in summaries.	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
Subscription.end	Σ This element is included in summaries.	0..1	instant	When to automatically delete the subscription
Subscription.reason	Σ This element is included in summaries.	1..1	string	Description of why this subscription was created
Subscription.criteria	Σ This element is included in summaries.	1..1	string	Resource query criteria (recoverable via _tag reconciliation)
Subscription.error	Σ This element is included in summaries.	0..1	string	Latest error note
Subscription.channel	Σ This element is included in summaries.	1..1	BackboneElement	The channel on which to report matches to the criteria
Subscription.channel.id		0..1	string	Unique id for inter-element referencing
Subscription.channel.extension		0..*	Extension	Additional content defined by implementations
Subscription.channel.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Subscription.channel.type	Σ This element is included in summaries.	1..1	code	message (always) Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: message (no extensions allowed)
Subscription.channel.endpoint	Σ This element is included in summaries.	1..1	url	channel:fire-arrow-azure-queue:<queueName>
Subscription.channel.payload	Σ This element is included in summaries.	1..1	code	application/fhir+json (always) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/fhir+json (no extensions allowed)
Subscription.channel.header	Σ This element is included in summaries.	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Subscription.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Subscription.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Subscription.meta.tag.​code	Base	required	Fire Arrow Managed Subscription Value Set	📦0.1.0	This IG
Subscription.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Subscription.status	Base	required	SubscriptionStatus	📍4.0.1	FHIR Std.
Subscription.channel.​type	Base	required	SubscriptionChannelType	📍4.0.1	FHIR Std.
Subscription.channel.​payload	Base	required	MimeType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()

This structure is derived from Subscription

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Fixed: 3 elements

Other representations of profile: CSV, Excel, Schematron