Subscription

Profile Subscription describes custom rules how to create a valid Subscription resource to be able to subscribe to receive notifications about created/updated resources from Roche

Canonical url - http://roche.com/fhir/iop/StructureDefinition/Subscription

It is mandatory to include this and only this profile url in the meta.profile section of the Subscription JSON (see the examples).

The below overview shows the elements of the resource, data type and the cardinality of each. Further details like "Binding"/"Fixed values"/"Contraints" etc can be found on clicking on each element.

Structure definition :

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textI0..1Narrative
containedI0..*Resource
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifierΣ I0..*Identifier
nameΣ0..1string
statusΣ ?!1..1codeBinding
topicΣ1..1canonical(SubscriptionTopic)
contactΣ I0..0ContactPoint
endΣ0..0instant
managingEntityΣ I0..0Reference(CareTeam | HealthcareService | Organization | RelatedPerson | Patient | Practitioner | PractitionerRole)
reasonΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
resourceTypeΣ0..1uriBinding
filterParameterΣ1..1stringBinding
comparatorI0..1codeBinding
modifierI0..1codeBinding
valueΣ1..1string
id0..1string
extensionI0..*Extension
systemΣ0..0uri
versionΣ0..0string
codeΣ I0..1codeFixed Value
displayΣ I0..0string
userSelectedΣ0..0boolean
endpointΣ1..1url
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
name1..1string
value1..1string
heartbeatPeriodΣ0..0unsignedInt
timeoutΣ0..1unsignedInt
contentTypeΣ1..1codeBinding
contentΣ1..1codeBindingFixed Value
maxCountΣ0..1positiveInt

Attribute description :

Attribute Description Terminology reference
identifier System/value pairs identifying the subscription. Not used by the server. Stored for the convenience of the subscriber.
name Name of the subscription
status Status of the subscription. For subscription creation, only the value requested is allowed. For subscription update, the allowed values are: active, requested, off. When fetching a subscription, server might also return subscription with status error. status
topic Canonical URL of the subscription topic. The subscription topic determines the resources about which the subscriber will be notified.
filterBy Enables to filter
channelType Only rest-hook is supported by the server.
endpoint URL to which the notifications will be sent by the server. Must start with https://
parameter Collection of name/value pairs to be added as the headers to the notification.
timeout The maximum amount of time (in seconds) a server will allow before failing a notification attempt. Default value is 10 seconds. Allowed values are integers between 10 and 20.
contentType application/json or application/fhir+json
content Only id-only is supported by the server.
maxCount Maximum amount of resources that can be bundled together in a single notification. Default is 100, the client can only increase this number.