This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) (v1.0.0: STU1 Release 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: MedMorph Encounter Start Subscription

This profile describes the US Public Health Encounter Start Subscription to be used for MedMorph based plandefinition actions.

Usage:

• Examples for this Resource Profile: Subscription/encounter-start-subscription-example

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 BackportSubscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	BackportSubscription	MedMorph Encounter Start Subscription
criteria		1..1	string	MedMorph Encounter Start Topic URL Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
filterCriteria		0..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
valueString		1..1	string	Filtering critiera applied to events Required Pattern: Encounter?status=in-progress
channel
type		1..1	code	rest-hook | websocket | email | sms | message Fixed Value: rest-hook
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	BackportSubscription	MedMorph Encounter Start Subscription
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
reason	Σ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	MedMorph Encounter Start Topic URL Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
filterCriteria	S	0..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
Slices for value[x]		1..1	string	Filtering critiera applied to events Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Filtering critiera applied to events Required Pattern: Encounter?status=in-progress
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	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
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
payload	Σ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Subscription.status	required	SubscriptionStatus
Subscription.channel.type	required	Fixed Value: rest-hook
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
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.exists() and ('#'+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(uri) = '#').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()

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	BackportSubscription	MedMorph Encounter Start Subscription
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): IETF language tag 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	?!Σ	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	Σ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	MedMorph Encounter Start Topic URL Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	S	0..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
Slices for value[x]		1..1	string	Filtering critiera applied to events Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Filtering critiera applied to events Required Pattern: Encounter?status=in-progress
value		0..1	string	Primitive value for string Max Length: 1048576
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
value		0..1	code	Primitive value for code
endpoint	Σ	0..1	url	Where the channel points to
payload	Σ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
value		0..1	code	Primitive value for code
header	Σ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Subscription.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Subscription.status	required	SubscriptionStatus
Subscription.channel.type	required	Fixed Value: rest-hook
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-r4b	warning	Subscription.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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 BackportSubscription

Summary

Mandatory: 1 element (1 nested mandatory element)
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria

Differential View

This structure is derived from BackportSubscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	BackportSubscription	MedMorph Encounter Start Subscription
criteria		1..1	string	MedMorph Encounter Start Topic URL Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
filterCriteria		0..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
valueString		1..1	string	Filtering critiera applied to events Required Pattern: Encounter?status=in-progress
channel
type		1..1	code	rest-hook | websocket | email | sms | message Fixed Value: rest-hook
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	BackportSubscription	MedMorph Encounter Start Subscription
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
reason	Σ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	MedMorph Encounter Start Topic URL Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
filterCriteria	S	0..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
Slices for value[x]		1..1	string	Filtering critiera applied to events Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Filtering critiera applied to events Required Pattern: Encounter?status=in-progress
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	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
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
payload	Σ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Subscription.status	required	SubscriptionStatus
Subscription.channel.type	required	Fixed Value: rest-hook
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
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.exists() and ('#'+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(uri) = '#').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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	BackportSubscription	MedMorph Encounter Start Subscription
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): IETF language tag 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	?!Σ	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	Σ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	MedMorph Encounter Start Topic URL Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	S	0..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
Slices for value[x]		1..1	string	Filtering critiera applied to events Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Filtering critiera applied to events Required Pattern: Encounter?status=in-progress
value		0..1	string	Primitive value for string Max Length: 1048576
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
value		0..1	code	Primitive value for code
endpoint	Σ	0..1	url	Where the channel points to
payload	Σ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
value		0..1	code	Primitive value for code
header	Σ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Subscription.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Subscription.status	required	SubscriptionStatus
Subscription.channel.type	required	Fixed Value: rest-hook
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-r4b	warning	Subscription.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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 BackportSubscription

Summary

Mandatory: 1 element (1 nested mandatory element)
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria

Other representations of profile: CSV, Excel, Schematron