Class TerminologyCapabilities
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.TerminologyCapabilities
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class TerminologyCapabilities extends DomainResource
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.Maturity level: FMM0 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TerminologyCapabilities.Builder
static class
TerminologyCapabilities.Closure
Whether the $closure operation is supported.static class
TerminologyCapabilities.CodeSystem
Identifies a code system that is supported by the server.static class
TerminologyCapabilities.Expansion
Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.static class
TerminologyCapabilities.Implementation
Identifies a specific implementation instance that is described by the terminology capability statement - i.e.static class
TerminologyCapabilities.Software
Software that is covered by this terminology capability statement.static class
TerminologyCapabilities.Translation
Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.static class
TerminologyCapabilities.ValidateCode
Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static TerminologyCapabilities.Builder
builder()
boolean
equals(java.lang.Object obj)
TerminologyCapabilities.Closure
getClosure()
Whether the $closure operation is supported.CodeSearchSupport
getCodeSearch()
The degree to which the server supports the code search parameter on ValueSet, if it is supported.java.util.List<TerminologyCapabilities.CodeSystem>
getCodeSystem()
Identifies a code system that is supported by the server.java.util.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.Markdown
getCopyright()
A copyright statement relating to the terminology capabilities and/or its contents.DateTime
getDate()
The date (and optionally time) when the terminology capabilities was published.Markdown
getDescription()
A free text natural language description of the terminology capabilities from a consumer's perspective.TerminologyCapabilities.Expansion
getExpansion()
Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.Boolean
getExperimental()
A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.TerminologyCapabilities.Implementation
getImplementation()
Identifies a specific implementation instance that is described by the terminology capability statement - i.e.java.util.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the terminology capabilities is intended to be used.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.Boolean
getLockedDate()
Whether the server supports lockedDate.String
getName()
A natural language name identifying the terminology capabilities.String
getPublisher()
The name of the organization or individual that published the terminology capabilities.Markdown
getPurpose()
Explanation of why this terminology capabilities is needed and why it has been designed as it has.TerminologyCapabilities.Software
getSoftware()
Software that is covered by this terminology capability statement.PublicationStatus
getStatus()
The status of this terminology capabilities.String
getTitle()
A short, descriptive, user-friendly title for the terminology capabilities.TerminologyCapabilities.Translation
getTranslation()
Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.Uri
getUrl()
An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier.java.util.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.TerminologyCapabilities.ValidateCode
getValidateCode()
Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.String
getVersion()
The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance.boolean
hasChildren()
int
hashCode()
TerminologyCapabilities.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getUrl
public Uri getUrl()
An absolute URI that is used to identify this terminology capabilities 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 terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities 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 terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities 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 terminology capabilities. 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 terminology capabilities.- Returns:
- An immutable object of type
String
that may be null.
-
getStatus
public PublicationStatus getStatus()
The status of this terminology capabilities. 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 terminology capabilities 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 terminology capabilities 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 terminology capabilities 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 terminology capabilities.- 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 terminology capabilities 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 terminology capabilities 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 terminology capabilities 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 terminology capabilities 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 terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.- 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.
-
getSoftware
public TerminologyCapabilities.Software getSoftware()
Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.- Returns:
- An immutable object of type
TerminologyCapabilities.Software
that may be null.
-
getImplementation
public TerminologyCapabilities.Implementation getImplementation()
Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.- Returns:
- An immutable object of type
TerminologyCapabilities.Implementation
that may be null.
-
getLockedDate
public Boolean getLockedDate()
Whether the server supports lockedDate.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getCodeSystem
public java.util.List<TerminologyCapabilities.CodeSystem> getCodeSystem()
Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.- Returns:
- An unmodifiable list containing immutable objects of type
TerminologyCapabilities.CodeSystem
that may be empty.
-
getExpansion
public TerminologyCapabilities.Expansion getExpansion()
Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.- Returns:
- An immutable object of type
TerminologyCapabilities.Expansion
that may be null.
-
getCodeSearch
public CodeSearchSupport getCodeSearch()
The degree to which the server supports the code search parameter on ValueSet, if it is supported.- Returns:
- An immutable object of type
CodeSearchSupport
that may be null.
-
getValidateCode
public TerminologyCapabilities.ValidateCode getValidateCode()
Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.- Returns:
- An immutable object of type
TerminologyCapabilities.ValidateCode
that may be null.
-
getTranslation
public TerminologyCapabilities.Translation getTranslation()
Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.- Returns:
- An immutable object of type
TerminologyCapabilities.Translation
that may be null.
-
getClosure
public TerminologyCapabilities.Closure getClosure()
Whether the $closure operation is supported.- Returns:
- An immutable object of type
TerminologyCapabilities.Closure
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
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 interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public TerminologyCapabilities.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static TerminologyCapabilities.Builder builder()
-
-