Termini

CodeSystemsConceptSystemsStructureDefinitionsValueSetsPackagesConflicts
StructureDefinitionsSubscription

http://hl7.org/fhir/StructureDefinition/Subscription|5.0.0

The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
StructureJSONDependenciesFHIRSchemaOther VersionsDependant (0)ElementsSummary
NameFlagsCardTypeDescription & Constraints
Subscription
0..*Notification about a SubscriptionTopic
 
identifier
Σ
0..*IdentifierAdditional identifiers (business identifier)
 
name
Σ
0..1stringHuman readable name for this subscription
 
status *
?!Σ
1..1coderequested | active | error | off | entered-in-error SubscriptionStatusCodes (required)
 
topic *
Σ
1..1canonicalReference to the subscription topic being subscribed to
 
contact
Σ
0..*ContactPointContact details for source (e.g. troubleshooting)
 
end
Σ
0..1instantWhen to automatically delete the subscription
 
managingEntity
Σ
0..1ReferenceEntity responsible for Subscription changes
 
reason
Σ
0..1stringDescription of why this subscription was created
 
filterBy
Σ
0..*BackboneElementCriteria for narrowing the subscription topic stream
 
 
resourceType
Σ
0..1uriAllowed Resource (reference to definition) for this Subscription filter FHIRTypes (extensible)
 
 
filterParameter *
Σ
1..1stringFilter label defined in SubscriptionTopic
 
 
comparator
0..1codeeq | ne | gt | lt | ge | le | sa | eb | ap SearchComparator (required)
 
 
modifier
0..1codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate SearchModifierCode (required)
 
 
value *
Σ
1..1stringLiteral value or resource path
 
channelType *
Σ
1..1CodingChannel type for notifications SubscriptionChannelType (extensible)
 
endpoint
Σ
0..1urlWhere the channel points to
 
parameter
0..*BackboneElementChannel type
 
 
name *
1..1stringName (key) of the parameter
 
 
value *
1..1stringValue of the parameter to use or pass through
 
heartbeatPeriod
Σ
0..1unsignedIntInterval in seconds to send 'heartbeat' notification
 
timeout
Σ
0..1unsignedIntTimeout in seconds to attempt notification delivery
 
contentType
Σ
0..1codeMIME type to send, or omit for no payload MimeType (required)
 
content
Σ
0..1codeempty | id-only | full-resource SubscriptionPayloadContent (required)
 
maxCount
Σ
0..1positiveIntMaximum number of events that can be combined in a single notification