Class TerminologyCapabilities
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.MetadataResource
-
- org.hl7.fhir.r4.model.TerminologyCapabilities
-
- 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 TerminologyCapabilities extends MetadataResource
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.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Field Summary
Fields Modifier and Type Field Description protected TerminologyCapabilities.TerminologyCapabilitiesClosureComponentclosureWhether the $closure operation is supported.protected Enumeration<TerminologyCapabilities.CodeSearchSupport>codeSearchThe degree to which the server supports the code search parameter on ValueSet, if it is supported.protected List<TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent>codeSystemIdentifies a code system that is supported by the server.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected MarkdownTypecopyrightA copyright statement relating to the terminology capabilities and/or its contents.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected TerminologyCapabilities.TerminologyCapabilitiesExpansionComponentexpansionInformation about the [ValueSet/$expand](valueset-operation-expand.html) operation.protected TerminologyCapabilities.TerminologyCapabilitiesImplementationComponentimplementationIdentifies a specific implementation instance that is described by the terminology capability statement - i.e.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected Enumeration<TerminologyCapabilities.CapabilityStatementKind>kindThe 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.protected BooleanTypelockedDateWhether the server supports lockedDate.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this terminology capabilities is needed and why it has been designed as it has.protected TerminologyCapabilities.TerminologyCapabilitiesSoftwareComponentsoftwareSoftware that is covered by this terminology capability statement.static StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titleprotected TerminologyCapabilities.TerminologyCapabilitiesTranslationComponenttranslationInformation about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected TerminologyCapabilities.TerminologyCapabilitiesValidateCodeComponentvalidateCodeInformation about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r4.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description TerminologyCapabilities()ConstructorTerminologyCapabilities(Enumeration<Enumerations.PublicationStatus> status, DateTimeType date, Enumeration<TerminologyCapabilities.CapabilityStatementKind> kind)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.MetadataResource
copyValues, present, toString
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
purpose
protected MarkdownType purpose
Explanation of why this terminology capabilities is needed and why it has been designed as it has.
-
copyright
protected MarkdownType copyright
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.
-
kind
protected Enumeration<TerminologyCapabilities.CapabilityStatementKind> kind
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).
-
software
protected TerminologyCapabilities.TerminologyCapabilitiesSoftwareComponent software
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.
-
implementation
protected TerminologyCapabilities.TerminologyCapabilitiesImplementationComponent implementation
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.
-
lockedDate
protected BooleanType lockedDate
Whether the server supports lockedDate.
-
codeSystem
protected List<TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent> codeSystem
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.
-
expansion
protected TerminologyCapabilities.TerminologyCapabilitiesExpansionComponent expansion
Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.
-
codeSearch
protected Enumeration<TerminologyCapabilities.CodeSearchSupport> codeSearch
The degree to which the server supports the code search parameter on ValueSet, if it is supported.
-
validateCode
protected TerminologyCapabilities.TerminologyCapabilitiesValidateCodeComponent validateCode
Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.
-
translation
protected TerminologyCapabilities.TerminologyCapabilitiesTranslationComponent translation
Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.
-
closure
protected TerminologyCapabilities.TerminologyCapabilitiesClosureComponent closure
Whether the $closure operation is supported.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: The terminology capabilities publication date
Type: date
Path: TerminologyCapabilities.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: The terminology capabilities publication date
Type: date
Path: TerminologyCapabilities.date
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the terminology capabilities
Type: composite
Path:
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the terminology capabilities
Type: composite
Path:
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the terminology capabilities
Type: token
Path: TerminologyCapabilities.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the terminology capabilities
Type: token
Path: TerminologyCapabilities.jurisdiction
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the terminology capabilities
Type: string
Path: TerminologyCapabilities.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the terminology capabilities
Type: string
Path: TerminologyCapabilities.description
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the terminology capabilities
Type: token
Path: TerminologyCapabilities.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the terminology capabilities
Type: token
Path: TerminologyCapabilities.useContext.code
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the terminology capabilities
Type: string
Path: TerminologyCapabilities.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the terminology capabilities
Type: string
Path: TerminologyCapabilities.title
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the terminology capabilities
Type: token
Path: TerminologyCapabilities.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the terminology capabilities
Type: token
Path: TerminologyCapabilities.version
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the terminology capabilities
Type: uri
Path: TerminologyCapabilities.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the terminology capabilities
Type: uri
Path: TerminologyCapabilities.url
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the terminology capabilities
Type: quantity
Path: TerminologyCapabilities.useContext.valueQuantity, TerminologyCapabilities.useContext.valueRange
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the terminology capabilities
Type: quantity
Path: TerminologyCapabilities.useContext.valueQuantity, TerminologyCapabilities.useContext.valueRange
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the terminology capabilities
Type: string
Path: TerminologyCapabilities.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the terminology capabilities
Type: string
Path: TerminologyCapabilities.name
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the terminology capabilities
Type: token
Path: TerminologyCapabilities.useContext.valueCodeableConcept
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the terminology capabilities
Type: token
Path: TerminologyCapabilities.useContext.valueCodeableConcept
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the terminology capabilities
Type: string
Path: TerminologyCapabilities.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the terminology capabilities
Type: string
Path: TerminologyCapabilities.publisher
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the terminology capabilities
Type: composite
Path:
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the terminology capabilities
Type: composite
Path:
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the terminology capabilities
Type: token
Path: TerminologyCapabilities.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the terminology capabilities
Type: token
Path: TerminologyCapabilities.status
-
-
Constructor Detail
-
TerminologyCapabilities
public TerminologyCapabilities()
Constructor
-
TerminologyCapabilities
public TerminologyCapabilities(Enumeration<Enumerations.PublicationStatus> status, DateTimeType date, Enumeration<TerminologyCapabilities.CapabilityStatementKind> kind)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Overrides:
getUrlElementin classMetadataResource- Returns:
MetadataResource.url(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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Overrides:
hasUrlElementin classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrlin classMetadataResource
-
setUrlElement
public TerminologyCapabilities setUrlElement(UriType value)
- Overrides:
setUrlElementin classMetadataResource- Parameters:
value-MetadataResource.url(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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Overrides:
getUrlin classMetadataResource- Returns:
- 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.
-
setUrl
public TerminologyCapabilities setUrl(String value)
- Overrides:
setUrlin classMetadataResource- Parameters:
value- 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.
-
getVersionElement
public StringType getVersionElement()
- Overrides:
getVersionElementin classMetadataResource- Returns:
MetadataResource.version(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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
- Overrides:
hasVersionElementin classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersionin classMetadataResource
-
setVersionElement
public TerminologyCapabilities setVersionElement(StringType value)
- Overrides:
setVersionElementin classMetadataResource- Parameters:
value-MetadataResource.version(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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Overrides:
getVersionin classMetadataResource- Returns:
- 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.
-
setVersion
public TerminologyCapabilities setVersion(String value)
- Overrides:
setVersionin classMetadataResource- Parameters:
value- 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.
-
getNameElement
public StringType getNameElement()
- Overrides:
getNameElementin classMetadataResource- Returns:
MetadataResource.name(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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
- Overrides:
hasNameElementin classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasNamein classMetadataResource
-
setNameElement
public TerminologyCapabilities setNameElement(StringType value)
- Overrides:
setNameElementin classMetadataResource- Parameters:
value-MetadataResource.name(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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Overrides:
getNamein classMetadataResource- Returns:
- 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.
-
setName
public TerminologyCapabilities setName(String value)
- Overrides:
setNamein classMetadataResource- Parameters:
value- 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.
-
getTitleElement
public StringType getTitleElement()
- Overrides:
getTitleElementin classMetadataResource- Returns:
MetadataResource.title(A short, descriptive, user-friendly title for the terminology capabilities.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
- Overrides:
hasTitleElementin classMetadataResource
-
hasTitle
public boolean hasTitle()
- Overrides:
hasTitlein classMetadataResource
-
setTitleElement
public TerminologyCapabilities setTitleElement(StringType value)
- Overrides:
setTitleElementin classMetadataResource- Parameters:
value-MetadataResource.title(A short, descriptive, user-friendly title for the terminology capabilities.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Overrides:
getTitlein classMetadataResource- Returns:
- A short, descriptive, user-friendly title for the terminology capabilities.
-
setTitle
public TerminologyCapabilities setTitle(String value)
- Overrides:
setTitlein classMetadataResource- Parameters:
value- A short, descriptive, user-friendly title for the terminology capabilities.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Overrides:
getStatusElementin classMetadataResource- Returns:
MetadataResource.status(The status of this terminology capabilities. 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
-
hasStatusElement
public boolean hasStatusElement()
- Overrides:
hasStatusElementin classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatusin classMetadataResource
-
setStatusElement
public TerminologyCapabilities setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Overrides:
setStatusElementin classMetadataResource- Parameters:
value-MetadataResource.status(The status of this terminology capabilities. 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
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Overrides:
getStatusin classMetadataResource- Returns:
- The status of this terminology capabilities. Enables tracking the life-cycle of the content.
-
setStatus
public TerminologyCapabilities setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatusin classMetadataResource- Parameters:
value- The status of this terminology capabilities. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Overrides:
getExperimentalElementin classMetadataResource- Returns:
MetadataResource.experimental(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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
- Overrides:
hasExperimentalElementin classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimentalin classMetadataResource
-
setExperimentalElement
public TerminologyCapabilities setExperimentalElement(BooleanType value)
- Overrides:
setExperimentalElementin classMetadataResource- Parameters:
value-MetadataResource.experimental(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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Overrides:
getExperimentalin classMetadataResource- Returns:
- 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.
-
setExperimental
public TerminologyCapabilities setExperimental(boolean value)
- Overrides:
setExperimentalin classMetadataResource- Parameters:
value- 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.
-
getDateElement
public DateTimeType getDateElement()
- Overrides:
getDateElementin classMetadataResource- Returns:
MetadataResource.date(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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
- Overrides:
hasDateElementin classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDatein classMetadataResource
-
setDateElement
public TerminologyCapabilities setDateElement(DateTimeType value)
- Overrides:
setDateElementin classMetadataResource- Parameters:
value-MetadataResource.date(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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Overrides:
getDatein classMetadataResource- Returns:
- 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.
-
setDate
public TerminologyCapabilities setDate(Date value)
- Overrides:
setDatein classMetadataResource- Parameters:
value- 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.
-
getPublisherElement
public StringType getPublisherElement()
- Overrides:
getPublisherElementin classMetadataResource- Returns:
MetadataResource.publisher(The name of the organization or individual that published the terminology capabilities.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
- Overrides:
hasPublisherElementin classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisherin classMetadataResource
-
setPublisherElement
public TerminologyCapabilities setPublisherElement(StringType value)
- Overrides:
setPublisherElementin classMetadataResource- Parameters:
value-MetadataResource.publisher(The name of the organization or individual that published the terminology capabilities.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Overrides:
getPublisherin classMetadataResource- Returns:
- The name of the organization or individual that published the terminology capabilities.
-
setPublisher
public TerminologyCapabilities setPublisher(String value)
- Overrides:
setPublisherin classMetadataResource- Parameters:
value- The name of the organization or individual that published the terminology capabilities.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContactin classMetadataResource- Returns:
MetadataResource.contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public TerminologyCapabilities setContact(List<ContactDetail> theContact)
- Overrides:
setContactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContactin classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContactin classMetadataResource
-
addContact
public TerminologyCapabilities addContact(ContactDetail t)
- Overrides:
addContactin classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.contact, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Overrides:
getDescriptionElementin classMetadataResource- Returns:
MetadataResource.description(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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
- Overrides:
hasDescriptionElementin classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescriptionin classMetadataResource
-
setDescriptionElement
public TerminologyCapabilities setDescriptionElement(MarkdownType value)
- Overrides:
setDescriptionElementin classMetadataResource- Parameters:
value-MetadataResource.description(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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Overrides:
getDescriptionin classMetadataResource- Returns:
- 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.
-
setDescription
public TerminologyCapabilities setDescription(String value)
- Overrides:
setDescriptionin classMetadataResource- Parameters:
value- 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.
-
getUseContext
public List<UsageContext> getUseContext()
- Overrides:
getUseContextin classMetadataResource- Returns:
MetadataResource.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 terminology capabilities instances.)
-
setUseContext
public TerminologyCapabilities setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContextin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContextin classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContextin classMetadataResource
-
addUseContext
public TerminologyCapabilities addUseContext(UsageContext t)
- Overrides:
addUseContextin classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.useContext, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdictionin classMetadataResource- Returns:
MetadataResource.jurisdiction(A legal or geographic region in which the terminology capabilities is intended to be used.)
-
setJurisdiction
public TerminologyCapabilities setJurisdiction(List<CodeableConcept> theJurisdiction)
- Overrides:
setJurisdictionin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdictionin classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdictionin classMetadataResource
-
addJurisdiction
public TerminologyCapabilities addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdictionin classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction, creating it if it does not already exist
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose(Explanation of why this terminology capabilities 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
-
hasPurposeElement
public boolean hasPurposeElement()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public TerminologyCapabilities setPurposeElement(MarkdownType value)
- Parameters:
value-purpose(Explanation of why this terminology capabilities 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:
- Explanation of why this terminology capabilities is needed and why it has been designed as it has.
-
setPurpose
public TerminologyCapabilities setPurpose(String value)
- Parameters:
value- Explanation of why this terminology capabilities is needed and why it has been designed as it has.
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Returns:
copyright(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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
-
hasCopyright
public boolean hasCopyright()
-
setCopyrightElement
public TerminologyCapabilities setCopyrightElement(MarkdownType value)
- Parameters:
value-copyright(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.). 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 terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.
-
setCopyright
public TerminologyCapabilities setCopyright(String value)
- Parameters:
value- 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.
-
getKindElement
public Enumeration<TerminologyCapabilities.CapabilityStatementKind> getKindElement()
- Returns:
kind(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).). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
-
hasKindElement
public boolean hasKindElement()
-
hasKind
public boolean hasKind()
-
setKindElement
public TerminologyCapabilities setKindElement(Enumeration<TerminologyCapabilities.CapabilityStatementKind> value)
- Parameters:
value-kind(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).). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
-
getKind
public TerminologyCapabilities.CapabilityStatementKind getKind()
- Returns:
- 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).
-
setKind
public TerminologyCapabilities setKind(TerminologyCapabilities.CapabilityStatementKind value)
- Parameters:
value- 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).
-
getSoftware
public TerminologyCapabilities.TerminologyCapabilitiesSoftwareComponent getSoftware()
- Returns:
software(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.)
-
hasSoftware
public boolean hasSoftware()
-
setSoftware
public TerminologyCapabilities setSoftware(TerminologyCapabilities.TerminologyCapabilitiesSoftwareComponent value)
- Parameters:
value-software(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.)
-
getImplementation
public TerminologyCapabilities.TerminologyCapabilitiesImplementationComponent getImplementation()
- Returns:
implementation(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.)
-
hasImplementation
public boolean hasImplementation()
-
setImplementation
public TerminologyCapabilities setImplementation(TerminologyCapabilities.TerminologyCapabilitiesImplementationComponent value)
- Parameters:
value-implementation(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.)
-
getLockedDateElement
public BooleanType getLockedDateElement()
- Returns:
lockedDate(Whether the server supports lockedDate.). This is the underlying object with id, value and extensions. The accessor "getLockedDate" gives direct access to the value
-
hasLockedDateElement
public boolean hasLockedDateElement()
-
hasLockedDate
public boolean hasLockedDate()
-
setLockedDateElement
public TerminologyCapabilities setLockedDateElement(BooleanType value)
- Parameters:
value-lockedDate(Whether the server supports lockedDate.). This is the underlying object with id, value and extensions. The accessor "getLockedDate" gives direct access to the value
-
getLockedDate
public boolean getLockedDate()
- Returns:
- Whether the server supports lockedDate.
-
setLockedDate
public TerminologyCapabilities setLockedDate(boolean value)
- Parameters:
value- Whether the server supports lockedDate.
-
getCodeSystem
public List<TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent> getCodeSystem()
- Returns:
codeSystem(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.)
-
setCodeSystem
public TerminologyCapabilities setCodeSystem(List<TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent> theCodeSystem)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCodeSystem
public boolean hasCodeSystem()
-
addCodeSystem
public TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent addCodeSystem()
-
addCodeSystem
public TerminologyCapabilities addCodeSystem(TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent t)
-
getCodeSystemFirstRep
public TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent getCodeSystemFirstRep()
- Returns:
- The first repetition of repeating field
codeSystem, creating it if it does not already exist
-
getExpansion
public TerminologyCapabilities.TerminologyCapabilitiesExpansionComponent getExpansion()
- Returns:
expansion(Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.)
-
hasExpansion
public boolean hasExpansion()
-
setExpansion
public TerminologyCapabilities setExpansion(TerminologyCapabilities.TerminologyCapabilitiesExpansionComponent value)
- Parameters:
value-expansion(Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.)
-
getCodeSearchElement
public Enumeration<TerminologyCapabilities.CodeSearchSupport> getCodeSearchElement()
- Returns:
codeSearch(The degree to which the server supports the code search parameter on ValueSet, if it is supported.). This is the underlying object with id, value and extensions. The accessor "getCodeSearch" gives direct access to the value
-
hasCodeSearchElement
public boolean hasCodeSearchElement()
-
hasCodeSearch
public boolean hasCodeSearch()
-
setCodeSearchElement
public TerminologyCapabilities setCodeSearchElement(Enumeration<TerminologyCapabilities.CodeSearchSupport> value)
- Parameters:
value-codeSearch(The degree to which the server supports the code search parameter on ValueSet, if it is supported.). This is the underlying object with id, value and extensions. The accessor "getCodeSearch" gives direct access to the value
-
getCodeSearch
public TerminologyCapabilities.CodeSearchSupport getCodeSearch()
- Returns:
- The degree to which the server supports the code search parameter on ValueSet, if it is supported.
-
setCodeSearch
public TerminologyCapabilities setCodeSearch(TerminologyCapabilities.CodeSearchSupport value)
- Parameters:
value- The degree to which the server supports the code search parameter on ValueSet, if it is supported.
-
getValidateCode
public TerminologyCapabilities.TerminologyCapabilitiesValidateCodeComponent getValidateCode()
- Returns:
validateCode(Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.)
-
hasValidateCode
public boolean hasValidateCode()
-
setValidateCode
public TerminologyCapabilities setValidateCode(TerminologyCapabilities.TerminologyCapabilitiesValidateCodeComponent value)
- Parameters:
value-validateCode(Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.)
-
getTranslation
public TerminologyCapabilities.TerminologyCapabilitiesTranslationComponent getTranslation()
- Returns:
translation(Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.)
-
hasTranslation
public boolean hasTranslation()
-
setTranslation
public TerminologyCapabilities setTranslation(TerminologyCapabilities.TerminologyCapabilitiesTranslationComponent value)
- Parameters:
value-translation(Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.)
-
getClosure
public TerminologyCapabilities.TerminologyCapabilitiesClosureComponent getClosure()
- Returns:
closure(Whether the $closure operation is supported.)
-
hasClosure
public boolean hasClosure()
-
setClosure
public TerminologyCapabilities setClosure(TerminologyCapabilities.TerminologyCapabilitiesClosureComponent value)
- Parameters:
value-closure(Whether the $closure operation is supported.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
public TerminologyCapabilities copy()
- Specified by:
copyin classMetadataResource
-
copyValues
public void copyValues(TerminologyCapabilities dst)
-
typedCopy
protected TerminologyCapabilities typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-