Package org.linuxforhealth.fhir.model.resource

Class CapabilityStatement

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class CapabilityStatement
extends DomainResource
    A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

    Maturity level: FMM5 (Normative)

    • Method Detail

      • getUrl

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

      • getVersion

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

      • getTitle

        public String getTitle()
        A short, descriptive, user-friendly title for the capability statement.
        Returns:
        An immutable object of type String that may be null.

      • getStatus

        public PublicationStatus getStatus()
        The status of this capability statement. 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 capability statement 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 capability statement 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 capability statement changes.
        Returns:
        An immutable object of type DateTime that is non-null.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the capability statement.
        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 capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
        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 capability statement instances.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public java.util.List<CodeableConcept> getJurisdiction()
        A legal or geographic region in which the capability statement is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPurpose

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

      • getCopyright

        public Markdown getCopyright()
        A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
        Returns:
        An immutable object of type Markdown that may be null.

      • getKind

        public CapabilityStatementKind getKind()
        The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
        Returns:
        An immutable object of type CapabilityStatementKind that is non-null.

      • getInstantiates

        public java.util.List<Canonical> getInstantiates()
        Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getImports

        public java.util.List<Canonical> getImports()
        Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getSoftware

        public CapabilityStatement.Software getSoftware()
        Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
        Returns:
        An immutable object of type CapabilityStatement.Software that may be null.

      • getImplementation

        public CapabilityStatement.Implementation getImplementation()
        Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
        Returns:
        An immutable object of type CapabilityStatement.Implementation that may be null.

      • getFhirVersion

        public FHIRVersion getFhirVersion()
        The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.
        Returns:
        An immutable object of type FHIRVersion that is non-null.

      • getFormat

        public java.util.List<Code> getFormat()
        A list of the formats supported by this implementation using their content types.
        Returns:
        An unmodifiable list containing immutable objects of type Code that is non-empty.

      • getPatchFormat

        public java.util.List<Code> getPatchFormat()
        A list of the patch formats supported by this implementation using their content types.
        Returns:
        An unmodifiable list containing immutable objects of type Code that may be empty.

      • getImplementationGuide

        public java.util.List<Canonical> getImplementationGuide()
        A list of implementation guides that the server does (or should) support in their entirety.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getRest

        public java.util.List<CapabilityStatement.Rest> getRest()
        A definition of the restful capabilities of the solution, if any.
        Returns:
        An unmodifiable list containing immutable objects of type CapabilityStatement.Rest that may be empty.

      • 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