This page is part of the Subscriptions R5 Backport (v1.2.0-ballot: STU 1.2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v4.3.0. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
Page standards status: Trial-use | Maturity Level: 0 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "backport-subscription-status"] ; #
fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Subscription/$status</p><p>URL: [base]/Subscription/[id]/$status</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#id\">id</a></td><td/><td><div><p>At the Instance level, this parameter is ignored. At the Resource level, one or more parameters containing a FHIR id for a Subscription to get status information for. In the absence of any specified ids, the server returns the status for all Subscriptions available to the caller. Multiple values are joined via OR (e.g., "id1" OR "id2").</p>\n</div></td></tr><tr><td>IN</td><td>status</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#code\">code</a></td><td/><td><div><p>At the Instance level, this parameter is ignored. At the Resource level, a Subscription status to filter by (e.g., "active"). In the absence of any specified status values, the server does not filter contents based on the status. Multiple values are joined via OR (e.g., "error" OR "off").</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4B/bundle.html\">Bundle</a></td><td/><td><div><p>The operation returns a bundle containing one or more subscription status resources, one per Subscription being queried. The Bundle type is "searchset".</p>\n</div></td></tr></table></div>"
] ; #
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ;
fhir:value [ fhir:v "0"^^xsd:integer ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
fhir:value [ fhir:v "trial-use" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [ fhir:v "fhir" ]
] ) ; #
fhir:url [ fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"^^xsd:anyURI] ; #
fhir:version [ fhir:v "1.2.0-ballot"] ; #
fhir:name [ fhir:v "R5SubscriptionStatus"] ; #
fhir:title [ fhir:v "Subscription Status Operation"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:date [ fhir:v "2020-11-30"^^xsd:date] ; #
fhir:publisher [ fhir:v "HL7 International / FHIR Infrastructure"] ; #
fhir:contact ( [
fhir:name [ fhir:v "HL7 International / FHIR Infrastructure" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ] ] )
] [
fhir:name [ fhir:v "Gino Canessa" ] ;
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "mailto:gino.canessa@microsoft.com" ] ] )
] ) ; #
fhir:description [ fhir:v "This operation is used to return the current status information about one or more topic-based Subscriptions in R4."] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ] ] )
] ) ; #
fhir:affectsState [ fhir:v "false"^^xsd:boolean] ; #
fhir:code [ fhir:v "status"] ; #
fhir:resource ( [ fhir:v "Subscription"] ) ; #
fhir:system [ fhir:v "false"^^xsd:boolean] ; #
fhir:type [ fhir:v "true"^^xsd:boolean] ; #
fhir:instance [ fhir:v "true"^^xsd:boolean] ; #
fhir:parameter ( [
fhir:name [ fhir:v "id" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "At the Instance level, this parameter is ignored. At the Resource level, one or more parameters containing a FHIR id for a Subscription to get status information for. In the absence of any specified ids, the server returns the status for all Subscriptions available to the caller. Multiple values are joined via OR (e.g., \"id1\" OR \"id2\")." ] ;
fhir:type [ fhir:v "id" ]
] [
fhir:name [ fhir:v "status" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "At the Instance level, this parameter is ignored. At the Resource level, a Subscription status to filter by (e.g., \"active\"). In the absence of any specified status values, the server does not filter contents based on the status. Multiple values are joined via OR (e.g., \"error\" OR \"off\")." ] ;
fhir:type [ fhir:v "code" ]
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The operation returns a bundle containing one or more subscription status resources, one per Subscription being queried. The Bundle type is \"searchset\"." ] ;
fhir:type [ fhir:v "Bundle" ]
] ) . #
IG © 2020+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.subscriptions-backport#1.2.0-ballot based on FHIR 4.3.0. Generated 2023-12-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change