Subscription Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-subscription |
|---|---|
| Status | draft (experimental) · 1.26.0 |
| Base | Subscription (constraint) |
| Source | FSH · JSON |
Nexus EMR profile for Subscription (R4 criteria-based) -- server-side push notification registration managed by the subscription manager service. Infrastructure and a data-egress security surface: no effective date, and R4 gives it no identifier element. First pass; note the R5 redesign migration path.
Elements / Snapshot
The full effective definition: base Subscription with this profile's constraints applied.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | 0..* | Nexus EMR Subscription Core (R4 criteria-based) Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, subscription-deliverable |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| versionId | 0..1 | id | Version specific identifier i Invariants: ele-1 |
|
| lastUpdated | 0..1 | instant | When the resource version last changed i Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| profile | 0..* | canonical | Profiles this resource claims to conform to i Invariants: ele-1 |
|
| security | 0..* | Coding | Security Labels applied to this resource i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| tag | 0..* | Coding | Tags applied to this resource i Binding: common-tags ( example)Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | S | 0..1 | Narrative | Narrative i Invariants: ele-1 |
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| status | S ?! | 1..1 | code | requested | active | error | off i Binding: subscription-status ( required)Invariants: ele-1 |
| contact | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) Invariants: ele-1 |
|
| end | S | 0..1 | instant | When the subscription expires i Invariants: ele-1 |
| reason | S | 1..1 | string | Why this subscription exists i Invariants: ele-1 |
| criteria | S | 1..1 | string | The search expression selecting resources to notify on i Invariants: ele-1 |
| error | 0..1 | string | Latest error note Invariants: ele-1 |
|
| channel | S | 1..1 | BackboneElement | How notifications are delivered Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| type | S | 1..1 | code | rest-hook | websocket | email | sms | message Binding: subscription-channel-type ( required)Invariants: ele-1 |
| endpoint | S | 0..1 | url | Where notifications are sent i Invariants: ele-1 |
| payload | S | 0..1 | code | MIME type of the notification body; absent means id-only notification i Binding: mimetypes ( required)Invariants: ele-1 |
| header | S | 0..* | string | Headers sent with the notification (e.g. authorization) i Invariants: ele-1 |