Data Model Libraries
    Preparing search index...

    Class SubscriptionTopicNotificationShapeComponent

    SubscriptionTopicNotificationShapeComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    resource: null | UriType

    SubscriptionTopic.notificationShape.resource Element

    FHIR Specification

    • Short: URL of the Resource that is the focus (main) resource in a notification shape
    • Definition: URL of the Resource that is the type used in this shape. This is the 'focus' resource of the topic (or one of them if there are more than one) and the root resource for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.
    • Comment: URL of the Resource that is the type used in this shape. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, 'Patient' maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.
    • FHIR Type: uri
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    include?: StringType[]

    SubscriptionTopic.notificationShape.include Element

    FHIR Specification

    • Short: Include directives, rooted in the resource for this shape
    • Definition: Search-style _include directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    revInclude?: StringType[]

    SubscriptionTopic.notificationShape.revInclude Element

    FHIR Specification

    • Short: Reverse include directives, rooted in the resource for this shape
    • Definition: Search-style _revinclude directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionTopicNotificationShapeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubscriptionTopicNotificationShapeComponent

      SubscriptionTopicNotificationShapeComponent data model or undefined for SubscriptionTopicNotificationShapeComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

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