Class NamingSystem
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.NamingSystem
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class NamingSystem extends DomainResource
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.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NamingSystem.Builder
static class
NamingSystem.UniqueId
Indicates how the system may be identified when referenced in electronic exchange.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static NamingSystem.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.DateTime
getDate()
The date (and optionally time) when the naming system was published.Markdown
getDescription()
A free text natural language description of the naming system from a consumer's perspective.java.util.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the naming system is intended to be used.NamingSystemType
getKind()
Indicates the purpose for the naming system - what kinds of things does it make unique?String
getName()
A natural language name identifying the naming system.String
getPublisher()
The name of the organization or individual that published the naming system.String
getResponsible()
The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.PublicationStatus
getStatus()
The status of this naming system.CodeableConcept
getType()
Categorizes a naming system for easier search by grouping related naming systems.java.util.List<NamingSystem.UniqueId>
getUniqueId()
Indicates how the system may be identified when referenced in electronic exchange.String
getUsage()
Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs.java.util.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.boolean
hasChildren()
int
hashCode()
NamingSystem.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getName
public String getName()
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.- Returns:
- An immutable object of type
String
that is non-null.
-
getStatus
public PublicationStatus getStatus()
The status of this naming system. Enables tracking the life-cycle of the content.- Returns:
- An immutable object of type
PublicationStatus
that is non-null.
-
getKind
public NamingSystemType getKind()
Indicates the purpose for the naming system - what kinds of things does it make unique?- Returns:
- An immutable object of type
NamingSystemType
that is non-null.
-
getDate
public DateTime getDate()
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.- Returns:
- An immutable object of type
DateTime
that is non-null.
-
getPublisher
public String getPublisher()
The name of the organization or individual that published the naming system.- Returns:
- An immutable object of type
String
that may be null.
-
getContact
public java.util.List<ContactDetail> getContact()
Contact details to assist a user in finding and communicating with the publisher.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getResponsible
public String getResponsible()
The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.- Returns:
- An immutable object of type
String
that may be null.
-
getType
public CodeableConcept getType()
Categorizes a naming system for easier search by grouping related naming systems.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getDescription
public Markdown getDescription()
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.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getUseContext
public java.util.List<UsageContext> getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.- Returns:
- An unmodifiable list containing immutable objects of type
UsageContext
that may be empty.
-
getJurisdiction
public java.util.List<CodeableConcept> getJurisdiction()
A legal or geographic region in which the naming system is intended to be used.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getUsage
public String getUsage()
Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.- Returns:
- An immutable object of type
String
that may be null.
-
getUniqueId
public java.util.List<NamingSystem.UniqueId> getUniqueId()
Indicates how the system may be identified when referenced in electronic exchange.- Returns:
- An unmodifiable list containing immutable objects of type
NamingSystem.UniqueId
that is non-empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public NamingSystem.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static NamingSystem.Builder builder()
-
-