Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Codesystem-subscription-status.xml

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Code SystemSubscriptionStatus

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="subscription-status"/> 
  <meta> 
    <lastUpdated value="2022-05-28T13:47:40.239+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      
      <h2> SubscriptionStatus</h2> 
      
      <div> 
        
        <p> The status of a subscription.</p> 
      
      </div> 
      
      <p> This code system http://hl7.org/fhir/subscription-status defines the following codes:</p> 
      
      <table class="codes">
        
        <tr> 
          
          <td style="white-space:nowrap">
            
            <b> Code</b> 
          
          </td> 
          
          <td> 
            
            <b> Display</b> 
          
          </td> 
          
          <td> 
            
            <b> Definition</b> 
          
          </td> 
        
        </tr> 
        
        <tr> 
          
          <td style="white-space:nowrap">requested
            
            <a name="subscription-status-requested"> </a> 
          
          </td> 
          
          <td> Requested</td> 
          
          <td> The client has requested the subscription, and the server has not yet set it up.</td> 
        
        </tr> 
        
        <tr> 
          
          <td style="white-space:nowrap">active
            
            <a name="subscription-status-active"> </a> 
          
          </td> 
          
          <td> Active</td> 
          
          <td> The subscription is active.</td> 
        
        </tr> 
        
        <tr> 
          
          <td style="white-space:nowrap">error
            
            <a name="subscription-status-error"> </a> 
          
          </td> 
          
          <td> Error</td> 
          
          <td> The server has an error executing the notification.</td> 
        
        </tr> 
        
        <tr> 
          
          <td style="white-space:nowrap">off
            
            <a name="subscription-status-off"> </a> 
          
          </td> 
          
          <td> Off</td> 
          
          <td> Too many errors have occurred or the subscription has expired.</td> 
        
        </tr> 
      
      </table> 
    
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3"/> 
  </extension> 
  <url value="http://hl7.org/fhir/subscription-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.503"/> 
  </identifier> 
  <version value="4.3.0"/> 
  <name value="SubscriptionStatus"/> 
  <title value="SubscriptionStatus"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2021-01-17T07:06:13+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="The status of a subscription."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/subscription-status"/> 
  <content value="complete"/> 
  <concept> 
    <code value="requested"/> 
    <display value="Requested"/> 
    <definition value="The client has requested the subscription, and the server has not yet set it up."/> 
  </concept> 
  <concept> 
    <code value="active"/> 
    <display value="Active"/> 
    <definition value="The subscription is active."/> 
  </concept> 
  <concept> 
    <code value="error"/> 
    <display value="Error"/> 
    <definition value="The server has an error executing the notification."/> 
  </concept> 
  <concept> 
    <code value="off"/> 
    <display value="Off"/> 
    <definition value="Too many errors have occurred or the subscription has expired."/> 
  </concept> 
</CodeSystem> 

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.