Package org.hl7.fhir.r5.model

Class CanonicalResource

    • Method Detail

      • getUrlMax

        public int getUrlMax()
        How many allowed for this property by the implementation

      • getUrlElement

        public abstract UriType getUrlElement()
        Returns:
        #url (An absolute URI that is used to identify this canonical resource 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 canonical resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the canonical resource is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

      • hasUrl

        public abstract boolean hasUrl()

      • setUrlElement

        public abstract CanonicalResource setUrlElement​(UriType value)
        Parameters:
        value - #url (An absolute URI that is used to identify this canonical resource 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 canonical resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the canonical resource is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

      • getUrl

        public abstract String getUrl()
        Returns:
        An absolute URI that is used to identify this canonical resource 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 canonical resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the canonical resource is stored on different servers.

      • setUrl

        public abstract CanonicalResource setUrl​(String value)
        Parameters:
        value - An absolute URI that is used to identify this canonical resource 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 canonical resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the canonical resource is stored on different servers.

      • getIdentifierMax

        public int getIdentifierMax()
        How many allowed for this property by the implementation

      • getIdentifier

        public abstract List<Identifier> getIdentifier()
        Returns:
        #identifier (A formal identifier that is used to identify this canonical resource when it is represented in other formats, or referenced in a specification, model, design or an instance.)

      • getIdentifierFirstRep

        public abstract Identifier getIdentifierFirstRep()
        Returns:
        The first repetition of repeating field #identifier, creating it if it does not already exist {1}

      • getVersionMax

        public int getVersionMax()
        How many allowed for this property by the implementation

      • getVersionElement

        public abstract StringType getVersionElement()
        Returns:
        #version (The identifier that is used to identify this version of the canonical resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the canonical resource 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 can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

      • hasVersion

        public abstract boolean hasVersion()

      • setVersionElement

        public abstract CanonicalResource setVersionElement​(StringType value)
        Parameters:
        value - #version (The identifier that is used to identify this version of the canonical resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the canonical resource 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 can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

      • getVersion

        public abstract String getVersion()
        Returns:
        The identifier that is used to identify this version of the canonical resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the canonical resource 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 can be placed in a lexicographical sequence.

      • setVersion

        public abstract CanonicalResource setVersion​(String value)
        Parameters:
        value - The identifier that is used to identify this version of the canonical resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the canonical resource 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 can be placed in a lexicographical sequence.

      • getNameMax

        public int getNameMax()
        How many allowed for this property by the implementation

      • getNameElement

        public abstract StringType getNameElement()
        Returns:
        #name (A natural language name identifying the canonical resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • hasName

        public abstract boolean hasName()

      • setNameElement

        public abstract CanonicalResource setNameElement​(StringType value)
        Parameters:
        value - #name (A natural language name identifying the canonical resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • getName

        public abstract String getName()
        Returns:
        A natural language name identifying the canonical resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.

      • setName

        public abstract CanonicalResource setName​(String value)
        Parameters:
        value - A natural language name identifying the canonical resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.

      • getTitleMax

        public int getTitleMax()
        How many allowed for this property by the implementation

      • getTitleElement

        public abstract StringType getTitleElement()
        Returns:
        #title (A short, descriptive, user-friendly title for the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

      • hasTitle

        public abstract boolean hasTitle()

      • setTitleElement

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

      • getTitle

        public abstract String getTitle()
        Returns:
        A short, descriptive, user-friendly title for the canonical resource.

      • setTitle

        public abstract CanonicalResource setTitle​(String value)
        Parameters:
        value - A short, descriptive, user-friendly title for the canonical resource.

      • getStatusMax

        public int getStatusMax()
        How many allowed for this property by the implementation

      • getStatusElement

        public abstract Enumeration<Enumerations.PublicationStatus> getStatusElement()
        Returns:
        #status (The status of this canonical resource. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • hasStatus

        public abstract boolean hasStatus()

      • getExperimentalMax

        public int getExperimentalMax()
        How many allowed for this property by the implementation

      • getExperimentalElement

        public abstract BooleanType getExperimentalElement()
        Returns:
        #experimental (A Boolean value to indicate that this canonical resource 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 abstract CanonicalResource setExperimentalElement​(BooleanType value)
        Parameters:
        value - #experimental (A Boolean value to indicate that this canonical resource 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 abstract boolean getExperimental()
        Returns:
        A Boolean value to indicate that this canonical resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

      • setExperimental

        public abstract CanonicalResource setExperimental​(boolean value)
        Parameters:
        value - A Boolean value to indicate that this canonical resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

      • getDateMax

        public int getDateMax()
        How many allowed for this property by the implementation

      • getDateElement

        public abstract DateTimeType getDateElement()
        Returns:
        #date (The date (and optionally time) when the canonical resource was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the canonical resource changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

      • hasDate

        public abstract boolean hasDate()

      • setDateElement

        public abstract CanonicalResource setDateElement​(DateTimeType value)
        Parameters:
        value - #date (The date (and optionally time) when the canonical resource was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the canonical resource changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

      • getDate

        public abstract Date getDate()
        Returns:
        The date (and optionally time) when the canonical resource was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the canonical resource changes.

      • setDate

        public abstract CanonicalResource setDate​(Date value)
        Parameters:
        value - The date (and optionally time) when the canonical resource was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the canonical resource changes.

      • getPublisherMax

        public int getPublisherMax()
        How many allowed for this property by the implementation

      • getPublisherElement

        public abstract StringType getPublisherElement()
        Returns:
        #publisher (The name of the organization or individual that published the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

      • setPublisherElement

        public abstract CanonicalResource setPublisherElement​(StringType value)
        Parameters:
        value - #publisher (The name of the organization or individual that published the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

      • getPublisher

        public abstract String getPublisher()
        Returns:
        The name of the organization or individual that published the canonical resource.

      • setPublisher

        public abstract CanonicalResource setPublisher​(String value)
        Parameters:
        value - The name of the organization or individual that published the canonical resource.

      • getContactMax

        public int getContactMax()
        How many allowed for this property by the implementation

      • getContact

        public abstract List<ContactDetail> getContact()
        Returns:
        #contact (Contact details to assist a user in finding and communicating with the publisher.)

      • hasContact

        public abstract boolean hasContact()

      • getContactFirstRep

        public abstract ContactDetail getContactFirstRep()
        Returns:
        The first repetition of repeating field #contact, creating it if it does not already exist {1}

      • getDescriptionMax

        public int getDescriptionMax()
        How many allowed for this property by the implementation

      • getDescriptionElement

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

      • setDescriptionElement

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

      • getDescription

        public abstract String getDescription()
        Returns:
        A free text natural language description of the canonical resource from a consumer's perspective.

      • setDescription

        public abstract CanonicalResource setDescription​(String value)
        Parameters:
        value - A free text natural language description of the canonical resource from a consumer's perspective.

      • getUseContextMax

        public int getUseContextMax()
        How many allowed for this property by the implementation

      • getUseContext

        public abstract List<UsageContext> getUseContext()
        Returns:
        #useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate canonical resource instances.)

      • getUseContextFirstRep

        public abstract UsageContext getUseContextFirstRep()
        Returns:
        The first repetition of repeating field #useContext, creating it if it does not already exist {1}

      • getJurisdictionMax

        public int getJurisdictionMax()
        How many allowed for this property by the implementation

      • getJurisdiction

        public abstract List<CodeableConcept> getJurisdiction()
        Returns:
        #jurisdiction (A legal or geographic region in which the canonical resource is intended to be used.)

      • getJurisdictionFirstRep

        public abstract CodeableConcept getJurisdictionFirstRep()
        Returns:
        The first repetition of repeating field #jurisdiction, creating it if it does not already exist {1}

      • getPurposeMax

        public int getPurposeMax()
        How many allowed for this property by the implementation

      • getPurposeElement

        public abstract MarkdownType getPurposeElement()
        Returns:
        #purpose (Explanation of why this canonical resource 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

      • hasPurpose

        public abstract boolean hasPurpose()

      • setPurposeElement

        public abstract CanonicalResource setPurposeElement​(MarkdownType value)
        Parameters:
        value - #purpose (Explanation of why this canonical resource 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 abstract String getPurpose()
        Returns:
        Explanation of why this canonical resource is needed and why it has been designed as it has.

      • setPurpose

        public abstract CanonicalResource setPurpose​(String value)
        Parameters:
        value - Explanation of why this canonical resource is needed and why it has been designed as it has.

      • getCopyrightMax

        public int getCopyrightMax()
        How many allowed for this property by the implementation

      • getCopyrightElement

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

      • setCopyrightElement

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

      • getCopyright

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

      • setCopyright

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

      • 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