Package org.hl7.fhir.dstu2.model
Class NamingSystem
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.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 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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classNamingSystem.NamingSystemContactComponentstatic classNamingSystem.NamingSystemIdentifierTypestatic classNamingSystem.NamingSystemIdentifierTypeEnumFactorystatic classNamingSystem.NamingSystemTypestatic classNamingSystem.NamingSystemTypeEnumFactorystatic classNamingSystem.NamingSystemUniqueIdComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<NamingSystem.NamingSystemContactComponent>contactContacts to assist a user in finding and communicating with the publisher.protected DateTimeTypedateThe date (and optionally time) when the system was registered or published.protected StringTypedescriptionDetails about what the namespace identifies including scope, granularity, version labeling, etc.protected Enumeration<NamingSystem.NamingSystemType>kindIndicates the purpose for the naming system - what kinds of things does it make unique?protected StringTypenameThe descriptive name of this particular identifier type or code system.protected StringTypepublisherThe name of the individual or organization that published the naming system.protected ReferencereplacedByFor naming systems that are retired, indicates the naming system that should be used in their place (if any).protected NamingSystemreplacedByTargetThe actual object that is the target of the reference (For naming systems that are retired, indicates the naming system that should be used in their place (if any).)protected StringTyperesponsibleThe name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.static StringSP_CONTACTstatic StringSP_CONTEXTstatic StringSP_DATEstatic StringSP_IDTYPEstatic StringSP_KINDstatic StringSP_NAMEstatic StringSP_PERIODstatic StringSP_PUBLISHERstatic StringSP_REPLACEDBYstatic StringSP_RESPONSIBLEstatic StringSP_STATUSstatic StringSP_TELECOMstatic StringSP_TYPEstatic StringSP_VALUEprotected Enumeration<Enumerations.ConformanceResourceStatus>statusIndicates whether the naming system is "ready for use" or not.protected CodeableConcepttypeCategorizes a naming system for easier search by grouping related naming systems.protected List<NamingSystem.NamingSystemUniqueIdComponent>uniqueIdIndicates how the system may be identified when referenced in electronic exchange.protected StringTypeusageProvides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs.protected List<CodeableConcept>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description NamingSystem()NamingSystem(StringType name, Enumeration<Enumerations.ConformanceResourceStatus> status, Enumeration<NamingSystem.NamingSystemType> kind, DateTimeType date)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
name
protected StringType name
The descriptive name of this particular identifier type or code system.
-
status
protected Enumeration<Enumerations.ConformanceResourceStatus> status
Indicates whether the naming system is "ready for use" or not.
-
kind
protected Enumeration<NamingSystem.NamingSystemType> kind
Indicates the purpose for the naming system - what kinds of things does it make unique?
-
publisher
protected StringType publisher
The name of the individual or organization that published the naming system.
-
contact
protected List<NamingSystem.NamingSystemContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher.
-
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.
-
date
protected DateTimeType date
The date (and optionally time) when the system was registered or published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the registration changes.
-
type
protected CodeableConcept type
Categorizes a naming system for easier search by grouping related naming systems.
-
description
protected StringType description
Details about what the namespace identifies including scope, granularity, version labeling, etc.
-
useContext
protected List<CodeableConcept> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of 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.
-
replacedBy
protected Reference replacedBy
For naming systems that are retired, indicates the naming system that should be used in their place (if any).
-
replacedByTarget
protected NamingSystem replacedByTarget
The actual object that is the target of the reference (For naming systems that are retired, indicates the naming system that should be used in their place (if any).)
-
SP_DATE
public static final String SP_DATE
- See Also:
- Constant Field Values
-
SP_PERIOD
public static final String SP_PERIOD
- See Also:
- Constant Field Values
-
SP_KIND
public static final String SP_KIND
- See Also:
- Constant Field Values
-
SP_TYPE
public static final String SP_TYPE
- See Also:
- Constant Field Values
-
SP_IDTYPE
public static final String SP_IDTYPE
- See Also:
- Constant Field Values
-
SP_RESPONSIBLE
public static final String SP_RESPONSIBLE
- See Also:
- Constant Field Values
-
SP_CONTACT
public static final String SP_CONTACT
- See Also:
- Constant Field Values
-
SP_NAME
public static final String SP_NAME
- See Also:
- Constant Field Values
-
SP_CONTEXT
public static final String SP_CONTEXT
- See Also:
- Constant Field Values
-
SP_PUBLISHER
public static final String SP_PUBLISHER
- See Also:
- Constant Field Values
-
SP_TELECOM
public static final String SP_TELECOM
- See Also:
- Constant Field Values
-
SP_VALUE
public static final String SP_VALUE
- See Also:
- Constant Field Values
-
SP_REPLACEDBY
public static final String SP_REPLACEDBY
- See Also:
- Constant Field Values
-
SP_STATUS
public static final String SP_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NamingSystem
public NamingSystem()
-
NamingSystem
public NamingSystem(StringType name, Enumeration<Enumerations.ConformanceResourceStatus> status, Enumeration<NamingSystem.NamingSystemType> kind, DateTimeType date)
-
-
Method Detail
-
getNameElement
public StringType getNameElement()
- Returns:
name(The descriptive name of this particular identifier type or code system.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
-
hasName
public boolean hasName()
-
setNameElement
public NamingSystem setNameElement(StringType value)
- Parameters:
value-name(The descriptive name of this particular identifier type or code system.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Returns:
- The descriptive name of this particular identifier type or code system.
-
setName
public NamingSystem setName(String value)
- Parameters:
value- The descriptive name of this particular identifier type or code system.
-
getStatusElement
public Enumeration<Enumerations.ConformanceResourceStatus> getStatusElement()
- Returns:
status(Indicates whether the naming system is "ready for use" or not.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public NamingSystem setStatusElement(Enumeration<Enumerations.ConformanceResourceStatus> value)
- Parameters:
value-status(Indicates whether the naming system is "ready for use" or not.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.ConformanceResourceStatus getStatus()
- Returns:
- Indicates whether the naming system is "ready for use" or not.
-
setStatus
public NamingSystem setStatus(Enumerations.ConformanceResourceStatus value)
- Parameters:
value- Indicates whether the naming system is "ready for use" or not.
-
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?
-
getPublisherElement
public StringType getPublisherElement()
- Returns:
publisher(The name of the individual or organization 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()
-
hasPublisher
public boolean hasPublisher()
-
setPublisherElement
public NamingSystem setPublisherElement(StringType value)
- Parameters:
value-publisher(The name of the individual or organization 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()
- Returns:
- The name of the individual or organization that published the naming system.
-
setPublisher
public NamingSystem setPublisher(String value)
- Parameters:
value- The name of the individual or organization that published the naming system.
-
getContact
public List<NamingSystem.NamingSystemContactComponent> getContact()
- Returns:
contact(Contacts to assist a user in finding and communicating with the publisher.)
-
hasContact
public boolean hasContact()
-
addContact
public NamingSystem.NamingSystemContactComponent addContact()
- Returns:
contact(Contacts to assist a user in finding and communicating with the publisher.)
-
addContact
public NamingSystem addContact(NamingSystem.NamingSystemContactComponent t)
-
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.
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date(The date (and optionally time) when the system was registered or published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the registration changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public NamingSystem setDateElement(DateTimeType value)
- Parameters:
value-date(The date (and optionally time) when the system was registered or published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the registration changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Returns:
- The date (and optionally time) when the system was registered or published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the registration changes.
-
setDate
public NamingSystem setDate(Date value)
- Parameters:
value- The date (and optionally time) when the system was registered or published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the registration changes.
-
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 StringType getDescriptionElement()
- Returns:
description(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()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public NamingSystem setDescriptionElement(StringType value)
- Parameters:
value-description(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()
- Returns:
- Details about what the namespace identifies including scope, granularity, version labeling, etc.
-
setDescription
public NamingSystem setDescription(String value)
- Parameters:
value- Details about what the namespace identifies including scope, granularity, version labeling, etc.
-
getUseContext
public List<CodeableConcept> getUseContext()
- Returns:
useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of naming systems.)
-
hasUseContext
public boolean hasUseContext()
-
addUseContext
public CodeableConcept addUseContext()
- Returns:
useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of naming systems.)
-
addUseContext
public NamingSystem addUseContext(CodeableConcept t)
-
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.)
-
hasUniqueId
public boolean hasUniqueId()
-
addUniqueId
public NamingSystem.NamingSystemUniqueIdComponent addUniqueId()
- Returns:
uniqueId(Indicates how the system may be identified when referenced in electronic exchange.)
-
addUniqueId
public NamingSystem addUniqueId(NamingSystem.NamingSystemUniqueIdComponent t)
-
getReplacedBy
public Reference getReplacedBy()
- Returns:
replacedBy(For naming systems that are retired, indicates the naming system that should be used in their place (if any).)
-
hasReplacedBy
public boolean hasReplacedBy()
-
setReplacedBy
public NamingSystem setReplacedBy(Reference value)
- Parameters:
value-replacedBy(For naming systems that are retired, indicates the naming system that should be used in their place (if any).)
-
getReplacedByTarget
public NamingSystem getReplacedByTarget()
- Returns:
replacedByThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (For naming systems that are retired, indicates the naming system that should be used in their place (if any).)
-
setReplacedByTarget
public NamingSystem setReplacedByTarget(NamingSystem value)
- Parameters:
value-replacedByThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (For naming systems that are retired, indicates the naming system that should be used in their place (if any).)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public NamingSystem copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected NamingSystem typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-