Post-Acute FHIR Based Orders
0.1.0 - STU 1 Ballot
Post-Acute FHIR Based Orders
0.1.0 - STU 1 Ballot
This page is part of the Post Acute Orders FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
Post Acute Orders Subscription Profile
The subscription resource should accompany the initial message bundle to provide a mechanism of informing the ordering provider when there is a change in the order as indicated by a change in the Task resorurce.
The subscriber has the option of receiving a notifiction when a change occurs or receiving the updated task and any relevant order resources (device, service, medication)
The official URL for this profile is:
http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAO-subscription4
This section will be expanded in the STU 1 version
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Subscription
This structure is derived from Subscription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Subscription | 0..* | Subscription | Server push subscription criteria | |
  status | S | 1..1 | code | requested | active | error | off |
| reason | S | 1..1 | string | Description of why this subscription was created |
| criteria | S | 1..1 | string | Rule for server push |
 channel | S | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
 type | S | 1..1 | code | rest-hook | websocket | email | sms | message |
| endpoint | S | 0..1 | url | Where the channel points to |
| payload | S | 0..1 | code | MIME type to send, or omit for no payload |
 header | S | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | I | 0..* | Subscription | Server push subscription criteria |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣI | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required) |
| contact | ΣI | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| end | ΣI | 0..1 | instant | When to automatically delete the subscription |
| reason | SΣI | 1..1 | string | Description of why this subscription was created |
| criteria | SΣI | 1..1 | string | Rule for server push |
| error | ΣI | 0..1 | string | Latest error note |
| channel | SΣI | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | SΣI | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required) |
| endpoint | SΣI | 0..1 | url | Where the channel points to |
| payload | SΣI | 0..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required) |
| header | SΣI | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
This structure is derived from Subscription
Differential View
This structure is derived from Subscription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | 0..* | Subscription | Server push subscription criteria | |
| status | S | 1..1 | code | requested | active | error | off |
| reason | S | 1..1 | string | Description of why this subscription was created |
| criteria | S | 1..1 | string | Rule for server push |
| channel | S | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
| type | S | 1..1 | code | rest-hook | websocket | email | sms | message |
| endpoint | S | 0..1 | url | Where the channel points to |
| payload | S | 0..1 | code | MIME type to send, or omit for no payload |
| header | S | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | I | 0..* | Subscription | Server push subscription criteria |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣI | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required) |
| contact | ΣI | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| end | ΣI | 0..1 | instant | When to automatically delete the subscription |
| reason | SΣI | 1..1 | string | Description of why this subscription was created |
| criteria | SΣI | 1..1 | string | Rule for server push |
| error | ΣI | 0..1 | string | Latest error note |
| channel | SΣI | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | SΣI | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required) |
| endpoint | SΣI | 0..1 | url | Where the channel points to |
| payload | SΣI | 0..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required) |
| header | SΣI | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Subscription.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Subscription.status | required | SubscriptionStatus |
| Subscription.channel.type | required | SubscriptionChannelType |
| 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.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()) |
This section will be expanded in the STU 1 version
IG © 2020+ HL7. Package hl7.fhir.us.dme-orders#0.1.0 based on FHIR 4.0.1. Generated 2020-04-08
Links: Table of Contents |
QA Report | Search
| Version History 
|
|
Propose a change