CH EPR mHealth (R4)
0.2.0 - DSTU 1 Informative Ballot
CH EPR mHealth (R4)
0.2.0 - DSTU 1 Informative Ballot
This page is part of the CH EPR mHealth (R4) (v0.2.0: DSTU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://ihe.net/fhir/StructureDefinition/IHE.PMIR.Subscription.request |
| Version: | 0.2.0 |
| Name: | IHE_PMIR_Subscription_request |
| Title: | IHE PMIR Subscription request |
| Status: | Draft as of 2019-12-04 |
| Definition: | See https://wiki.ihe.net/index.php/Patient_Master_Identity_Registry_(PMIR) |
| Publisher: | eHealth Suisse |
| Copyright: | CC-BY-SA-4.0 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://ihe.net/fhir/StructureDefinition/IHE.PMIR.Subscription.request
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from IHE_PMIR_Subscription
This structure is derived from IHE_PMIR_Subscription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Subscription | 0..* | IHE_PMIR_Subscription | Server push subscription criteria | |
  status | 1..1 | code | requested | active | error | off Fixed Value: requested | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | 0..* | IHE_PMIR_Subscription | Server push subscription criteria | |
  id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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. Fixed Value: requested |
 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 | Rule for server push |
| 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. Fixed Value: 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | 0..* | IHE_PMIR_Subscription | Server push subscription criteria | |
| Documentation for this format | ||||
This structure is derived from IHE_PMIR_Subscription
Differential View
This structure is derived from IHE_PMIR_Subscription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | 0..* | IHE_PMIR_Subscription | Server push subscription criteria | |
| status | 1..1 | code | requested | active | error | off Fixed Value: requested | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | 0..* | IHE_PMIR_Subscription | Server push subscription criteria | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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. Fixed Value: requested |
| 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 | Rule for server push |
| 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. Fixed Value: 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
| Path | Conformance | ValueSet / Code |
| Subscription.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Subscription.status | required | Fixed Value: requested |
| Subscription.contact.system | required | ContactPointSystem |
| Subscription.contact.use | required | ContactPointUse |
| Subscription.channel.type | required | Fixed Value: message |
| Subscription.channel.payload | required | Mime Types |
| Id | Path | Details | Requirements |
| dom-2 | Subscription | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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().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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | 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 | Subscription | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Subscription | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Subscription.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Subscription.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Subscription.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Subscription.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Subscription.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Subscription.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Subscription.contact.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.contact.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.contact.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.contact.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.reason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.criteria | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.error | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.channel | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.channel.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Subscription.channel.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Subscription.channel.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Subscription.channel.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Subscription.channel.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.channel.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.channel.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Subscription.channel.header | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |