Class Topic

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class Topic
    extends DomainResource
    Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
    See Also:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        An absolute URL that is used to identify this Topic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).
      • identifier

        protected List<Identifier> identifier
        Business identifiers assigned to this Topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
      • version

        protected StringType version
        The identifier that is used to identify this version of the 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.
      • title

        protected StringType title
        A short, descriptive, user-friendly title for the Topic, for example, "admission".
      • derivedFromCanonical

        protected List<CanonicalType> derivedFromCanonical
        The canonical URL pointing to another FHIR-defined Topic that is adhered to in whole or in part by this Topic.
      • derivedFromUri

        protected List<UriType> derivedFromUri
        The URL pointing to an externally-defined subscription topic or other definition that is adhered to in whole or in part by this definition.
      • experimental

        protected BooleanType experimental
        A flag to indicate that this Topic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • date

        protected DateTimeType date
        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.
      • publisher

        protected Reference publisher
        Helps establish the "authority/credibility" of the Topic. May also allow for contact.
      • contact

        protected List<ContactDetail> contact
        Contact details to assist a user in finding and communicating with the publisher.
      • description

        protected MarkdownType description
        A free text natural language description of the Topic from the consumer's perspective.
      • useContext

        protected List<UsageContext> useContext
        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.
      • purpose

        protected MarkdownType purpose
        Explains why this Topic is needed and why it has been designed as it has.
      • copyright

        protected MarkdownType copyright
        A copyright statement relating to the Topic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Topic.
      • approvalDate

        protected DateType approvalDate
        The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      • lastReviewDate

        protected DateType lastReviewDate
        The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
      • effectivePeriod

        protected Period effectivePeriod
        The period during which the Topic content was or is planned to be effective.
      • resourceTrigger

        protected Topic.TopicResourceTriggerComponent resourceTrigger
        The criteria for including updates to a nominated resource in the topic. Thie criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression.
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: Date status first applied
        Type: date
        Path: Topic.date

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: Business Identifier for Topic
        Type: token
        Path: Topic.identifier

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: The name of the individual or organization that published the Topic
        Type: reference
        Path: Topic.publisher

        See Also:
        Constant Field Values
      • PUBLISHER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PUBLISHER
        Fluent Client search parameter constant for publisher

        Description: The name of the individual or organization that published the Topic
        Type: reference
        Path: Topic.publisher

      • INCLUDE_PUBLISHER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PUBLISHER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Topic:publisher".
      • SP_RESOURCE_TYPE

        public static final String SP_RESOURCE_TYPE
        Search parameter: resource-type

        Description: Candidate types for this topic
        Type: token
        Path: Topic.resourceTrigger.resourceType

        See Also:
        Constant Field Values
      • RESOURCE_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam RESOURCE_TYPE
        Fluent Client search parameter constant for resource-type

        Description: Candidate types for this topic
        Type: token
        Path: Topic.resourceTrigger.resourceType

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: draft | active | retired | unknown
        Type: token
        Path: Topic.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: draft | active | retired | unknown
        Type: token
        Path: Topic.status

      • SP_TITLE

        public static final String SP_TITLE
        Search parameter: title

        Description: Name for this Topic (Human friendly)
        Type: string
        Path: Topic.title

        See Also:
        Constant Field Values
      • TITLE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
        Fluent Client search parameter constant for title

        Description: Name for this Topic (Human friendly)
        Type: string
        Path: Topic.title

      • SP_TRIGGER_DESCRIPTION

        public static final String SP_TRIGGER_DESCRIPTION
        Search parameter: trigger-description

        Description: Text representation of the trigger
        Type: string
        Path: Topic.resourceTrigger.description

        See Also:
        Constant Field Values
      • TRIGGER_DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam TRIGGER_DESCRIPTION
        Fluent Client search parameter constant for trigger-description

        Description: Text representation of the trigger
        Type: string
        Path: Topic.resourceTrigger.description

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: Logical canonical URL to reference this Topic (globally unique)
        Type: uri
        Path: Topic.url

        See Also:
        Constant Field Values
      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: Logical canonical URL to reference this Topic (globally unique)
        Type: uri
        Path: Topic.url

      • VERSION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
        Fluent Client search parameter constant for version

        Description: Business version of the Topic
        Type: token
        Path: Topic.version

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (An absolute URL that is used to identify this Topic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • hasUrl

        public boolean hasUrl()
      • setUrlElement

        public Topic setUrlElement​(UriType value)
        Parameters:
        value - url (An absolute URL that is used to identify this Topic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • getUrl

        public String getUrl()
        Returns:
        An absolute URL that is used to identify this Topic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).
      • setUrl

        public Topic setUrl​(String value)
        Parameters:
        value - An absolute URL that is used to identify this Topic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).
      • getIdentifier

        public List<Identifier> getIdentifier()
        Returns:
        identifier (Business identifiers assigned to this Topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.)
      • getVersionElement

        public StringType getVersionElement()
        Returns:
        version (The identifier that is used to identify this version of the 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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • setVersionElement

        public Topic setVersionElement​(StringType value)
        Parameters:
        value - version (The identifier that is used to identify this version of the 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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • getVersion

        public String getVersion()
        Returns:
        The identifier that is used to identify this version of the 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.
      • setVersion

        public Topic setVersion​(String value)
        Parameters:
        value - The identifier that is used to identify this version of the 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.
      • getTitleElement

        public StringType getTitleElement()
        Returns:
        title (A short, descriptive, user-friendly title for the Topic, for example, "admission".). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
      • setTitleElement

        public Topic setTitleElement​(StringType value)
        Parameters:
        value - title (A short, descriptive, user-friendly title for the Topic, for example, "admission".). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
      • getTitle

        public String getTitle()
        Returns:
        A short, descriptive, user-friendly title for the Topic, for example, "admission".
      • setTitle

        public Topic setTitle​(String value)
        Parameters:
        value - A short, descriptive, user-friendly title for the Topic, for example, "admission".
      • getDerivedFromUri

        public List<UriType> getDerivedFromUri()
        Returns:
        derivedFromUri (The URL pointing to an externally-defined subscription topic or other definition that is adhered to in whole or in part by this definition.)
      • addDerivedFromUriElement

        public UriType addDerivedFromUriElement()
        Returns:
        derivedFromUri (The URL pointing to an externally-defined subscription topic or other definition that is adhered to in whole or in part by this definition.)
      • addDerivedFromUri

        public Topic addDerivedFromUri​(String value)
        Parameters:
        value - derivedFromUri (The URL pointing to an externally-defined subscription topic or other definition that is adhered to in whole or in part by this definition.)
      • hasDerivedFromUri

        public boolean hasDerivedFromUri​(String value)
        Parameters:
        value - derivedFromUri (The URL pointing to an externally-defined subscription topic or other definition that is adhered to in whole or in part by this definition.)
      • getExperimentalElement

        public BooleanType getExperimentalElement()
        Returns:
        experimental (A flag to indicate that this Topic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
      • setExperimentalElement

        public Topic setExperimentalElement​(BooleanType value)
        Parameters:
        value - experimental (A flag to indicate that this Topic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
      • getExperimental

        public boolean getExperimental()
        Returns:
        A flag to indicate that this Topic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • setExperimental

        public Topic setExperimental​(boolean value)
        Parameters:
        value - A flag to indicate that this Topic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • hasDate

        public boolean hasDate()
      • setDateElement

        public Topic setDateElement​(DateTimeType value)
        Parameters:
        value - date (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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • getDate

        public Date getDate()
        Returns:
        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.
      • setDate

        public Topic setDate​(Date value)
        Parameters:
        value - 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.
      • getPublisher

        public Reference getPublisher()
        Returns:
        publisher (Helps establish the "authority/credibility" of the Topic. May also allow for contact.)
      • setPublisher

        public Topic setPublisher​(Reference value)
        Parameters:
        value - publisher (Helps establish the "authority/credibility" of the Topic. May also allow for contact.)
      • getDescriptionElement

        public MarkdownType getDescriptionElement()
        Returns:
        description (A free text natural language description of the Topic from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • setDescriptionElement

        public Topic setDescriptionElement​(MarkdownType value)
        Parameters:
        value - description (A free text natural language description of the Topic from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • getDescription

        public String getDescription()
        Returns:
        A free text natural language description of the Topic from the consumer's perspective.
      • setDescription

        public Topic setDescription​(String value)
        Parameters:
        value - A free text natural language description of the Topic from the consumer's perspective.
      • getUseContext

        public List<UsageContext> getUseContext()
        Returns:
        useContext (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.)
      • getPurposeElement

        public MarkdownType getPurposeElement()
        Returns:
        purpose (Explains why this Topic is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
      • setPurposeElement

        public Topic setPurposeElement​(MarkdownType value)
        Parameters:
        value - purpose (Explains why this Topic is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
      • getPurpose

        public String getPurpose()
        Returns:
        Explains why this Topic is needed and why it has been designed as it has.
      • setPurpose

        public Topic setPurpose​(String value)
        Parameters:
        value - Explains why this Topic is needed and why it has been designed as it has.
      • getCopyrightElement

        public MarkdownType getCopyrightElement()
        Returns:
        copyright (A copyright statement relating to the Topic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Topic.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
      • setCopyrightElement

        public Topic setCopyrightElement​(MarkdownType value)
        Parameters:
        value - copyright (A copyright statement relating to the Topic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Topic.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
      • getCopyright

        public String getCopyright()
        Returns:
        A copyright statement relating to the Topic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Topic.
      • setCopyright

        public Topic setCopyright​(String value)
        Parameters:
        value - A copyright statement relating to the Topic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Topic.
      • getApprovalDateElement

        public DateType getApprovalDateElement()
        Returns:
        approvalDate (The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
      • setApprovalDateElement

        public Topic setApprovalDateElement​(DateType value)
        Parameters:
        value - approvalDate (The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
      • getApprovalDate

        public Date getApprovalDate()
        Returns:
        The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      • setApprovalDate

        public Topic setApprovalDate​(Date value)
        Parameters:
        value - The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      • getLastReviewDateElement

        public DateType getLastReviewDateElement()
        Returns:
        lastReviewDate (The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
      • setLastReviewDateElement

        public Topic setLastReviewDateElement​(DateType value)
        Parameters:
        value - lastReviewDate (The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
      • getLastReviewDate

        public Date getLastReviewDate()
        Returns:
        The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
      • setLastReviewDate

        public Topic setLastReviewDate​(Date value)
        Parameters:
        value - The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource