Complex
Primitive
ActivityDefinition
CapabilityStatement
CodeSystem
Composition
ConceptMap
Encounter
Library
List
Measure
MessageHeader
Observation
Patient
PlanDefinition
Questionnaire
Resource
ServiceDefinition
StructureDefinition
StructureMap
ValueSet
default
Base StructureDefinition for Subscription Resource
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 is able to take an appropriate action.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1 [error]
If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
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.
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
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
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.
Path
Subscription.contact.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. 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.
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. Contacts are ranked with lower values coming before higher values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Path
Subscription.contact.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
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.
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 that the period is ongoing. 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 a end value of 2012-02-03.
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.
Path
Subscription.reason
Id
Subscription.reason
Type
Cardinality
1 - 1
Definition
A description of why this subscription is defined.
Comment
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 a search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".
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
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
Path
Subscription.channel.type
Id
Subscription.channel.type
Type
Cardinality
1 - 1
Definition
The type of channel to send notifications on.
Comment
Path
Subscription.channel.endpoint
Id
Subscription.channel.endpoint
Type
Cardinality
0 - 1
Definition
The uri 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 their may be more than one, clients should avoid using relative URIs).
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.
Comment
Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
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.
Path
Subscription.tag
Id
Subscription.tag
Type
Cardinality
0 - *
Definition
A tag to add to any resource that matches the criteria, after the subscription is processed.
Comment
So that other systems can tell which resources have been the subject of a notification.
Path
Subscription.tag.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
Subscription.tag.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
Subscription.tag.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
Subscription.tag.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
Subscription.tag.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.