{ "description": "Mock of subscription event API. This is based on [FHIR R5 SubscriptionStatus](https://build.fhir.org/subscriptionstatus.html)", "_filename": "OperationDefinition-subcriptionEvent.json", "package_name": "uk.nhsdigital.r4", "date": "2022-01-07T14:00:00+00:00", "meta": { "lastUpdated": "2022-01-07T14:00:00+00:00" }, "system": true, "publisher": "NHS Digital", "instance": false, "name": "subscriptionEvent", "type": "false", "experimental": null, "resourceType": "OperationDefinition", "title": null, "package_version": "2.4.5", "status": "draft", "id": "f7bf2956-b9e4-4604-a817-a07365d1ef00", "affectsState": true, "kind": "operation", "comment": "Mock of subscription event API", "url": "https://fhir.nhs.uk/OperationDefinition/subscription-event", "code": "subscriptionEvent", "version": "4.0.1", "contact": [ { "telecom": [ { "value": "interoperabilityteam@nhs.net", "system": "email" } ] } ], "parameter": [ { "max": "1", "min": 0, "use": "in", "name": "identifier", "type": "Identifier", "documentation": "Event identifier / Message Id (possibly a http header)" }, { "max": "1", "min": 0, "use": "in", "name": "type", "type": "Coding", "documentation": "handshake | heartbeat | event-notification | query-status" }, { "max": "*", "min": 1, "use": "in", "name": "notificationEvent", "part": [ { "max": "1", "min": 1, "use": "in", "name": "timestamp", "type": "dateTime", "documentation": "When {{title}} was first captured in the subject's record" }, { "max": "1", "min": 1, "use": "in", "name": "focus", "type": "Reference", "documentation": "The event reference" }, { "max": "1", "min": 0, "use": "in", "name": "focusResource", "type": "Resource", "documentation": "The event resource. Mandatory for subscription event submission" } ], "documentation": "The event reference" }, { "max": "1", "min": 0, "use": "in", "name": "topic", "type": "canonical", "documentation": "Reference to the SubscriptionTopic this notification relates to (topics are related to event triggers in other HL7 standards) " }, { "max": "1", "min": 1, "use": "out", "name": "return", "type": "OperationOutcome", "documentation": "response to the event POST" } ] }