Subscription.profile.xml

StructureDefinition for subscription

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Subscription"/>
  <meta>
    <lastUpdated value="2015-03-27T00:13:00.999+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Subscription"/>
  <name value="Subscription"/>
  <publisher value="HL7 FHIR Project (FHIR Management Group)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for Subscription Resource"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="resource"/>
  <abstract value="true"/>
  <snapshot>
    <element>
      <path value="Subscription"/>
      <short value="A server push subscription criteria"/>
      <definition value="The subscription resource is used to define a push based subscription from a server to
       another system. Once a subscription is registered with the server, the server checks every
       resource that is created or updated, and if the resource matches the given criteria, it
       sends a message on the defined &quot;channel&quot; so that another system is able to take
       an appropriate action."/>
      <alias value="WebHook"/>
      <alias value="Hook"/>
      <alias value="Routing Rule"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Subscription"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="Subscription.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="The metadata about the resource. This is content that is maintained by the infrastructure.
       Changes to the content may not always be associated with version changes to the resource."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="Subscription.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content."/>
      <comments value="Asserting this rule set restricts the content to be only understood by a limited set of
       trading partners. This inherently limits the usefulness of the data in the long term.
       However the existing health eco-system is highly fractured, and not yet ready to define,
       collect, and exchange data in a generally computable sense. Wherever possible, implementers
       and/or specification writers should avoid using this element as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="Subscription.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="Language is provided to support indexing and accessibility (typically, services such as
       text to speech use the language tag). The html language tag in the narrative applies 
       to the narrative. The language tag on the resource may be used to specify the language
       of other presentations generated from the data in the resource  Not all the content has
       to be in the base language. The Resource.language should not be assumed to apply to the
       narrative automatically. If a language is specified, it should it also be specified on
       the div element in the html (see rules in HTML5 for information about the relationship
       between xml:lang and the html lang attribute)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <strength value="required"/>
        <description value="A human language"/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="Subscription.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition value="A human-readable narrative that contains a summary of the resource, and may be used to
       represent the content of the resource to a human. The narrative need not encode all the
       structured data, but is required to contain sufficient detail to make it &quot;clinically
       safe&quot; for a human to just read the narrative. Resource definitions may define what
       content should be represented in the narrative to ensure clinical safety."/>
      <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
       a narrative."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.contained"/>
      <short value="Contained, inline Resources"/>
      <definition value="These resources do not have an independent existence apart from the resource that contains
       them - they cannot be identified independently, and nor can they have their own independent
       transaction scope."/>
      <comments value="This should never be done when the content can be identified properly, as once identification
       is lost, it is extremely difficult (and context dependent) to restore it again."/>
      <alias value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the resource. In order to make the use of extensions safe and manageable, there is
       a strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the resource, and that modifies the understanding of the element that contains it.
       Usually modifier elements provide negation or qualification. In order to make the use
       of extensions safe and manageable, there is a strict set of governance applied to the
       definition and use of extensions. Though any implementer is allowed to define an extension,
       there is a set of requirements that SHALL be met as part of the definition of the extension.
       Applications processing a resource are required to check for modifier extensions."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.criteria"/>
      <short value="Rule for server push criteria"/>
      <definition value="The rules that the server should use to determine when to generate notifications for this
       subscription."/>
      <comments value="The rules are a search criteria (without the [base] part."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.contact"/>
      <short value="Contact details for source (e.g. troubleshooting)"/>
      <definition value="Contact details for a human to contact about the subscription. The primary use of this
       for system administrator troubleshooting."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ContactPoint"/>
      </type>
    </element>
    <element>
      <path value="Subscription.reason"/>
      <short value="Description of why this subscription was created"/>
      <definition value="A description of why this subscription is defined."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.status"/>
      <short value="requested | active | error | off"/>
      <definition value="The status of the subscription, which marks the server state for managing the subscription."/>
      <comments value="A client can only submit subscription resources in the requested or off state. Only the
       server can  move a subscription from requested to active, and then to error. Either the
       server or the client can turn a subscription off."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="SubscriptionStatus"/>
        <strength value="required"/>
        <description value="The status of a subscription"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/subscription-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Subscription.error"/>
      <short value="Latest error note"/>
      <definition value="A record of the last error that occurred when the server processed a notification."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.channel"/>
      <short value="The channel on which to report matches to the criteria"/>
      <definition value="Details where to send notifications when resources are received that meet the criteria."/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element>
      <path value="Subscription.channel.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.channel.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.channel.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, and that modifies the understanding of the element that contains it. Usually
       modifier elements provide negation or qualification. In order to make the use of extensions
       safe and manageable, there is a strict set of governance applied to the definition and
       use of extensions. Though any implementer is allowed to define an extension, there is
       a set of requirements that SHALL be met as part of the definition of the extension. Applications
       processing a resource are required to check for modifier extensions."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.channel.type"/>
      <short value="rest-hook | websocket | email | sms | message"/>
      <definition value="The type of channel to send notififcations on."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="SubscriptionChannelType"/>
        <strength value="required"/>
        <description value="The type of method used to execute a subscription"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/subscription-channel-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Subscription.channel.endpoint"/>
      <short value="Where the channel points to"/>
      <definition value="The uri that describes tha actual end point to send messages to."/>
      <comments value="For rest-hook, and websocket, the end point must be an http: or https URL; for email,
       a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of
       url the server understands (usually, http: or mllp:). The URI is allowed to be relative;
       in which case, it is relative to the server end-point (since their may be more than one,
       clients should avoid using relative URIs)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Subscription.channel.payload"/>
      <short value="Mimetype to send, or blank for no payload"/>
      <definition value="The mime type to send the payload in - either application/xml+fhir, or application/json+fhir.
       If the mime type is blank, then there is no payload in the notification, just a notification."/>
      <comments value="Sending the payload has obvious security consequences. The server is responsible for ensuring
       that the content is appropriately secured."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.channel.header"/>
      <short value="Usage depends on the channel type"/>
      <definition value="Additional headers / information to send as part of the notification."/>
      <comments value="Exactly what these mean depend on the channel type. The can convey additional information
       to the recipient and/or meet security requirements."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.end"/>
      <short value="When to automatically delete the subscription"/>
      <definition value="The time for the server to turn the subscription off."/>
      <comments value="The server is permitted to deviate from this time, but should observe it."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="Subscription.tag"/>
      <short value="A tag to add to matching resources"/>
      <definition value="A tag to add to any resource that matches the criteria, after the subscription is processed."/>
      <comments value="So that other systems can tell which resources have been the subject of a notification."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Coding"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Subscription"/>
      <short value="A server push subscription criteria"/>
      <definition value="The subscription resource is used to define a push based subscription from a server to
       another system. Once a subscription is registered with the server, the server checks every
       resource that is created or updated, and if the resource matches the given criteria, it
       sends a message on the defined &quot;channel&quot; so that another system is able to take
       an appropriate action."/>
      <alias value="WebHook"/>
      <alias value="Hook"/>
      <alias value="Routing Rule"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="DomainResource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Subscription.criteria"/>
      <short value="Rule for server push criteria"/>
      <definition value="The rules that the server should use to determine when to generate notifications for this
       subscription."/>
      <comments value="The rules are a search criteria (without the [base] part."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.contact"/>
      <short value="Contact details for source (e.g. troubleshooting)"/>
      <definition value="Contact details for a human to contact about the subscription. The primary use of this
       for system administrator troubleshooting."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ContactPoint"/>
      </type>
    </element>
    <element>
      <path value="Subscription.reason"/>
      <short value="Description of why this subscription was created"/>
      <definition value="A description of why this subscription is defined."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.status"/>
      <short value="requested | active | error | off"/>
      <definition value="The status of the subscription, which marks the server state for managing the subscription."/>
      <comments value="A client can only submit subscription resources in the requested or off state. Only the
       server can  move a subscription from requested to active, and then to error. Either the
       server or the client can turn a subscription off."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="SubscriptionStatus"/>
        <strength value="required"/>
        <description value="The status of a subscription"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/subscription-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Subscription.error"/>
      <short value="Latest error note"/>
      <definition value="A record of the last error that occurred when the server processed a notification."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.channel"/>
      <short value="The channel on which to report matches to the criteria"/>
      <definition value="Details where to send notifications when resources are received that meet the criteria."/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element>
      <path value="Subscription.channel.type"/>
      <short value="rest-hook | websocket | email | sms | message"/>
      <definition value="The type of channel to send notififcations on."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="SubscriptionChannelType"/>
        <strength value="required"/>
        <description value="The type of method used to execute a subscription"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/subscription-channel-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Subscription.channel.endpoint"/>
      <short value="Where the channel points to"/>
      <definition value="The uri that describes tha actual end point to send messages to."/>
      <comments value="For rest-hook, and websocket, the end point must be an http: or https URL; for email,
       a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of
       url the server understands (usually, http: or mllp:). The URI is allowed to be relative;
       in which case, it is relative to the server end-point (since their may be more than one,
       clients should avoid using relative URIs)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Subscription.channel.payload"/>
      <short value="Mimetype to send, or blank for no payload"/>
      <definition value="The mime type to send the payload in - either application/xml+fhir, or application/json+fhir.
       If the mime type is blank, then there is no payload in the notification, just a notification."/>
      <comments value="Sending the payload has obvious security consequences. The server is responsible for ensuring
       that the content is appropriately secured."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.channel.header"/>
      <short value="Usage depends on the channel type"/>
      <definition value="Additional headers / information to send as part of the notification."/>
      <comments value="Exactly what these mean depend on the channel type. The can convey additional information
       to the recipient and/or meet security requirements."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Subscription.end"/>
      <short value="When to automatically delete the subscription"/>
      <definition value="The time for the server to turn the subscription off."/>
      <comments value="The server is permitted to deviate from this time, but should observe it."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="Subscription.tag"/>
      <short value="A tag to add to matching resources"/>
      <definition value="A tag to add to any resource that matches the criteria, after the subscription is processed."/>
      <comments value="So that other systems can tell which resources have been the subject of a notification."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Coding"/>
      </type>
    </element>
  </differential>
</StructureDefinition>