IHE.ITI.PMIR\IHE Patient Master Identity Registry Subscription

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:

Derived from this Resource Profile: IHE Patient Master Identity Registry Subscription request
Examples for this Resource Profile: Subscription/ex-subscription

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

Name	Card.	Type	Description & Constraints
Subscription	0..*	Subscription	Server push subscription criteria
contact
system	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other
value	1..1	string	The actual contact point details
criteria	1..1	string	See Section 2:3.94.4.1.2.1.1
channel
type	1..1	code	rest-hook \| websocket \| email \| sms \| message Required Pattern: message
endpoint	1..1	url	Where the channel points to
payload	1..1	code	MIME type to send, or omit for no payload
Documentation for this format

Description & Constraints

Subscription

0..*

Subscription

Server push subscription criteria

id

Σ

0..1

string

Logical id of this artifact

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): A human language.

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)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations
Slice: Unordered, Open by value:url

system

ΣI

1..1

code

phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

value

Σ

1..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

reason

Σ

1..1

string

Description of why this subscription was created

criteria

Σ

1..1

string

See Section 2:3.94.4.1.2.1.1

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

extension

0..*

Extension

Additional content defined by implementations

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.

Required Pattern: message

endpoint

Σ

1..1

url

Where the channel points to

payload

Σ

1..1

code

MIME 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..*

string

Usage depends on the channel type

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

Name	Card.	Type	Description & Constraints
Subscription	0..*	Subscription	Server push subscription criteria
contact
system	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other
value	1..1	string	The actual contact point details
criteria	1..1	string	See Section 2:3.94.4.1.2.1.1
channel
type	1..1	code	rest-hook \| websocket \| email \| sms \| message Required Pattern: message
endpoint	1..1	url	Where the channel points to
payload	1..1	code	MIME type to send, or omit for no payload
Documentation for this format

Snapshot View

Description & Constraints

Subscription

0..*

Subscription

Server push subscription criteria

id

Σ

0..1

string

Logical id of this artifact

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): A human language.

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)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations
Slice: Unordered, Open by value:url

system

ΣI

1..1

code

phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

value

Σ

1..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

reason

Σ

1..1

string

Description of why this subscription was created

criteria

Σ

1..1

string

See Section 2:3.94.4.1.2.1.1

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

extension

0..*

Extension

Additional content defined by implementations

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.

Required Pattern: message

endpoint

Σ

1..1

url

Where the channel points to

payload

Σ

1..1

code

MIME 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..*

string

Usage depends on the channel type

Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Subscription.language	preferred	CommonLanguages Max Binding: AllLanguages
Subscription.status	required	SubscriptionStatus
Subscription.contact.system	required	ContactPointSystem
Subscription.contact.use	required	ContactPointUse
Subscription.channel.type	required	Pattern: message
Subscription.channel.payload	required	Mime Types

<prev

top

next>

IG © 2022+ IHE IT Infrastructure Technical Committee. Package ihe.iti.pmir#1.5.0 based on FHIR 4.0.1. Generated 2022-08-08
Links: Table of Contents | QA Report | New Issue | Issues Version History | | Propose a change external