public class NamingSystem extends BaseResource implements IResource
Definition: 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.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/NamingSystem
| Modifier and Type | Class and Description |
|---|---|
static class |
NamingSystem.Contact
Block class for child element: NamingSystem.contact ()
|
static class |
NamingSystem.UniqueId
Block class for child element: NamingSystem.uniqueId ()
|
| Modifier and Type | Field and Description |
|---|---|
static StringClientParam |
CONTACT
Fluent Client search parameter constant for contact
|
static TokenClientParam |
CONTEXT
Fluent Client search parameter constant for context
|
static DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static TokenClientParam |
ID_TYPE
Fluent Client search parameter constant for id-type
|
static Include |
INCLUDE_REPLACED_BY
Constant for fluent queries to be used to add include statements.
|
static TokenClientParam |
KIND
Fluent Client search parameter constant for kind
|
static StringClientParam |
NAME
Fluent Client search parameter constant for name
|
static DateClientParam |
PERIOD
Fluent Client search parameter constant for period
|
static StringClientParam |
PUBLISHER
Fluent Client search parameter constant for publisher
|
static ReferenceClientParam |
REPLACED_BY
Fluent Client search parameter constant for replaced-by
|
static StringClientParam |
RESPONSIBLE
Fluent Client search parameter constant for responsible
|
static String |
SP_CONTACT
Search parameter constant for contact
|
static String |
SP_CONTEXT
Search parameter constant for context
|
static String |
SP_DATE
Search parameter constant for date
|
static String |
SP_ID_TYPE
Search parameter constant for id-type
|
static String |
SP_KIND
Search parameter constant for kind
|
static String |
SP_NAME
Search parameter constant for name
|
static String |
SP_PERIOD
Search parameter constant for period
|
static String |
SP_PUBLISHER
Search parameter constant for publisher
|
static String |
SP_REPLACED_BY
Search parameter constant for replaced-by
|
static String |
SP_RESPONSIBLE
Search parameter constant for responsible
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_TELECOM
Search parameter constant for telecom
|
static String |
SP_TYPE
Search parameter constant for type
|
static String |
SP_VALUE
Search parameter constant for value
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static TokenClientParam |
TELECOM
Fluent Client search parameter constant for telecom
|
static TokenClientParam |
TYPE
Fluent Client search parameter constant for type
|
static StringClientParam |
VALUE
Fluent Client search parameter constant for value
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
NamingSystem() |
| Modifier and Type | Method and Description |
|---|---|
NamingSystem.Contact |
addContact()
Adds and returns a new value for contact ()
|
NamingSystem |
addContact(NamingSystem.Contact theValue)
Adds a given new value for contact ()
|
NamingSystem.UniqueId |
addUniqueId()
Adds and returns a new value for uniqueId ()
|
NamingSystem |
addUniqueId(NamingSystem.UniqueId theValue)
Adds a given new value for uniqueId ()
|
CodeableConceptDt |
addUseContext()
Adds and returns a new value for useContext ()
|
NamingSystem |
addUseContext(CodeableConceptDt theValue)
Adds a given new value for useContext ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
List<NamingSystem.Contact> |
getContact()
Gets the value(s) for contact ().
|
NamingSystem.Contact |
getContactFirstRep()
Gets the first repetition for contact (),
creating it if it does not already exist.
|
Date |
getDate()
Gets the value(s) for date (when.recorded).
|
DateTimeDt |
getDateElement()
Gets the value(s) for date (when.recorded).
|
String |
getDescription()
Gets the value(s) for description ().
|
StringDt |
getDescriptionElement()
Gets the value(s) for description ().
|
String |
getKind()
Gets the value(s) for kind (class).
|
BoundCodeDt<NamingSystemTypeEnum> |
getKindElement()
Gets the value(s) for kind (class).
|
String |
getName()
Gets the value(s) for name ().
|
StringDt |
getNameElement()
Gets the value(s) for name ().
|
String |
getPublisher()
Gets the value(s) for publisher (who.witness).
|
StringDt |
getPublisherElement()
Gets the value(s) for publisher (who.witness).
|
ResourceReferenceDt |
getReplacedBy()
Gets the value(s) for replacedBy ().
|
String |
getResourceName() |
String |
getResponsible()
Gets the value(s) for responsible (who.witness).
|
StringDt |
getResponsibleElement()
Gets the value(s) for responsible (who.witness).
|
String |
getStatus()
Gets the value(s) for status (status).
|
BoundCodeDt<ConformanceResourceStatusEnum> |
getStatusElement()
Gets the value(s) for status (status).
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
BoundCodeableConceptDt<IdentifierTypeCodesEnum> |
getType()
Gets the value(s) for type ().
|
List<NamingSystem.UniqueId> |
getUniqueId()
Gets the value(s) for uniqueId ().
|
NamingSystem.UniqueId |
getUniqueIdFirstRep()
Gets the first repetition for uniqueId (),
creating it if it does not already exist.
|
String |
getUsage()
Gets the value(s) for usage ().
|
StringDt |
getUsageElement()
Gets the value(s) for usage ().
|
List<CodeableConceptDt> |
getUseContext()
Gets the value(s) for useContext ().
|
CodeableConceptDt |
getUseContextFirstRep()
Gets the first repetition for useContext (),
creating it if it does not already exist.
|
boolean |
isEmpty() |
NamingSystem |
setContact(List<NamingSystem.Contact> theValue)
Sets the value(s) for contact ()
|
NamingSystem |
setDate(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for date (when.recorded)
|
NamingSystem |
setDate(DateTimeDt theValue)
Sets the value(s) for date (when.recorded)
|
NamingSystem |
setDateWithSecondsPrecision(Date theDate)
Sets the value for date (when.recorded)
|
NamingSystem |
setDescription(String theString)
Sets the value for description ()
|
NamingSystem |
setDescription(StringDt theValue)
Sets the value(s) for description ()
|
NamingSystem |
setKind(BoundCodeDt<NamingSystemTypeEnum> theValue)
Sets the value(s) for kind (class)
|
NamingSystem |
setKind(NamingSystemTypeEnum theValue)
Sets the value(s) for kind (class)
|
NamingSystem |
setName(String theString)
Sets the value for name ()
|
NamingSystem |
setName(StringDt theValue)
Sets the value(s) for name ()
|
NamingSystem |
setPublisher(String theString)
Sets the value for publisher (who.witness)
|
NamingSystem |
setPublisher(StringDt theValue)
Sets the value(s) for publisher (who.witness)
|
NamingSystem |
setReplacedBy(ResourceReferenceDt theValue)
Sets the value(s) for replacedBy ()
|
NamingSystem |
setResponsible(String theString)
Sets the value for responsible (who.witness)
|
NamingSystem |
setResponsible(StringDt theValue)
Sets the value(s) for responsible (who.witness)
|
NamingSystem |
setStatus(BoundCodeDt<ConformanceResourceStatusEnum> theValue)
Sets the value(s) for status (status)
|
NamingSystem |
setStatus(ConformanceResourceStatusEnum theValue)
Sets the value(s) for status (status)
|
NamingSystem |
setType(BoundCodeableConceptDt<IdentifierTypeCodesEnum> theValue)
Sets the value(s) for type ()
|
NamingSystem |
setType(IdentifierTypeCodesEnum theValue)
Sets the value(s) for type ()
|
NamingSystem |
setUniqueId(List<NamingSystem.UniqueId> theValue)
Sets the value(s) for uniqueId ()
|
NamingSystem |
setUsage(String theString)
Sets the value for usage ()
|
NamingSystem |
setUsage(StringDt theValue)
Sets the value(s) for usage ()
|
NamingSystem |
setUseContext(List<CodeableConceptDt> theValue)
Sets the value(s) for useContext ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_TYPE
Description:
Type: token
Path: NamingSystem.type
public static final TokenClientParam TYPE
Description:
Type: token
Path: NamingSystem.type
public static final String SP_NAME
Description:
Type: string
Path: NamingSystem.name
public static final StringClientParam NAME
Description:
Type: string
Path: NamingSystem.name
public static final String SP_DATE
Description:
Type: date
Path: NamingSystem.date
public static final DateClientParam DATE
Description:
Type: date
Path: NamingSystem.date
public static final String SP_STATUS
Description:
Type: token
Path: NamingSystem.status
public static final TokenClientParam STATUS
Description:
Type: token
Path: NamingSystem.status
public static final String SP_KIND
Description:
Type: token
Path: NamingSystem.kind
public static final TokenClientParam KIND
Description:
Type: token
Path: NamingSystem.kind
public static final String SP_RESPONSIBLE
Description:
Type: string
Path: NamingSystem.responsible
public static final StringClientParam RESPONSIBLE
Description:
Type: string
Path: NamingSystem.responsible
public static final String SP_ID_TYPE
Description:
Type: token
Path: NamingSystem.uniqueId.type
public static final TokenClientParam ID_TYPE
Description:
Type: token
Path: NamingSystem.uniqueId.type
public static final String SP_VALUE
Description:
Type: string
Path: NamingSystem.uniqueId.value
public static final StringClientParam VALUE
Description:
Type: string
Path: NamingSystem.uniqueId.value
public static final String SP_PERIOD
Description:
Type: date
Path: NamingSystem.uniqueId.period
public static final DateClientParam PERIOD
Description:
Type: date
Path: NamingSystem.uniqueId.period
public static final String SP_PUBLISHER
Description:
Type: string
Path: NamingSystem.publisher
public static final StringClientParam PUBLISHER
Description:
Type: string
Path: NamingSystem.publisher
public static final String SP_CONTACT
Description:
Type: string
Path: NamingSystem.contact.name
public static final StringClientParam CONTACT
Description:
Type: string
Path: NamingSystem.contact.name
public static final String SP_TELECOM
Description:
Type: token
Path: NamingSystem.contact.telecom
public static final TokenClientParam TELECOM
Description:
Type: token
Path: NamingSystem.contact.telecom
public static final String SP_REPLACED_BY
Description:
Type: reference
Path: NamingSystem.replacedBy
public static final ReferenceClientParam REPLACED_BY
Description:
Type: reference
Path: NamingSystem.replacedBy
public static final String SP_CONTEXT
Description:
Type: token
Path: NamingSystem.useContext
public static final TokenClientParam CONTEXT
Description:
Type: token
Path: NamingSystem.useContext
public static final Include INCLUDE_REPLACED_BY
public NamingSystem()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic StringDt getNameElement()
null.
Definition: The descriptive name of this particular identifier type or code system
public String getName()
null.
Definition: The descriptive name of this particular identifier type or code system
public NamingSystem setName(StringDt theValue)
Definition: The descriptive name of this particular identifier type or code system
public NamingSystem setName(String theString)
Definition: The descriptive name of this particular identifier type or code system
public BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
null.
Definition: Indicates whether the naming system is \"ready for use\" or not.
public String getStatus()
null.
Definition: Indicates whether the naming system is \"ready for use\" or not.
public NamingSystem setStatus(BoundCodeDt<ConformanceResourceStatusEnum> theValue)
Definition: Indicates whether the naming system is \"ready for use\" or not.
public NamingSystem setStatus(ConformanceResourceStatusEnum theValue)
Definition: Indicates whether the naming system is \"ready for use\" or not.
public BoundCodeDt<NamingSystemTypeEnum> getKindElement()
null.
Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?
public String getKind()
null.
Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?
public NamingSystem setKind(BoundCodeDt<NamingSystemTypeEnum> theValue)
Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?
public NamingSystem setKind(NamingSystemTypeEnum theValue)
Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?
public StringDt getPublisherElement()
null.
Definition: The name of the individual or organization that published the naming system
public String getPublisher()
null.
Definition: The name of the individual or organization that published the naming system
public NamingSystem setPublisher(StringDt theValue)
Definition: The name of the individual or organization that published the naming system
public NamingSystem setPublisher(String theString)
Definition: The name of the individual or organization that published the naming system
public List<NamingSystem.Contact> getContact()
null.
Definition: Contacts to assist a user in finding and communicating with the publisher
public NamingSystem setContact(List<NamingSystem.Contact> theValue)
Definition: Contacts to assist a user in finding and communicating with the publisher
public NamingSystem.Contact addContact()
Definition: Contacts to assist a user in finding and communicating with the publisher
public NamingSystem addContact(NamingSystem.Contact theValue)
Definition: Contacts to assist a user in finding and communicating with the publisher
theValue - The contact to add (must not be null)public NamingSystem.Contact getContactFirstRep()
Definition: Contacts to assist a user in finding and communicating with the publisher
public StringDt getResponsibleElement()
null.
Definition: The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
public String getResponsible()
null.
Definition: The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
public NamingSystem setResponsible(StringDt theValue)
Definition: The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
public NamingSystem setResponsible(String theString)
Definition: The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
public DateTimeDt getDateElement()
null.
Definition: 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
public Date getDate()
null.
Definition: 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
public NamingSystem setDate(DateTimeDt theValue)
Definition: 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
public NamingSystem setDate(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: 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
public NamingSystem setDateWithSecondsPrecision(Date theDate)
Definition: 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
public BoundCodeableConceptDt<IdentifierTypeCodesEnum> getType()
null.
Definition: Categorizes a naming system for easier search by grouping related naming systems.
public NamingSystem setType(BoundCodeableConceptDt<IdentifierTypeCodesEnum> theValue)
Definition: Categorizes a naming system for easier search by grouping related naming systems.
public NamingSystem setType(IdentifierTypeCodesEnum theValue)
Definition: Categorizes a naming system for easier search by grouping related naming systems.
public StringDt getDescriptionElement()
null.
Definition: Details about what the namespace identifies including scope, granularity, version labeling, etc.
public String getDescription()
null.
Definition: Details about what the namespace identifies including scope, granularity, version labeling, etc.
public NamingSystem setDescription(StringDt theValue)
Definition: Details about what the namespace identifies including scope, granularity, version labeling, etc.
public NamingSystem setDescription(String theString)
Definition: Details about what the namespace identifies including scope, granularity, version labeling, etc.
public List<CodeableConceptDt> getUseContext()
null.
Definition: 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
public NamingSystem setUseContext(List<CodeableConceptDt> theValue)
Definition: 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
public CodeableConceptDt addUseContext()
Definition: 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
public NamingSystem addUseContext(CodeableConceptDt theValue)
Definition: 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
theValue - The useContext to add (must not be null)public CodeableConceptDt getUseContextFirstRep()
Definition: 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
public StringDt getUsageElement()
null.
Definition: Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
public String getUsage()
null.
Definition: Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
public NamingSystem setUsage(StringDt theValue)
Definition: Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
public NamingSystem setUsage(String theString)
Definition: Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
public List<NamingSystem.UniqueId> getUniqueId()
null.
Definition: Indicates how the system may be identified when referenced in electronic exchange
public NamingSystem setUniqueId(List<NamingSystem.UniqueId> theValue)
Definition: Indicates how the system may be identified when referenced in electronic exchange
public NamingSystem.UniqueId addUniqueId()
Definition: Indicates how the system may be identified when referenced in electronic exchange
public NamingSystem addUniqueId(NamingSystem.UniqueId theValue)
Definition: Indicates how the system may be identified when referenced in electronic exchange
theValue - The uniqueId to add (must not be null)public NamingSystem.UniqueId getUniqueIdFirstRep()
Definition: Indicates how the system may be identified when referenced in electronic exchange
public ResourceReferenceDt getReplacedBy()
null.
Definition: For naming systems that are retired, indicates the naming system that should be used in their place (if any)
public NamingSystem setReplacedBy(ResourceReferenceDt theValue)
Definition: For naming systems that are retired, indicates the naming system that should be used in their place (if any)
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.