This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Example OperationDefinition/Subscription-events (Turtle)
Raw Turtle (+ also see Turtle/RDF Format Specification)
Operation Definition
@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
# - resource -------------------------------------------------------------------
[] a fhir:OperationDefinition ;
fhir:id [ fhir:v "Subscription-events"] ;
fhir:text [
fhir:status [ fhir:v "extensions" ]
] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ;
fhir:value [ fhir:v "0" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "trial-use" ]
] ) ;
fhir:url [ fhir:v "http://hl7.org/fhir/OperationDefinition/Subscription-events"], [ fhir:v "http://hl7.org/fhir/OperationDefinition/Subscription-events"] ;
fhir:version [ fhir:v "5.0.0"], [ fhir:v "5.0.0"] ;
fhir:name [ fhir:v "Events"], [ fhir:v "Events"] ;
fhir:title [ fhir:v "Search and retrieve prior events for a Subscription"], [ fhir:v "Search and retrieve prior events for a Subscription"] ;
fhir:status [ fhir:v "draft"], [ fhir:v "draft"] ;
fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ;
fhir:date [ fhir:v "2023-03-26T15:21:02+11:00"], [ fhir:v "2023-03-26T15:21:02+11:00"] ;
fhir:publisher [ fhir:v "HL7 (FHIR Project)"], [ fhir:v "HL7 (FHIR Project)"] ;
fhir:contact ( [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "fhir@lists.hl7.org" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "fhir@lists.hl7.org" ]
] )
] ) ;
fhir:description [ fhir:v "This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription."], [ fhir:v "This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription."] ;
fhir:jurisdiction ( [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] ) ;
fhir:kind [ fhir:v "operation"] ;
fhir:affectsState [ fhir:v "false"] ;
fhir:code [ fhir:v "events"] ;
fhir:resource ( [ fhir:v "Subscription"] ) ;
fhir:system [ fhir:v "false"] ;
fhir:type [ fhir:v "false"] ;
fhir:instance [ fhir:v "true"] ;
fhir:parameter ( [
fhir:name [ fhir:v "eventsSinceNumber" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The starting event number, inclusive of this event (lower bound)." ] ;
fhir:type [ fhir:v "integer64" ]
] [
fhir:name [ fhir:v "eventsUntilNumber" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The ending event number, inclusive of this event (upper bound)." ] ;
fhir:type [ fhir:v "integer64" ]
] [
fhir:name [ fhir:v "content" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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." ] ;
fhir:type [ fhir:v "code" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/subscription-payload-content|5.0.0" ]
]
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The operation returns a valid notification bundle, with the first entry being a SubscriptionStatus resource. The bundle type is \"subscription-notification\"." ] ;
fhir:type [ fhir:v "Bundle" ]
] ) .
# -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the
examples are correct and useful, but they are not a normative part
of the specification.