Patient Master Identity Registry (PMIR)
1.5.0 - Trial-Implementation International flag

This page is part of the IHE Patient Master Identity Registry (PMIR) (v1.5.0: Trial Implementation) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: IHE Patient Master Identity Registry Subscription

Official URL: https://profiles.ihe.net/ITI/PMIR/StructureDefinition/IHE.PMIR.Subscription Version: 1.5.0
Active as of 2022-08-08 Computable Name: PMIRSubscription

StructureDefinition for Subscrption resource constraints in the IHE PMIR Profile.

See Section 3.94.4.1.2.1.1 for details on constraints for criteria.

Usage:

Formal Views of Profile Content

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

This structure is derived from Subscription

Summary

Mandatory: 2 elements (2 nested mandatory elements)

This structure is derived from Subscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... contact
.... system 1..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
... criteria 1..1stringSee Section 2:3.94.4.1.2.1.1
... channel
.... type 1..1coderest-hook | websocket | email | sms | message
Required Pattern: message
.... endpoint 1..1urlWhere the channel points to
.... payload 1..1codeMIME type to send, or omit for no payload

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

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

... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... end Σ0..1instantWhen to automatically delete the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria Σ1..1stringSee Section 2:3.94.4.1.2.1.1
... error Σ0..1stringLatest error note
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Required Pattern: message
.... endpoint Σ1..1urlWhere the channel points to
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

.... header Σ0..*stringUsage depends on the channel type

doco Documentation for this format

This structure is derived from Subscription

Summary

Mandatory: 2 elements (2 nested mandatory elements)

Differential View

This structure is derived from Subscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... contact
.... system 1..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
... criteria 1..1stringSee Section 2:3.94.4.1.2.1.1
... channel
.... type 1..1coderest-hook | websocket | email | sms | message
Required Pattern: message
.... endpoint 1..1urlWhere the channel points to
.... payload 1..1codeMIME type to send, or omit for no payload

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

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

... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... end Σ0..1instantWhen to automatically delete the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria Σ1..1stringSee Section 2:3.94.4.1.2.1.1
... error Σ0..1stringLatest error note
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.


Required Pattern: message
.... endpoint Σ1..1urlWhere the channel points to
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

.... header Σ0..*stringUsage depends on the channel type

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Subscription.languagepreferredCommonLanguages
Max Binding: AllLanguages
Subscription.statusrequiredSubscriptionStatus
Subscription.contact.systemrequiredContactPointSystem
Subscription.contact.userequiredContactPointUse
Subscription.channel.typerequiredPattern: message
Subscription.channel.payloadrequiredMime Types