Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1 United States of America flag

Making Electronic Data More available for Research and Public Health (MedMorph), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-medmorph/ and changes regularly. See the Directory of published versions

Resource Profile: MedMorph Encounter Start Subscription

Official URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/medmorph-encounter-start-subscription Version: 1.0.0
Active as of 2023-06-08 Computable Name: MedMorphEncounterStartSubscription

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

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from BackportSubscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionMedMorph Encounter Start Subscription
... criteria 1..1stringMedMorph Encounter Start Topic URL
Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
.... filterCriteria 0..1stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
..... valueString 1..1stringFiltering critiera applied to events
Required Pattern: Encounter?status=in-progress
... channel
.... type 1..1coderest-hook | websocket | email | sms | message
Fixed Value: rest-hook

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionMedMorph Encounter Start Subscription
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required): The status of a subscription.

... criteria SΣ1..1stringMedMorph Encounter Start Topic URL
Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
.... filterCriteria S0..1stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
..... Slices for value[x] 1..1stringFiltering critiera applied to events
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 1..1stringFiltering critiera applied to events
Required Pattern: Encounter?status=in-progress
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Fixed Value: rest-hook
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... payload Σ1..1codeMIME 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..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Subscription.statusrequiredSubscriptionStatus
Subscription.channel.typerequiredFixed Value: rest-hook
Subscription.channel.payloadrequiredMime Types (a valid code from urn:ietf:bcp:13)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubscriptionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubscriptionIf 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-4errorSubscriptionIf 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-5errorSubscriptionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubscriptionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionMedMorph Encounter Start Subscription
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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 ?!Σ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 Σ1..1stringDescription of why this subscription was created
... criteria SΣ1..1stringMedMorph Encounter Start Topic URL
Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... filterCriteria S0..1stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
..... Slices for value[x] 1..1stringFiltering critiera applied to events
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 1..1stringFiltering critiera applied to events
Required Pattern: Encounter?status=in-progress
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... 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
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Fixed Value: rest-hook
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
..... value 0..1codePrimitive value for code
.... endpoint Σ0..1urlWhere the channel points to
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)
..... value 0..1codePrimitive value for code
.... header Σ0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Subscription.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Subscription.statusrequiredSubscriptionStatus
Subscription.channel.typerequiredFixed Value: rest-hook
Subscription.channel.payloadrequiredMime Types (a valid code from urn:ietf:bcp:13)

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningSubscription.containedContaining 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

Differential View

This structure is derived from BackportSubscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionMedMorph Encounter Start Subscription
... criteria 1..1stringMedMorph Encounter Start Topic URL
Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
.... filterCriteria 0..1stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
..... valueString 1..1stringFiltering critiera applied to events
Required Pattern: Encounter?status=in-progress
... channel
.... type 1..1coderest-hook | websocket | email | sms | message
Fixed Value: rest-hook

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionMedMorph Encounter Start Subscription
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required): The status of a subscription.

... criteria SΣ1..1stringMedMorph Encounter Start Topic URL
Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
.... filterCriteria S0..1stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
..... Slices for value[x] 1..1stringFiltering critiera applied to events
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 1..1stringFiltering critiera applied to events
Required Pattern: Encounter?status=in-progress
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Fixed Value: rest-hook
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... payload Σ1..1codeMIME 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..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Subscription.statusrequiredSubscriptionStatus
Subscription.channel.typerequiredFixed Value: rest-hook
Subscription.channel.payloadrequiredMime Types (a valid code from urn:ietf:bcp:13)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubscriptionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubscriptionIf 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-4errorSubscriptionIf 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-5errorSubscriptionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubscriptionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionMedMorph Encounter Start Subscription
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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 ?!Σ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 Σ1..1stringDescription of why this subscription was created
... criteria SΣ1..1stringMedMorph Encounter Start Topic URL
Required Pattern: http://hl7.org/fhir/us/medmorph/SubscriptionTopic/encounter-start
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... filterCriteria S0..1stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
..... Slices for value[x] 1..1stringFiltering critiera applied to events
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 1..1stringFiltering critiera applied to events
Required Pattern: Encounter?status=in-progress
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... 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
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Fixed Value: rest-hook
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
..... value 0..1codePrimitive value for code
.... endpoint Σ0..1urlWhere the channel points to
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)
..... value 0..1codePrimitive value for code
.... header Σ0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Subscription.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Subscription.statusrequiredSubscriptionStatus
Subscription.channel.typerequiredFixed Value: rest-hook
Subscription.channel.payloadrequiredMime Types (a valid code from urn:ietf:bcp:13)

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningSubscription.containedContaining 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

 

Other representations of profile: CSV, Excel, Schematron