Summary
Diagnostics
Care Provision
Request & Response
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Documents
Terminology
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
Encounter
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
StructureDefinition
StructureMap
ValueSet
default
The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
Subscription
Path
Subscription
Id
Subscription
Cardinality
0 - *
Definition
The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3 [error]
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
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5 [error]
If a resource is contained in another resource, it SHALL NOT have a security label
dom-6 [warning]
A resource should have narrative for robust management
Path
Subscription.status
Id
Subscription.status
Type
Cardinality
1 - 1
Definition
The status of the subscription, which marks the server state for managing the subscription.
Comment
A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Binding
Strength
required
Description
The status of a subscription.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.contact
Id
Subscription.contact
Type
Cardinality
0 - *
Definition
Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.contact.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
Subscription.contact.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.contact.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.contact.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.contact.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.contact.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
Subscription.contact.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
Subscription.end
Id
Subscription.end
Type
Cardinality
0 - 1
Definition
The time for the server to turn the subscription off.
Comment
The server is permitted to deviate from this time but should observe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.reason
Id
Subscription.reason
Type
Cardinality
1 - 1
Definition
A description of why this subscription is defined.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.criteria
Id
Subscription.criteria
Type
Cardinality
1 - 1
Definition
The rules that the server should use to determine when to generate notifications for this subscription.
Comment
The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.error
Id
Subscription.error
Type
Cardinality
0 - 1
Definition
A record of the last error that occurred when the server processed a notification.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.channel
Id
Subscription.channel
Type
Cardinality
1 - 1
Definition
Details where to send notifications when resources are received that meet the criteria.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
Subscription.channel.type
Id
Subscription.channel.type
Type
Cardinality
1 - 1
Definition
The type of channel to send notifications on.
Comment
Binding
Strength
required
Description
The type of method used to execute a subscription.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.channel.endpoint
Id
Subscription.channel.endpoint
Type
Cardinality
0 - 1
Definition
The url that describes the actual end-point to send messages to.
Comment
For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.channel.payload
Id
Subscription.channel.payload
Type
Cardinality
0 - 1
Definition
The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.
Comment
Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Binding
Strength
required
Description
BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
Subscription.channel.header
Id
Subscription.channel.header
Type
Cardinality
0 - *
Definition
Additional headers / information to send as part of the notification.
Comment
Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children