Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: subscription-event-count

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/subscription-event-count

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

A record of the number of events for which the server has attempted delivery on this subscription (i.e., the number of events that occurred while the subscription is in an "active" or "error" state -- not "requested" or "off"). Server Initializes to 0 for a new subscription. Repeated attempts at delivery of the same event notification do not increment this counter. Valid values are unsigned integers (0+). The decmial type is used to ensure that counts can grow larger than 32-bit values.

Context of Use: Use on Element ID Bundle.meta

Summary

Name	Flags	Card.	Type	Description & Constraints
subscription-event-count		0..1	unsignedInt	URL = http://hl7.org/fhir/StructureDefinition/subscription-event-count subscription-event-count: A record of the number of events for which the server has attempted delivery on this subscription (i.e., the number of events that occurred while the subscription is in an "active" or "error" state -- not "requested" or "off"). Server Initializes to 0 for a new subscription. Repeated attempts at delivery of the same event notification do not increment this counter. Valid values are unsigned integers (0+). The decmial type is used to ensure that counts can grow larger than 32-bit values. Use on Element ID Bundle.meta
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/subscription-event-count subscription-event-count: A record of the number of events for which the server has attempted delivery on this subscription (i.e., the number of events that occurred while the subscription is in an "active" or "error" state -- not "requested" or "off"). Server Initializes to 0 for a new subscription. Repeated attempts at delivery of the same event notification do not increment this counter. Valid values are unsigned integers (0+). The decmial type is used to ensure that counts can grow larger than 32-bit values. Use on Element ID Bundle.meta
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/subscription-event-count"
value[x]	I	1..1	unsignedInt	Value of extension
Documentation for this format

XML Template

<!-- subscription-event-count -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/subscription-event-count" >
  <!-- from Element: extension -->
 <valueUnsignedInt value="[unsignedInt]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // subscription-event-count
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/subscription-event-count", // R! 
    "valueUnsignedInt" : "<unsignedInt>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
subscription-event-count		0..1	unsignedInt	URL = http://hl7.org/fhir/StructureDefinition/subscription-event-count subscription-event-count: A record of the number of events for which the server has attempted delivery on this subscription (i.e., the number of events that occurred while the subscription is in an "active" or "error" state -- not "requested" or "off"). Server Initializes to 0 for a new subscription. Repeated attempts at delivery of the same event notification do not increment this counter. Valid values are unsigned integers (0+). The decmial type is used to ensure that counts can grow larger than 32-bit values. Use on Element ID Bundle.meta
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/subscription-event-count subscription-event-count: A record of the number of events for which the server has attempted delivery on this subscription (i.e., the number of events that occurred while the subscription is in an "active" or "error" state -- not "requested" or "off"). Server Initializes to 0 for a new subscription. Repeated attempts at delivery of the same event notification do not increment this counter. Valid values are unsigned integers (0+). The decmial type is used to ensure that counts can grow larger than 32-bit values. Use on Element ID Bundle.meta
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/subscription-event-count"
value[x]	I	1..1	unsignedInt	Value of extension
Documentation for this format

XML Template

<!-- subscription-event-count -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/subscription-event-count" >
  <!-- from Element: extension -->
 <valueUnsignedInt value="[unsignedInt]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // subscription-event-count
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/subscription-event-count", // R! 
    "valueUnsignedInt" : "<unsignedInt>" // C? R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)