Package com.ibm.fhir.model.resource

Class CompartmentDefinition

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class CompartmentDefinition
extends DomainResource
    A compartment definition that defines how resources are accessed on a server.

    Maturity level: FMM1 (Trial Use)

    • Method Detail

      • getUrl

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

      • getVersion

        public String getVersion()
        The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition 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.
        Returns:
        An immutable object of type String that may be null.

      • getName

        public String getName()
        A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        Returns:
        An immutable object of type String that is non-null.

      • getStatus

        public PublicationStatus getStatus()
        The status of this compartment definition. Enables tracking the life-cycle of the content.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getExperimental

        public Boolean getExperimental()
        A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Returns:
        An immutable object of type Boolean that may be null.

      • getDate

        public DateTime getDate()
        The date (and optionally time) when the compartment definition 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 compartment definition changes.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the compartment definition.
        Returns:
        An immutable object of type String that may be null.

      • getContact

        public java.util.List<ContactDetail> getContact()
        Contact details to assist a user in finding and communicating with the publisher.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the compartment definition from a consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUseContext

        public java.util.List<UsageContext> getUseContext()
        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 compartment definition instances.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getPurpose

        public Markdown getPurpose()
        Explanation of why this compartment definition is needed and why it has been designed as it has.
        Returns:
        An immutable object of type Markdown that may be null.

      • getCode

        public CompartmentType getCode()
        Which compartment this definition describes.
        Returns:
        An immutable object of type CompartmentType that is non-null.

      • getSearch

        public Boolean getSearch()
        Whether the search syntax is supported,.
        Returns:
        An immutable object of type Boolean that is non-null.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object