Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5 - Downloaded Version null See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: Profile_R2_Subscription_R5

This cross-version profile allows DSTU2 Subscription content to be represented via FHIR R5 Subscription resources.

Usages:

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

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(5.0.0)	Notification about a SubscriptionTopic
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:criteria		1..1	string	DSTU2: Rule for server push criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.criteria Constraints: ext-1
extension:error		0..1	string	DSTU2: Latest error note (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.error Constraints: ext-1
extension:channel		1..1	(Complex)	DSTU2: The channel on which to report matches to the criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel Constraints: ext-1
extension:tag		0..*	Coding	DSTU2: A tag to add to matching resources (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.tag Binding: R2SubscriptionTagForR5 (0.1.0) (example): Tags to put on a resource after subscriptions have been sent. Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
status	?!Σ	1..1	code	requested | active | error | off | entered-in-error Binding: SubscriptionStatusCodes (required): The status of a subscription.
topic	Σ	1..1	canonical(SubscriptionTopic)	Reference to the subscription topic being subscribed to
channelType	Σ	1..1	Coding	Channel type for notifications Binding: SubscriptionChannelType (extensible): The type of method used to execute a subscription.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Subscription.status	Base	required	Subscription Status	📍5.0.0	FHIR Std.
Subscription.channelType	Base	extensible	Subscription Channel Type	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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	Subscription.implicitRules, Subscription.extension, Subscription.extension:criteria, Subscription.extension:error, Subscription.extension:channel, Subscription.extension:tag, Subscription.modifierExtension, Subscription.status, Subscription.topic, Subscription.channelType	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Subscription.extension, Subscription.extension:criteria, Subscription.extension:error, Subscription.extension:channel, Subscription.extension:tag, Subscription.modifierExtension	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(5.0.0)	Notification about a SubscriptionTopic
meta
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:meta		0..1	Meta	DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.meta
text
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:text		0..1	(Complex)	DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.text
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:criteria		1..1	string	DSTU2: Rule for server push criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.criteria
extension:error		0..1	string	DSTU2: Latest error note (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.error
extension:channel		1..1	(Complex)	DSTU2: The channel on which to report matches to the criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel
extension:tag		0..*	Coding	DSTU2: A tag to add to matching resources (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.tag Binding: R2SubscriptionTagForR5 (0.1.0) (example): Tags to put on a resource after subscriptions have been sent.
contact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contact		0..*	ContactPoint	DSTU2: contact additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.contact
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription(5.0.0)	Notification about a SubscriptionTopic
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:meta		0..1	Meta	DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.meta Constraints: ext-1
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	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: AllSecurityLabels (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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:text		0..1	(Complex)	DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.text Constraints: ext-1
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div	C	1..1	xhtml	Limited xhtml content Constraints: txt-1, txt-2
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:criteria		1..1	string	DSTU2: Rule for server push criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.criteria Constraints: ext-1
extension:error		0..1	string	DSTU2: Latest error note (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.error Constraints: ext-1
extension:channel		1..1	(Complex)	DSTU2: The channel on which to report matches to the criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel Constraints: ext-1
extension:tag		0..*	Coding	DSTU2: A tag to add to matching resources (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.tag Binding: R2SubscriptionTagForR5 (0.1.0) (example): Tags to put on a resource after subscriptions have been sent. Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Additional identifiers (business identifier)
name	Σ	0..1	string	Human readable name for this subscription
status	?!Σ	1..1	code	requested | active | error | off | entered-in-error Binding: SubscriptionStatusCodes (required): The status of a subscription.
topic	Σ	1..1	canonical(SubscriptionTopic)	Reference to the subscription topic being subscribed to
contact	Σ	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:contact		0..*	ContactPoint	DSTU2: contact additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.contact Constraints: ext-1
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	ΣC	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
end	Σ	0..1	instant	When to automatically delete the subscription
managingEntity	Σ	0..1	Reference(CareTeam | HealthcareService | Organization | RelatedPerson | Patient | Practitioner | PractitionerRole)	Entity responsible for Subscription changes
reason	Σ	0..1	string	Description of why this subscription was created
filterBy	ΣC	0..*	BackboneElement	Criteria for narrowing the subscription topic stream Constraints: scr-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
resourceType	Σ	0..1	uri	Allowed Resource (reference to definition) for this Subscription filter Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions) Additional Bindings Purpose AllResourceTypes UI Binding
filterParameter	Σ	1..1	string	Filter label defined in SubscriptionTopic
comparator	C	0..1	code	eq | ne | gt | lt | ge | le | sa | eb | ap Binding: SearchComparator (required): Search Comparator Codes applied to this filter.
modifier	C	0..1	code	missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate Binding: SearchModifierCode (required): Search Modifier Code applied to this filter.
value	Σ	1..1	string	Literal value or resource path
channelType	Σ	1..1	Coding	Channel type for notifications Binding: SubscriptionChannelType (extensible): The type of method used to execute a subscription.
endpoint	Σ	0..1	url	Where the channel points to
parameter		0..*	BackboneElement	Channel type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
name		1..1	string	Name (key) of the parameter
value		1..1	string	Value of the parameter to use or pass through
heartbeatPeriod	Σ	0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification
timeout	Σ	0..1	unsignedInt	Timeout in seconds to attempt notification delivery
contentType	Σ	0..1	code	MIME type to send, or omit for no payload Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
content	Σ	0..1	code	empty | id-only | full-resource Binding: SubscriptionPayloadContent (required): Codes to represent how much resource content to send in the notification payload.
maxCount	Σ	0..1	positiveInt	Maximum number of events that can be combined in a single notification
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Subscription.meta.security	Base	extensible	All Security Labels	📍5.0.0	tx.fhir.org
Subscription.meta.tag	Base	example	Common Tags	📍5.0.0	FHIR Std.
Subscription.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Subscription.text.status	Base	required	NarrativeStatus	📍5.0.0	FHIR Std.
Subscription.status	Base	required	Subscription Status	📍5.0.0	FHIR Std.
Subscription.contact.​system	Base	required	ContactPointSystem	📍5.0.0	tx.fhir.org
Subscription.contact.​use	Base	required	ContactPointUse	📍5.0.0	FHIR Std.
Subscription.filterBy.​resourceType	Base	extensible	Types used with Subscriptions	📍5.0.0	FHIR Std.
Subscription.filterBy.​comparator	Base	required	Search Comparator	📍5.0.0	FHIR Std.
Subscription.filterBy.​modifier	Base	required	Search Modifier Code	📍5.0.0	FHIR Std.
Subscription.channelType	Base	extensible	Subscription Channel Type	📍5.0.0	FHIR Std.
Subscription.contentType	Base	required	Mime Types	📍5.0.0	FHIR Std.
Subscription.content	Base	required	Subscription Payload Content	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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	Subscription.meta, Subscription.meta.extension, Subscription.meta.extension:meta, Subscription.meta.versionId, Subscription.meta.lastUpdated, Subscription.meta.source, Subscription.meta.profile, Subscription.meta.security, Subscription.meta.tag, Subscription.implicitRules, Subscription.language, Subscription.text, Subscription.text.extension, Subscription.text.extension:text, Subscription.text.status, Subscription.text.div, Subscription.extension, Subscription.extension:criteria, Subscription.extension:error, Subscription.extension:channel, Subscription.extension:tag, Subscription.modifierExtension, Subscription.identifier, Subscription.name, Subscription.status, Subscription.topic, Subscription.contact, Subscription.contact.extension, Subscription.contact.extension:contact, Subscription.contact.system, Subscription.contact.value, Subscription.contact.use, Subscription.contact.rank, Subscription.contact.period, Subscription.end, Subscription.managingEntity, Subscription.reason, Subscription.filterBy, Subscription.filterBy.extension, Subscription.filterBy.modifierExtension, Subscription.filterBy.resourceType, Subscription.filterBy.filterParameter, Subscription.filterBy.comparator, Subscription.filterBy.modifier, Subscription.filterBy.value, Subscription.channelType, Subscription.endpoint, Subscription.parameter, Subscription.parameter.extension, Subscription.parameter.modifierExtension, Subscription.parameter.name, Subscription.parameter.value, Subscription.heartbeatPeriod, Subscription.timeout, Subscription.contentType, Subscription.content, Subscription.maxCount	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Subscription.meta.extension, Subscription.meta.extension:meta, Subscription.text.extension, Subscription.text.extension:text, Subscription.extension, Subscription.extension:criteria, Subscription.extension:error, Subscription.extension:channel, Subscription.extension:tag, Subscription.modifierExtension, Subscription.contact.extension, Subscription.contact.extension:contact, Subscription.filterBy.extension, Subscription.filterBy.modifierExtension, Subscription.parameter.extension, Subscription.parameter.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
scr-1	error	Subscription.filterBy	Subscription filters may only contain a modifier or a comparator	(comparator.exists() and modifier.exists()).not()
txt-1	error	Subscription.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes	htmlChecks()
txt-2	error	Subscription.text.div	The narrative SHALL have some non-whitespace content	htmlChecks()

This structure is derived from Subscription

Summary

Mandatory: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.meta|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.text|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.criteria|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.error|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.tag|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.contact|0.1.0

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription(5.0.0)	Notification about a SubscriptionTopic
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:criteria		1..1	string	DSTU2: Rule for server push criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.criteria Constraints: ext-1
extension:error		0..1	string	DSTU2: Latest error note (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.error Constraints: ext-1
extension:channel		1..1	(Complex)	DSTU2: The channel on which to report matches to the criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel Constraints: ext-1
extension:tag		0..*	Coding	DSTU2: A tag to add to matching resources (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.tag Binding: R2SubscriptionTagForR5 (0.1.0) (example): Tags to put on a resource after subscriptions have been sent. Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
status	?!Σ	1..1	code	requested | active | error | off | entered-in-error Binding: SubscriptionStatusCodes (required): The status of a subscription.
topic	Σ	1..1	canonical(SubscriptionTopic)	Reference to the subscription topic being subscribed to
channelType	Σ	1..1	Coding	Channel type for notifications Binding: SubscriptionChannelType (extensible): The type of method used to execute a subscription.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Subscription.status	Base	required	Subscription Status	📍5.0.0	FHIR Std.
Subscription.channelType	Base	extensible	Subscription Channel Type	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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	Subscription.implicitRules, Subscription.extension, Subscription.extension:criteria, Subscription.extension:error, Subscription.extension:channel, Subscription.extension:tag, Subscription.modifierExtension, Subscription.status, Subscription.topic, Subscription.channelType	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Subscription.extension, Subscription.extension:criteria, Subscription.extension:error, Subscription.extension:channel, Subscription.extension:tag, Subscription.modifierExtension	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(5.0.0)	Notification about a SubscriptionTopic
meta
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:meta		0..1	Meta	DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.meta
text
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:text		0..1	(Complex)	DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.text
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:criteria		1..1	string	DSTU2: Rule for server push criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.criteria
extension:error		0..1	string	DSTU2: Latest error note (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.error
extension:channel		1..1	(Complex)	DSTU2: The channel on which to report matches to the criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel
extension:tag		0..*	Coding	DSTU2: A tag to add to matching resources (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.tag Binding: R2SubscriptionTagForR5 (0.1.0) (example): Tags to put on a resource after subscriptions have been sent.
contact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contact		0..*	ContactPoint	DSTU2: contact additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.contact
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	Subscription(5.0.0)	Notification about a SubscriptionTopic
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:meta		0..1	Meta	DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.meta Constraints: ext-1
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	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: AllSecurityLabels (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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:text		0..1	(Complex)	DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.text Constraints: ext-1
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div	C	1..1	xhtml	Limited xhtml content Constraints: txt-1, txt-2
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:criteria		1..1	string	DSTU2: Rule for server push criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.criteria Constraints: ext-1
extension:error		0..1	string	DSTU2: Latest error note (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.error Constraints: ext-1
extension:channel		1..1	(Complex)	DSTU2: The channel on which to report matches to the criteria (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel Constraints: ext-1
extension:tag		0..*	Coding	DSTU2: A tag to add to matching resources (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.tag Binding: R2SubscriptionTagForR5 (0.1.0) (example): Tags to put on a resource after subscriptions have been sent. Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Additional identifiers (business identifier)
name	Σ	0..1	string	Human readable name for this subscription
status	?!Σ	1..1	code	requested | active | error | off | entered-in-error Binding: SubscriptionStatusCodes (required): The status of a subscription.
topic	Σ	1..1	canonical(SubscriptionTopic)	Reference to the subscription topic being subscribed to
contact	Σ	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:contact		0..*	ContactPoint	DSTU2: contact additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.contact Constraints: ext-1
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	ΣC	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
end	Σ	0..1	instant	When to automatically delete the subscription
managingEntity	Σ	0..1	Reference(CareTeam | HealthcareService | Organization | RelatedPerson | Patient | Practitioner | PractitionerRole)	Entity responsible for Subscription changes
reason	Σ	0..1	string	Description of why this subscription was created
filterBy	ΣC	0..*	BackboneElement	Criteria for narrowing the subscription topic stream Constraints: scr-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
resourceType	Σ	0..1	uri	Allowed Resource (reference to definition) for this Subscription filter Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions) Additional Bindings Purpose AllResourceTypes UI Binding
filterParameter	Σ	1..1	string	Filter label defined in SubscriptionTopic
comparator	C	0..1	code	eq | ne | gt | lt | ge | le | sa | eb | ap Binding: SearchComparator (required): Search Comparator Codes applied to this filter.
modifier	C	0..1	code	missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate Binding: SearchModifierCode (required): Search Modifier Code applied to this filter.
value	Σ	1..1	string	Literal value or resource path
channelType	Σ	1..1	Coding	Channel type for notifications Binding: SubscriptionChannelType (extensible): The type of method used to execute a subscription.
endpoint	Σ	0..1	url	Where the channel points to
parameter		0..*	BackboneElement	Channel type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
name		1..1	string	Name (key) of the parameter
value		1..1	string	Value of the parameter to use or pass through
heartbeatPeriod	Σ	0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification
timeout	Σ	0..1	unsignedInt	Timeout in seconds to attempt notification delivery
contentType	Σ	0..1	code	MIME type to send, or omit for no payload Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
content	Σ	0..1	code	empty | id-only | full-resource Binding: SubscriptionPayloadContent (required): Codes to represent how much resource content to send in the notification payload.
maxCount	Σ	0..1	positiveInt	Maximum number of events that can be combined in a single notification
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Subscription.meta.security	Base	extensible	All Security Labels	📍5.0.0	tx.fhir.org
Subscription.meta.tag	Base	example	Common Tags	📍5.0.0	FHIR Std.
Subscription.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Subscription.text.status	Base	required	NarrativeStatus	📍5.0.0	FHIR Std.
Subscription.status	Base	required	Subscription Status	📍5.0.0	FHIR Std.
Subscription.contact.​system	Base	required	ContactPointSystem	📍5.0.0	tx.fhir.org
Subscription.contact.​use	Base	required	ContactPointUse	📍5.0.0	FHIR Std.
Subscription.filterBy.​resourceType	Base	extensible	Types used with Subscriptions	📍5.0.0	FHIR Std.
Subscription.filterBy.​comparator	Base	required	Search Comparator	📍5.0.0	FHIR Std.
Subscription.filterBy.​modifier	Base	required	Search Modifier Code	📍5.0.0	FHIR Std.
Subscription.channelType	Base	extensible	Subscription Channel Type	📍5.0.0	FHIR Std.
Subscription.contentType	Base	required	Mime Types	📍5.0.0	FHIR Std.
Subscription.content	Base	required	Subscription Payload Content	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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	Subscription.meta, Subscription.meta.extension, Subscription.meta.extension:meta, Subscription.meta.versionId, Subscription.meta.lastUpdated, Subscription.meta.source, Subscription.meta.profile, Subscription.meta.security, Subscription.meta.tag, Subscription.implicitRules, Subscription.language, Subscription.text, Subscription.text.extension, Subscription.text.extension:text, Subscription.text.status, Subscription.text.div, Subscription.extension, Subscription.extension:criteria, Subscription.extension:error, Subscription.extension:channel, Subscription.extension:tag, Subscription.modifierExtension, Subscription.identifier, Subscription.name, Subscription.status, Subscription.topic, Subscription.contact, Subscription.contact.extension, Subscription.contact.extension:contact, Subscription.contact.system, Subscription.contact.value, Subscription.contact.use, Subscription.contact.rank, Subscription.contact.period, Subscription.end, Subscription.managingEntity, Subscription.reason, Subscription.filterBy, Subscription.filterBy.extension, Subscription.filterBy.modifierExtension, Subscription.filterBy.resourceType, Subscription.filterBy.filterParameter, Subscription.filterBy.comparator, Subscription.filterBy.modifier, Subscription.filterBy.value, Subscription.channelType, Subscription.endpoint, Subscription.parameter, Subscription.parameter.extension, Subscription.parameter.modifierExtension, Subscription.parameter.name, Subscription.parameter.value, Subscription.heartbeatPeriod, Subscription.timeout, Subscription.contentType, Subscription.content, Subscription.maxCount	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Subscription.meta.extension, Subscription.meta.extension:meta, Subscription.text.extension, Subscription.text.extension:text, Subscription.extension, Subscription.extension:criteria, Subscription.extension:error, Subscription.extension:channel, Subscription.extension:tag, Subscription.modifierExtension, Subscription.contact.extension, Subscription.contact.extension:contact, Subscription.filterBy.extension, Subscription.filterBy.modifierExtension, Subscription.parameter.extension, Subscription.parameter.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
scr-1	error	Subscription.filterBy	Subscription filters may only contain a modifier or a comparator	(comparator.exists() and modifier.exists()).not()
txt-1	error	Subscription.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes	htmlChecks()
txt-2	error	Subscription.text.div	The narrative SHALL have some non-whitespace content	htmlChecks()

This structure is derived from Subscription

Summary

Mandatory: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.meta|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.text|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.criteria|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.error|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.tag|0.1.0
• http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.contact|0.1.0

Maturity: 0

Other representations of profile: CSV, Excel, Schematron