Data Model Libraries
    Preparing search index...

    Class SubscriptionTopic

    SubscriptionTopic Class

    Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.

    FHIR Specification

    • Short: The definition of a specific topic for triggering events within the Subscriptions framework
    • Definition: Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic.
    • FHIR Version: 4.3.0

    FHIR SubscriptionTopic

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url identifier? version? title? derivedFrom? publicationStatusEnum status experimental? date? publisher? contact? description? useContext? jurisdiction? purpose? copyright? approvalDate? lastReviewDate? effectivePeriod? resourceTrigger? eventTrigger? canFilterBy? notificationShape?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getDerivedFromElement setDerivedFromElement addDerivedFromElement hasDerivedFromElement getDerivedFrom setDerivedFrom addDerivedFrom hasDerivedFrom getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getResourceTrigger setResourceTrigger addResourceTrigger hasResourceTrigger getEventTrigger setEventTrigger addEventTrigger hasEventTrigger getCanFilterBy setCanFilterBy addCanFilterBy hasCanFilterBy getNotificationShape setNotificationShape addNotificationShape hasNotificationShape fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initDerivedFrom initContact initUseContext initJurisdiction initResourceTrigger initEventTrigger initCanFilterBy initNotificationShape

    Constructors

    Properties

    url: null | UriType

    SubscriptionTopic.url Element

    FHIR Specification

    • Short: Canonical identifier for this subscription topic definition, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the subscription topic to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    SubscriptionTopic.identifier Element

    FHIR Specification

    • Short: Business Identifier for this subscription topic
    • Definition: Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
    • Comment: Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
    • Requirements: Allows identification of the subscription topic as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    SubscriptionTopic.version Element

    FHIR Specification

    • Short: Business version of the subscription topic
    • Definition: The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.
    • Comment: There may be multiple different instances of a subscription topic that have the same identifier but different versions.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    SubscriptionTopic.title Element

    FHIR Specification

    • Short: Name for this subscription topic (Human friendly)
    • Definition: A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    derivedFrom?: CanonicalType[]

    SubscriptionTopic.derivedFrom Element

    FHIR Specification

    • Short: Based on FHIR protocol or definition
    • Definition: The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.
    • Requirements: SubscriptionTopics may be refinements of more generic topics.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    SubscriptionTopic.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The current state of the SubscriptionTopic.
    • Comment: A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired SubscriptionTopic without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    SubscriptionTopic.experimental Element

    FHIR Specification

    • Short: If for testing purposes, not real usage
    • Definition: A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
    • Comment: Allows filtering of SubscriptionTopic that are appropriate for use vs. not.
    • Requirements: Enables experimental content to be developed following the same life-cycle as a production-level SubscriptionTopic would.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use an experimental SubscriptionTopic in production.
    • isSummary: true
    date?: DateTimeType

    SubscriptionTopic.date Element

    FHIR Specification

    • Short: Date status first applied
    • Definition: For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    SubscriptionTopic.publisher Element

    FHIR Specification

    • Short: The name of the individual or organization that published the SubscriptionTopic
    • Definition: Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
    • Requirements: Usually an organization, but may be an individual. The publisher (or steward) of the SubscriptionTopic is the organization or individual primarily responsible for the maintenance and upkeep of the Topic. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the Topic. This item SHOULD be populated unless the information is available from context.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    SubscriptionTopic.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: May be a web site, an email address, a telephone number, etc.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    SubscriptionTopic.description Element

    FHIR Specification

    • Short: Natural language description of the SubscriptionTopic
    • Definition: A free text natural language description of the Topic from the consumer's perspective.
    • Comment: This description can be used to capture details such as why the Topic was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    SubscriptionTopic.useContext Element

    FHIR Specification

    • Short: Content intends to support these contexts
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.
    • Comment: When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    SubscriptionTopic.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction of the SubscriptionTopic (if applicable)
    • Definition: A jurisdiction in which the Topic is intended to be used.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    SubscriptionTopic.purpose Element

    FHIR Specification

    • Short: Why this SubscriptionTopic is defined
    • Definition: Explains why this Topic is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the Topic. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Topic.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    SubscriptionTopic.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.
    • Requirements: Consumers of the TSubscriptionTopicopic must be able to determine any legal restrictions on the use of the artifact and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    SubscriptionTopic.approvalDate Element

    FHIR Specification

    • Short: When SubscriptionTopic is/was approved by publisher
    • Definition: The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The date may be more recent than the approval date because of minor changes / editorial corrections.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    SubscriptionTopic.lastReviewDate Element

    FHIR Specification

    • Short: Date the Subscription Topic was last reviewed by the publisher
    • Definition: The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
    • Comment: If specified, this is usually after the approval date.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    SubscriptionTopic.effectivePeriod Element

    FHIR Specification

    • Short: The effective date range for the SubscriptionTopic
    • Definition: The period during which the SubscriptionTopic content was or is planned to be effective.
    • Comment: The effective period for a SubscriptionTopic determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resourceTrigger?: SubscriptionTopicResourceTriggerComponent[]

    SubscriptionTopic.resourceTrigger Element

    FHIR Specification

    • Short: Definition of a resource-based trigger for the subscription topic
    • Definition: A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    eventTrigger?: SubscriptionTopicEventTriggerComponent[]

    SubscriptionTopic.eventTrigger Element

    FHIR Specification

    • Short: Event definitions the SubscriptionTopic
    • Definition: Event definition which can be used to trigger the SubscriptionTopic.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    canFilterBy?: SubscriptionTopicCanFilterByComponent[]

    SubscriptionTopic.canFilterBy Element

    FHIR Specification

    • Short: Properties by which a Subscription can filter notifications from the SubscriptionTopic
    • Definition: List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    notificationShape?: SubscriptionTopicNotificationShapeComponent[]

    SubscriptionTopic.notificationShape Element

    FHIR Specification

    • Short: Properties for describing the shape of notifications generated by this topic
    • Definition: List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided SubscriptionTopic JSON to instantiate the SubscriptionTopic data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionTopic

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SubscriptionTopic

      Returns undefined | SubscriptionTopic

      SubscriptionTopic data model or undefined for SubscriptionTopic

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetDerivedFromElementsetDerivedFromElementaddDerivedFromElementhasDerivedFromElementgetDerivedFromsetDerivedFromaddDerivedFromhasDerivedFromgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetApprovalDateElementsetApprovalDateElementhasApprovalDateElementgetApprovalDatesetApprovalDatehasApprovalDategetLastReviewDateElementsetLastReviewDateElementhasLastReviewDateElementgetLastReviewDatesetLastReviewDatehasLastReviewDategetEffectivePeriodsetEffectivePeriodhasEffectivePeriodgetResourceTriggersetResourceTriggeraddResourceTriggerhasResourceTriggergetEventTriggersetEventTriggeraddEventTriggerhasEventTriggergetCanFilterBysetCanFilterByaddCanFilterByhasCanFilterBygetNotificationShapesetNotificationShapeaddNotificationShapehasNotificationShapefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitDerivedFrominitContactinitUseContextinitJurisdictioninitResourceTriggerinitEventTriggerinitCanFilterByinitNotificationShape