FHIR IG analytics| Package | hl7.fhir.uv.subscriptions-backport.r4b |
| Resource Type | OperationDefinition |
| Id | OperationDefinition-backport-subscription-events.json |
| FHIR Version | R4B |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
URL: [base]/Subscription/[id]/$events
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | eventsSinceNumber | 0..1 | string | The starting event number, inclusive of this event (lower bound). | ||
| IN | eventsUntilNumber | 0..1 | string | The ending event number, inclusive of this event (upper bound). | ||
| IN | content | 0..1 | code | Requested content style of returned data. Codes from backport-content-value-set (e.g., empty, id-only, full-resource). This is a hint to the server what a client would prefer, and MAY be ignored. | ||
| OUT | return | 1..1 | Bundle | The operation returns a valid notification bundle, with the first entry being the subscription status information resource. The bundle type is "history". |
{
"resourceType": "OperationDefinition",
"id": "backport-subscription-events",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events",
"version": "1.2.0-ballot",
"name": "R5SubscriptionEvents",
"title": "Subscription Events Operation",
"status": "active",
"kind": "operation",
"date": "2020-11-30",
"publisher": "HL7 International / FHIR Infrastructure",
"contact": [
{
"name": "HL7 International / FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
},
{
"name": "Gino Canessa",
"telecom": [
{
"system": "email",
"value": "mailto:gino.canessa@microsoft.com"
}
]
}
],
"description": "This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription in R4.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"affectsState": false,
"code": "events",
"resource": [
"Subscription"
],
"system": false,
"type": false,
"instance": true,
"parameter": [
{
"name": "eventsSinceNumber",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The starting event number, inclusive of this event (lower bound).",
"type": "string"
},
{
"name": "eventsUntilNumber",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The ending event number, inclusive of this event (upper bound).",
"type": "string"
},
{
"name": "content",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Requested content style of returned data. Codes from backport-content-value-set (e.g., empty, id-only, full-resource). This is a hint to the server what a client would prefer, and MAY be ignored.",
"type": "code"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The operation returns a valid notification bundle, with the first entry being the subscription status information resource. The bundle type is \"history\".",
"type": "Bundle"
}
]
}