NamingSystem (org.hl7.fhir.r4 5.4.0 API)

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.NamingSystem

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 NamingSystem
extends MetadataResource
```
A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NamingSystem.NamingSystemIdentifierType`
`static class`	`NamingSystem.NamingSystemIdentifierTypeEnumFactory`
`static class`	`NamingSystem.NamingSystemType`
`static class`	`NamingSystem.NamingSystemTypeEnumFactory`
`static class`	`NamingSystem.NamingSystemUniqueIdComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`CONTACT` Fluent Client search parameter constant for contact
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CONTEXT` Fluent Client search parameter constant for context
`static ca.uhn.fhir.rest.gclient.QuantityClientParam`	`CONTEXT_QUANTITY` Fluent Client search parameter constant for context-quantity
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CONTEXT_TYPE` Fluent Client search parameter constant for context-type
`static 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-quantity
`static 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-value
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`DESCRIPTION` Fluent Client search parameter constant for description
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ID_TYPE` Fluent Client search parameter constant for id-type
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`JURISDICTION` Fluent Client search parameter constant for jurisdiction
`protected Enumeration<NamingSystem.NamingSystemType>`	`kind` Indicates the purpose for the naming system - what kinds of things does it make unique?
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`KIND` Fluent Client search parameter constant for kind
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`PERIOD` Fluent Client search parameter constant for period
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`PUBLISHER` Fluent Client search parameter constant for publisher
`protected StringType`	`responsible` The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`RESPONSIBLE` Fluent Client search parameter constant for responsible
`static String`	`SP_CONTACT` Search parameter: contact
`static String`	`SP_CONTEXT` Search parameter: context
`static String`	`SP_CONTEXT_QUANTITY` Search parameter: context-quantity
`static String`	`SP_CONTEXT_TYPE` Search parameter: context-type
`static String`	`SP_CONTEXT_TYPE_QUANTITY` Search parameter: context-type-quantity
`static String`	`SP_CONTEXT_TYPE_VALUE` Search parameter: context-type-value
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_DESCRIPTION` Search parameter: description
`static String`	`SP_ID_TYPE` Search parameter: id-type
`static String`	`SP_JURISDICTION` Search parameter: jurisdiction
`static String`	`SP_KIND` Search parameter: kind
`static String`	`SP_NAME` Search parameter: name
`static String`	`SP_PERIOD` Search parameter: period
`static String`	`SP_PUBLISHER` Search parameter: publisher
`static String`	`SP_RESPONSIBLE` Search parameter: responsible
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_TELECOM` Search parameter: telecom
`static String`	`SP_TYPE` Search parameter: type
`static String`	`SP_VALUE` Search parameter: value
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TELECOM` Fluent Client search parameter constant for telecom
`protected CodeableConcept`	`type` Categorizes a naming system for easier search by grouping related naming systems.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type
`protected List<NamingSystem.NamingSystemUniqueIdComponent>`	`uniqueId` Indicates how the system may be identified when referenced in electronic exchange.
`protected StringType`	`usage` Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`VALUE` Fluent Client search parameter constant for value

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

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description
`NamingSystem()` Constructor
`NamingSystem(StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<NamingSystem.NamingSystemType> kind, DateTimeType date)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`ContactDetail`	`addContact()`
`NamingSystem`	`addContact(ContactDetail t)`
`CodeableConcept`	`addJurisdiction()`
`NamingSystem`	`addJurisdiction(CodeableConcept t)`
`NamingSystem.NamingSystemUniqueIdComponent`	`addUniqueId()`
`NamingSystem`	`addUniqueId(NamingSystem.NamingSystemUniqueIdComponent t)`
`UsageContext`	`addUseContext()`
`NamingSystem`	`addUseContext(UsageContext t)`
`NamingSystem`	`copy()`
`void`	`copyValues(NamingSystem dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<ContactDetail>`	`getContact()`
`ContactDetail`	`getContactFirstRep()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`String`	`getDescription()`
`MarkdownType`	`getDescriptionElement()`
`List<CodeableConcept>`	`getJurisdiction()`
`CodeableConcept`	`getJurisdictionFirstRep()`
`NamingSystem.NamingSystemType`	`getKind()`
`Enumeration<NamingSystem.NamingSystemType>`	`getKindElement()`
`String`	`getName()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`StringType`	`getNameElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getPublisher()`
`StringType`	`getPublisherElement()`
`ResourceType`	`getResourceType()`
`String`	`getResponsible()`
`StringType`	`getResponsibleElement()`
`Enumerations.PublicationStatus`	`getStatus()`
`Enumeration<Enumerations.PublicationStatus>`	`getStatusElement()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`List<NamingSystem.NamingSystemUniqueIdComponent>`	`getUniqueId()`
`NamingSystem.NamingSystemUniqueIdComponent`	`getUniqueIdFirstRep()`
`String`	`getUsage()`
`StringType`	`getUsageElement()`
`List<UsageContext>`	`getUseContext()`
`UsageContext`	`getUseContextFirstRep()`
`boolean`	`hasContact()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasJurisdiction()`
`boolean`	`hasKind()`
`boolean`	`hasKindElement()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasPublisher()`
`boolean`	`hasPublisherElement()`
`boolean`	`hasResponsible()`
`boolean`	`hasResponsibleElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasType()`
`boolean`	`hasUniqueId()`
`boolean`	`hasUsage()`
`boolean`	`hasUsageElement()`
`boolean`	`hasUseContext()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`NamingSystem`	`setContact(List<ContactDetail> theContact)`
`NamingSystem`	`setDate(Date value)`
`NamingSystem`	`setDateElement(DateTimeType value)`
`NamingSystem`	`setDescription(String value)`
`NamingSystem`	`setDescriptionElement(MarkdownType value)`
`NamingSystem`	`setJurisdiction(List<CodeableConcept> theJurisdiction)`
`NamingSystem`	`setKind(NamingSystem.NamingSystemType value)`
`NamingSystem`	`setKindElement(Enumeration<NamingSystem.NamingSystemType> value)`
`NamingSystem`	`setName(String value)`
`NamingSystem`	`setNameElement(StringType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`NamingSystem`	`setPublisher(String value)`
`NamingSystem`	`setPublisherElement(StringType value)`
`NamingSystem`	`setResponsible(String value)`
`NamingSystem`	`setResponsibleElement(StringType value)`
`NamingSystem`	`setStatus(Enumerations.PublicationStatus value)`
`NamingSystem`	`setStatusElement(Enumeration<Enumerations.PublicationStatus> value)`
`NamingSystem`	`setType(CodeableConcept value)`
`NamingSystem`	`setUniqueId(List<NamingSystem.NamingSystemUniqueIdComponent> theUniqueId)`
`NamingSystem`	`setUsage(String value)`
`NamingSystem`	`setUsageElement(StringType value)`
`NamingSystem`	`setUseContext(List<UsageContext> theUseContext)`
`protected NamingSystem`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.MetadataResource
copyValues, getExperimental, getExperimentalElement, getTitle, getTitleElement, getUrl, getUrlElement, getVersion, getVersionElement, hasExperimental, hasExperimentalElement, hasTitle, hasTitleElement, hasUrl, hasUrlElement, hasVersion, hasVersionElement, present, setExperimental, setExperimentalElement, setTitle, setTitleElement, setUrl, setUrlElement, setVersion, setVersionElement, 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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - kind
```
protected Enumeration<NamingSystem.NamingSystemType> kind
```
    Indicates the purpose for the naming system - what kinds of things does it make unique?
  - responsible
```
protected StringType responsible
```
    The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
  - type
```
protected CodeableConcept type
```
    Categorizes a naming system for easier search by grouping related naming systems.
  - usage
```
protected StringType usage
```
    Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
  - uniqueId
```
protected List<NamingSystem.NamingSystemUniqueIdComponent> uniqueId
```
    Indicates how the system may be identified when referenced in electronic exchange.
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: The naming system publication date
    Type: date
    Path: NamingSystem.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: The naming system publication date
    Type: date
    Path: NamingSystem.date
  - SP_PERIOD
```
public static final String SP_PERIOD
```
    Search parameter: period
    Description: When is identifier valid?
    Type: date
    Path: NamingSystem.uniqueId.period
    
    See Also:
    
    Constant Field Values
  - PERIOD
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD
```
    Fluent Client search parameter constant for period
    Description: When is identifier valid?
    Type: date
    Path: NamingSystem.uniqueId.period
  - SP_CONTEXT_TYPE_VALUE
```
public static final String SP_CONTEXT_TYPE_VALUE
```
    Search parameter: context-type-value
    Description: A use context type and value assigned to the naming system
    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-value
    Description: A use context type and value assigned to the naming system
    Type: composite
    Path:
  - SP_KIND
```
public static final String SP_KIND
```
    Search parameter: kind
    Description: codesystem | identifier | root
    Type: token
    Path: NamingSystem.kind
    
    See Also:
    
    Constant Field Values
  - KIND
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam KIND
```
    Fluent Client search parameter constant for kind
    Description: codesystem | identifier | root
    Type: token
    Path: NamingSystem.kind
  - SP_JURISDICTION
```
public static final String SP_JURISDICTION
```
    Search parameter: jurisdiction
    Description: Intended jurisdiction for the naming system
    Type: token
    Path: NamingSystem.jurisdiction
    
    See Also:
    
    Constant Field Values
  - JURISDICTION
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
```
    Fluent Client search parameter constant for jurisdiction
    Description: Intended jurisdiction for the naming system
    Type: token
    Path: NamingSystem.jurisdiction
  - SP_DESCRIPTION
```
public static final String SP_DESCRIPTION
```
    Search parameter: description
    Description: The description of the naming system
    Type: string
    Path: NamingSystem.description
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
```
    Fluent Client search parameter constant for description
    Description: The description of the naming system
    Type: string
    Path: NamingSystem.description
  - SP_CONTEXT_TYPE
```
public static final String SP_CONTEXT_TYPE
```
    Search parameter: context-type
    Description: A type of use context assigned to the naming system
    Type: token
    Path: NamingSystem.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-type
    Description: A type of use context assigned to the naming system
    Type: token
    Path: NamingSystem.useContext.code
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: e.g. driver, provider, patient, bank etc.
    Type: token
    Path: NamingSystem.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: e.g. driver, provider, patient, bank etc.
    Type: token
    Path: NamingSystem.type
  - SP_ID_TYPE
```
public static final String SP_ID_TYPE
```
    Search parameter: id-type
    Description: oid | uuid | uri | other
    Type: token
    Path: NamingSystem.uniqueId.type
    
    See Also:
    
    Constant Field Values
  - ID_TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ID_TYPE
```
    Fluent Client search parameter constant for id-type
    Description: oid | uuid | uri | other
    Type: token
    Path: NamingSystem.uniqueId.type
  - SP_CONTEXT_QUANTITY
```
public static final String SP_CONTEXT_QUANTITY
```
    Search parameter: context-quantity
    Description: A quantity- or range-valued use context assigned to the naming system
    Type: quantity
    Path: NamingSystem.useContext.valueQuantity, NamingSystem.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-quantity
    Description: A quantity- or range-valued use context assigned to the naming system
    Type: quantity
    Path: NamingSystem.useContext.valueQuantity, NamingSystem.useContext.valueRange
  - SP_RESPONSIBLE
```
public static final String SP_RESPONSIBLE
```
    Search parameter: responsible
    Description: Who maintains system namespace?
    Type: string
    Path: NamingSystem.responsible
    
    See Also:
    
    Constant Field Values
  - RESPONSIBLE
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam RESPONSIBLE
```
    Fluent Client search parameter constant for responsible
    Description: Who maintains system namespace?
    Type: string
    Path: NamingSystem.responsible
  - SP_CONTACT
```
public static final String SP_CONTACT
```
    Search parameter: contact
    Description: Name of an individual to contact
    Type: string
    Path: NamingSystem.contact.name
    
    See Also:
    
    Constant Field Values
  - CONTACT
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam CONTACT
```
    Fluent Client search parameter constant for contact
    Description: Name of an individual to contact
    Type: string
    Path: NamingSystem.contact.name
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter: name
    Description: Computationally friendly name of the naming system
    Type: string
    Path: NamingSystem.name
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description: Computationally friendly name of the naming system
    Type: string
    Path: NamingSystem.name
  - SP_CONTEXT
```
public static final String SP_CONTEXT
```
    Search parameter: context
    Description: A use context assigned to the naming system
    Type: token
    Path: NamingSystem.useContext.valueCodeableConcept
    
    See Also:
    
    Constant Field Values
  - CONTEXT
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
```
    Fluent Client search parameter constant for context
    Description: A use context assigned to the naming system
    Type: token
    Path: NamingSystem.useContext.valueCodeableConcept
  - SP_PUBLISHER
```
public static final String SP_PUBLISHER
```
    Search parameter: publisher
    Description: Name of the publisher of the naming system
    Type: string
    Path: NamingSystem.publisher
    
    See Also:
    
    Constant Field Values
  - PUBLISHER
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
```
    Fluent Client search parameter constant for publisher
    Description: Name of the publisher of the naming system
    Type: string
    Path: NamingSystem.publisher
  - SP_TELECOM
```
public static final String SP_TELECOM
```
    Search parameter: telecom
    Description: Contact details for individual or organization
    Type: token
    Path: NamingSystem.contact.telecom
    
    See Also:
    
    Constant Field Values
  - TELECOM
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TELECOM
```
    Fluent Client search parameter constant for telecom
    Description: Contact details for individual or organization
    Type: token
    Path: NamingSystem.contact.telecom
  - SP_VALUE
```
public static final String SP_VALUE
```
    Search parameter: value
    Description: The unique identifier
    Type: string
    Path: NamingSystem.uniqueId.value
    
    See Also:
    
    Constant Field Values
  - VALUE
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam VALUE
```
    Fluent Client search parameter constant for value
    Description: The unique identifier
    Type: string
    Path: NamingSystem.uniqueId.value
  - SP_CONTEXT_TYPE_QUANTITY
```
public static final String SP_CONTEXT_TYPE_QUANTITY
```
    Search parameter: context-type-quantity
    Description: A use context type and quantity- or range-based value assigned to the naming system
    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-quantity
    Description: A use context type and quantity- or range-based value assigned to the naming system
    Type: composite
    Path:
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: The current status of the naming system
    Type: token
    Path: NamingSystem.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: The current status of the naming system
    Type: token
    Path: NamingSystem.status
- Constructor Detail
  - NamingSystem
```
public NamingSystem()
```
    Constructor
  - NamingSystem
```
public NamingSystem(StringType name,
                    Enumeration<Enumerations.PublicationStatus> status,
                    Enumeration<NamingSystem.NamingSystemType> kind,
                    DateTimeType date)
```
    Constructor
- Method Detail
  - getNameElement
```
public StringType getNameElement()
```
    Overrides:
    
    getNameElement in class MetadataResource
    
    Returns:
    
    MetadataResource.name (A natural language name identifying the naming system. 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:
    
    hasNameElement in class MetadataResource
  - hasName
```
public boolean hasName()
```
    Overrides:
    
    hasName in class MetadataResource
  - setNameElement
```
public NamingSystem setNameElement(StringType value)
```
    Overrides:
    
    setNameElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.name (A natural language name identifying the naming system. 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:
    
    getName in class MetadataResource
    
    Returns:
    
    A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
  - setName
```
public NamingSystem setName(String value)
```
    Overrides:
    
    setName in class MetadataResource
    
    Parameters:
    
    value - A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
  - getStatusElement
```
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
```
    Overrides:
    
    getStatusElement in class MetadataResource
    
    Returns:
    
    MetadataResource.status (The status of this naming system. 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:
    
    hasStatusElement in class MetadataResource
  - hasStatus
```
public boolean hasStatus()
```
    Overrides:
    
    hasStatus in class MetadataResource
  - setStatusElement
```
public NamingSystem setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
```
    Overrides:
    
    setStatusElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.status (The status of this naming system. 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:
    
    getStatus in class MetadataResource
    
    Returns:
    
    The status of this naming system. Enables tracking the life-cycle of the content.
  - setStatus
```
public NamingSystem setStatus(Enumerations.PublicationStatus value)
```
    Overrides:
    
    setStatus in class MetadataResource
    
    Parameters:
    
    value - The status of this naming system. Enables tracking the life-cycle of the content.
  - getKindElement
```
public Enumeration<NamingSystem.NamingSystemType> getKindElement()
```
    Returns:
    
    kind (Indicates the purpose for the naming system - what kinds of things does it make unique?). 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 NamingSystem setKindElement(Enumeration<NamingSystem.NamingSystemType> value)
```
    Parameters:
    
    value - kind (Indicates the purpose for the naming system - what kinds of things does it make unique?). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
  - getKind
```
public NamingSystem.NamingSystemType getKind()
```
    Returns:
    
    Indicates the purpose for the naming system - what kinds of things does it make unique?
  - setKind
```
public NamingSystem setKind(NamingSystem.NamingSystemType value)
```
    Parameters:
    
    value - Indicates the purpose for the naming system - what kinds of things does it make unique?
  - getDateElement
```
public DateTimeType getDateElement()
```
    Overrides:
    
    getDateElement in class MetadataResource
    
    Returns:
    
    MetadataResource.date (The date (and optionally time) when the naming system 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 naming system 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:
    
    hasDateElement in class MetadataResource
  - hasDate
```
public boolean hasDate()
```
    Overrides:
    
    hasDate in class MetadataResource
  - setDateElement
```
public NamingSystem setDateElement(DateTimeType value)
```
    Overrides:
    
    setDateElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.date (The date (and optionally time) when the naming system 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 naming system 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:
    
    getDate in class MetadataResource
    
    Returns:
    
    The date (and optionally time) when the naming system 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 naming system changes.
  - setDate
```
public NamingSystem setDate(Date value)
```
    Overrides:
    
    setDate in class MetadataResource
    
    Parameters:
    
    value - The date (and optionally time) when the naming system 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 naming system changes.
  - getPublisherElement
```
public StringType getPublisherElement()
```
    Overrides:
    
    getPublisherElement in class MetadataResource
    
    Returns:
    
    MetadataResource.publisher (The name of the organization or individual that published the naming system.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
  - hasPublisherElement
```
public boolean hasPublisherElement()
```
    Overrides:
    
    hasPublisherElement in class MetadataResource
  - hasPublisher
```
public boolean hasPublisher()
```
    Overrides:
    
    hasPublisher in class MetadataResource
  - setPublisherElement
```
public NamingSystem setPublisherElement(StringType value)
```
    Overrides:
    
    setPublisherElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.publisher (The name of the organization or individual that published the naming system.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
  - getPublisher
```
public String getPublisher()
```
    Overrides:
    
    getPublisher in class MetadataResource
    
    Returns:
    
    The name of the organization or individual that published the naming system.
  - setPublisher
```
public NamingSystem setPublisher(String value)
```
    Overrides:
    
    setPublisher in class MetadataResource
    
    Parameters:
    
    value - The name of the organization or individual that published the naming system.
  - getContact
```
public List<ContactDetail> getContact()
```
    Overrides:
    
    getContact in class MetadataResource
    
    Returns:
    
    MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)
  - setContact
```
public NamingSystem setContact(List<ContactDetail> theContact)
```
    Overrides:
    
    setContact in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasContact
```
public boolean hasContact()
```
    Overrides:
    
    hasContact in class MetadataResource
  - addContact
```
public ContactDetail addContact()
```
    Overrides:
    
    addContact in class MetadataResource
  - addContact
```
public NamingSystem addContact(ContactDetail t)
```
    Overrides:
    
    addContact in class MetadataResource
  - getContactFirstRep
```
public ContactDetail getContactFirstRep()
```
    Overrides:
    
    getContactFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist
  - getResponsibleElement
```
public StringType getResponsibleElement()
```
    Returns:
    
    responsible (The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.). This is the underlying object with id, value and extensions. The accessor "getResponsible" gives direct access to the value
  - hasResponsibleElement
```
public boolean hasResponsibleElement()
```
  - hasResponsible
```
public boolean hasResponsible()
```
  - setResponsibleElement
```
public NamingSystem setResponsibleElement(StringType value)
```
    Parameters:
    
    value - responsible (The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.). This is the underlying object with id, value and extensions. The accessor "getResponsible" gives direct access to the value
  - getResponsible
```
public String getResponsible()
```
    Returns:
    
    The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
  - setResponsible
```
public NamingSystem setResponsible(String value)
```
    Parameters:
    
    value - The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (Categorizes a naming system for easier search by grouping related naming systems.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public NamingSystem setType(CodeableConcept value)
```
    Parameters:
    
    value - type (Categorizes a naming system for easier search by grouping related naming systems.)
  - getDescriptionElement
```
public MarkdownType getDescriptionElement()
```
    Overrides:
    
    getDescriptionElement in class MetadataResource
    
    Returns:
    
    MetadataResource.description (A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
    Overrides:
    
    hasDescriptionElement in class MetadataResource
  - hasDescription
```
public boolean hasDescription()
```
    Overrides:
    
    hasDescription in class MetadataResource
  - setDescriptionElement
```
public NamingSystem setDescriptionElement(MarkdownType value)
```
    Overrides:
    
    setDescriptionElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.description (A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Overrides:
    
    getDescription in class MetadataResource
    
    Returns:
    
    A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
  - setDescription
```
public NamingSystem setDescription(String value)
```
    Overrides:
    
    setDescription in class MetadataResource
    
    Parameters:
    
    value - A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
  - getUseContext
```
public List<UsageContext> getUseContext()
```
    Overrides:
    
    getUseContext in class MetadataResource
    
    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 naming system instances.)
  - setUseContext
```
public NamingSystem setUseContext(List<UsageContext> theUseContext)
```
    Overrides:
    
    setUseContext in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasUseContext
```
public boolean hasUseContext()
```
    Overrides:
    
    hasUseContext in class MetadataResource
  - addUseContext
```
public UsageContext addUseContext()
```
    Overrides:
    
    addUseContext in class MetadataResource
  - addUseContext
```
public NamingSystem addUseContext(UsageContext t)
```
    Overrides:
    
    addUseContext in class MetadataResource
  - getUseContextFirstRep
```
public UsageContext getUseContextFirstRep()
```
    Overrides:
    
    getUseContextFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist
  - getJurisdiction
```
public List<CodeableConcept> getJurisdiction()
```
    Overrides:
    
    getJurisdiction in class MetadataResource
    
    Returns:
    
    MetadataResource.jurisdiction (A legal or geographic region in which the naming system is intended to be used.)
  - setJurisdiction
```
public NamingSystem setJurisdiction(List<CodeableConcept> theJurisdiction)
```
    Overrides:
    
    setJurisdiction in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasJurisdiction
```
public boolean hasJurisdiction()
```
    Overrides:
    
    hasJurisdiction in class MetadataResource
  - addJurisdiction
```
public CodeableConcept addJurisdiction()
```
    Overrides:
    
    addJurisdiction in class MetadataResource
  - addJurisdiction
```
public NamingSystem addJurisdiction(CodeableConcept t)
```
    Overrides:
    
    addJurisdiction in class MetadataResource
  - getJurisdictionFirstRep
```
public CodeableConcept getJurisdictionFirstRep()
```
    Overrides:
    
    getJurisdictionFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist
  - getUsageElement
```
public StringType getUsageElement()
```
    Returns:
    
    usage (Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
  - hasUsageElement
```
public boolean hasUsageElement()
```
  - hasUsage
```
public boolean hasUsage()
```
  - setUsageElement
```
public NamingSystem setUsageElement(StringType value)
```
    Parameters:
    
    value - usage (Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
  - getUsage
```
public String getUsage()
```
    Returns:
    
    Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
  - setUsage
```
public NamingSystem setUsage(String value)
```
    Parameters:
    
    value - Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
  - getUniqueId
```
public List<NamingSystem.NamingSystemUniqueIdComponent> getUniqueId()
```
    Returns:
    
    uniqueId (Indicates how the system may be identified when referenced in electronic exchange.)
  - setUniqueId
```
public NamingSystem setUniqueId(List<NamingSystem.NamingSystemUniqueIdComponent> theUniqueId)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasUniqueId
```
public boolean hasUniqueId()
```
  - addUniqueId
```
public NamingSystem.NamingSystemUniqueIdComponent addUniqueId()
```
  - addUniqueId
```
public NamingSystem addUniqueId(NamingSystem.NamingSystemUniqueIdComponent t)
```
  - getUniqueIdFirstRep
```
public NamingSystem.NamingSystemUniqueIdComponent getUniqueIdFirstRep()
```
    Returns:
    
    The first repetition of repeating field uniqueId, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class MetadataResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class MetadataResource
  - copy
```
public NamingSystem copy()
```
    Specified by:
    
    copy in class MetadataResource
  - copyValues
```
public void copyValues(NamingSystem dst)
```
  - typedCopy
```
protected NamingSystem typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class MetadataResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class MetadataResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class MetadataResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class NamingSystem

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.MetadataResource

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

Fields inherited from class org.hl7.fhir.r4.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.MetadataResource

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

Methods inherited from class org.hl7.fhir.r4.model.Resource

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

kind

responsible

type

usage

uniqueId

SP_DATE

DATE

SP_PERIOD

PERIOD

SP_CONTEXT_TYPE_VALUE

CONTEXT_TYPE_VALUE

SP_KIND

KIND

SP_JURISDICTION

JURISDICTION

SP_DESCRIPTION

DESCRIPTION

SP_CONTEXT_TYPE

CONTEXT_TYPE

SP_TYPE

TYPE

SP_ID_TYPE

ID_TYPE

SP_CONTEXT_QUANTITY

CONTEXT_QUANTITY

SP_RESPONSIBLE

RESPONSIBLE

SP_CONTACT

CONTACT

SP_NAME

NAME

SP_CONTEXT

CONTEXT

SP_PUBLISHER

PUBLISHER

SP_TELECOM

TELECOM

SP_VALUE

VALUE

SP_CONTEXT_TYPE_QUANTITY

CONTEXT_TYPE_QUANTITY

SP_STATUS

STATUS

Constructor Detail

NamingSystem

NamingSystem

Method Detail

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getKindElement