Package ca.uhn.fhir.model.dstu2.resource

Class NamingSystem

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.NamingSystem
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
public class NamingSystem
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR NamingSystem Resource (conformance.terminology)

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

See Also:
Serialized Form

  • Field Details

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter constant for type

      Description:
      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:
      Type: token
      Path: NamingSystem.type

    • SP_NAME

      public static final String SP_NAME
      Search parameter constant for name

      Description:
      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:
      Type: string
      Path: NamingSystem.name

    • SP_DATE

      public static final String SP_DATE
      Search parameter constant for date

      Description:
      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:
      Type: date
      Path: NamingSystem.date

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

      Description:
      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:
      Type: token
      Path: NamingSystem.status

    • SP_KIND

      public static final String SP_KIND
      Search parameter constant for kind

      Description:
      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:
      Type: token
      Path: NamingSystem.kind

    • SP_RESPONSIBLE

      public static final String SP_RESPONSIBLE
      Search parameter constant for responsible

      Description:
      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:
      Type: string
      Path: NamingSystem.responsible

    • SP_ID_TYPE

      public static final String SP_ID_TYPE
      Search parameter constant for id-type

      Description:
      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:
      Type: token
      Path: NamingSystem.uniqueId.type

    • SP_VALUE

      public static final String SP_VALUE
      Search parameter constant for value

      Description:
      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:
      Type: string
      Path: NamingSystem.uniqueId.value

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter constant for period

      Description:
      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:
      Type: date
      Path: NamingSystem.uniqueId.period

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter constant for publisher

      Description:
      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:
      Type: string
      Path: NamingSystem.publisher

    • SP_CONTACT

      public static final String SP_CONTACT
      Search parameter constant for contact

      Description:
      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:
      Type: string
      Path: NamingSystem.contact.name

    • SP_TELECOM

      public static final String SP_TELECOM
      Search parameter constant for telecom

      Description:
      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:
      Type: token
      Path: NamingSystem.contact.telecom

    • SP_REPLACED_BY

      public static final String SP_REPLACED_BY
      Search parameter constant for replaced-by

      Description:
      Type: reference
      Path: NamingSystem.replacedBy

      See Also:
      Constant Field Values

    • REPLACED_BY

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REPLACED_BY
      Fluent Client search parameter constant for replaced-by

      Description:
      Type: reference
      Path: NamingSystem.replacedBy

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter constant for context

      Description:
      Type: token
      Path: NamingSystem.useContext

      See Also:
      Constant Field Values

    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description:
      Type: token
      Path: NamingSystem.useContext

    • INCLUDE_REPLACED_BY

      public static final ca.uhn.fhir.model.api.Include INCLUDE_REPLACED_BY
      Constant for fluent queries to be used to add include statements. Specifies the path value of "NamingSystem:replaced-by".

  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getNameElement

      public ca.uhn.fhir.model.primitive.StringDt getNameElement()
      Gets the value(s) for name (). creating it if it does not exist. Will not return null.

      Definition: The descriptive name of this particular identifier type or code system

    • getName

      public String getName()
      Gets the value(s) for name (). creating it if it does not exist. This method may return null.

      Definition: The descriptive name of this particular identifier type or code system

    • setName

      public NamingSystem setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for name ()

      Definition: The descriptive name of this particular identifier type or code system

    • setName

      public NamingSystem setName​(String theString)
      Sets the value for name ()

      Definition: The descriptive name of this particular identifier type or code system

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition: Indicates whether the naming system is \"ready for use\" or not.

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition: Indicates whether the naming system is \"ready for use\" or not.

    • setStatus

      public NamingSystem setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition: Indicates whether the naming system is \"ready for use\" or not.

    • setStatus

      public NamingSystem setStatus​(ConformanceResourceStatusEnum theValue)
      Sets the value(s) for status (status)

      Definition: Indicates whether the naming system is \"ready for use\" or not.

    • getKindElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<NamingSystemTypeEnum> getKindElement()
      Gets the value(s) for kind (class). creating it if it does not exist. Will not return null.

      Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?

    • getKind

      public String getKind()
      Gets the value(s) for kind (class). creating it if it does not exist. This method may return null.

      Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?

    • setKind

      public NamingSystem setKind​(ca.uhn.fhir.model.primitive.BoundCodeDt<NamingSystemTypeEnum> theValue)
      Sets the value(s) for kind (class)

      Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?

    • setKind

      public NamingSystem setKind​(NamingSystemTypeEnum theValue)
      Sets the value(s) for kind (class)

      Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?

    • getPublisherElement

      public ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
      Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.

      Definition: The name of the individual or organization that published the naming system

    • getPublisher

      public String getPublisher()
      Gets the value(s) for publisher (who.witness). creating it if it does not exist. This method may return null.

      Definition: The name of the individual or organization that published the naming system

    • setPublisher

      public NamingSystem setPublisher​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for publisher (who.witness)

      Definition: The name of the individual or organization that published the naming system

    • setPublisher

      public NamingSystem setPublisher​(String theString)
      Sets the value for publisher (who.witness)

      Definition: The name of the individual or organization that published the naming system

    • getContact

      public List<NamingSystem.Contact> getContact()
      Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • setContact

      public NamingSystem setContact​(List<NamingSystem.Contact> theValue)
      Sets the value(s) for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • addContact

      public NamingSystem.Contact addContact()
      Adds and returns a new value for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • addContact

      public NamingSystem addContact​(NamingSystem.Contact theValue)
      Adds a given new value for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

      Parameters:
      theValue - The contact to add (must not be null)

    • getContactFirstRep

      public NamingSystem.Contact getContactFirstRep()
      Gets the first repetition for contact (), creating it if it does not already exist.

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • getResponsibleElement

      public ca.uhn.fhir.model.primitive.StringDt getResponsibleElement()
      Gets the value(s) for responsible (who.witness). creating it if it does not exist. Will not return null.

      Definition: The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

    • getResponsible

      public String getResponsible()
      Gets the value(s) for responsible (who.witness). creating it if it does not exist. This method may return null.

      Definition: 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​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for responsible (who.witness)

      Definition: 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 theString)
      Sets the value for responsible (who.witness)

      Definition: The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

    • getDateElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
      Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return 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

    • getDate

      public Date getDate()
      Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return 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

    • setDate

      public NamingSystem setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for date (when.recorded)

      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

    • setDate

      public NamingSystem setDate​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for date (when.recorded)

      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

    • setDateWithSecondsPrecision

      public NamingSystem setDateWithSecondsPrecision​(Date theDate)
      Sets the value for date (when.recorded)

      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

    • getType

      public BoundCodeableConceptDt<IdentifierTypeCodesEnum> getType()
      Gets the value(s) for type (). creating it if it does not exist. Will not return null.

      Definition: Categorizes a naming system for easier search by grouping related naming systems.

    • setType

      public NamingSystem setType​(BoundCodeableConceptDt<IdentifierTypeCodesEnum> theValue)
      Sets the value(s) for type ()

      Definition: Categorizes a naming system for easier search by grouping related naming systems.

    • setType

      public NamingSystem setType​(IdentifierTypeCodesEnum theValue)
      Sets the value(s) for type ()

      Definition: Categorizes a naming system for easier search by grouping related naming systems.

    • getDescriptionElement

      public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
      Gets the value(s) for description (). creating it if it does not exist. Will not return null.

      Definition: Details about what the namespace identifies including scope, granularity, version labeling, etc.

    • getDescription

      public String getDescription()
      Gets the value(s) for description (). creating it if it does not exist. This method may return null.

      Definition: Details about what the namespace identifies including scope, granularity, version labeling, etc.

    • setDescription

      public NamingSystem setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for description ()

      Definition: Details about what the namespace identifies including scope, granularity, version labeling, etc.

    • setDescription

      public NamingSystem setDescription​(String theString)
      Sets the value for description ()

      Definition: Details about what the namespace identifies including scope, granularity, version labeling, etc.

    • getUseContext

      public List<CodeableConceptDt> getUseContext()
      Gets the value(s) for useContext (). creating it if it does not exist. Will not return 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

    • setUseContext

      public NamingSystem setUseContext​(List<CodeableConceptDt> theValue)
      Sets the value(s) for useContext ()

      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

    • addUseContext

      public CodeableConceptDt addUseContext()
      Adds and returns a new value for useContext ()

      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

    • addUseContext

      public NamingSystem addUseContext​(CodeableConceptDt theValue)
      Adds a given new value for useContext ()

      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

      Parameters:
      theValue - The useContext to add (must not be null)

    • getUseContextFirstRep

      public CodeableConceptDt getUseContextFirstRep()
      Gets the first repetition for useContext (), creating it if it does not already exist.

      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

    • getUsageElement

      public ca.uhn.fhir.model.primitive.StringDt getUsageElement()
      Gets the value(s) for usage (). creating it if it does not exist. Will not return null.

      Definition: Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.

    • getUsage

      public String getUsage()
      Gets the value(s) for usage (). creating it if it does not exist. This method may return null.

      Definition: 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​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for usage ()

      Definition: 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 theString)
      Sets the value for usage ()

      Definition: 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.UniqueId> getUniqueId()
      Gets the value(s) for uniqueId (). creating it if it does not exist. Will not return null.

      Definition: Indicates how the system may be identified when referenced in electronic exchange

    • setUniqueId

      public NamingSystem setUniqueId​(List<NamingSystem.UniqueId> theValue)
      Sets the value(s) for uniqueId ()

      Definition: Indicates how the system may be identified when referenced in electronic exchange

    • addUniqueId

      public NamingSystem.UniqueId addUniqueId()
      Adds and returns a new value for uniqueId ()

      Definition: Indicates how the system may be identified when referenced in electronic exchange

    • addUniqueId

      public NamingSystem addUniqueId​(NamingSystem.UniqueId theValue)
      Adds a given new value for uniqueId ()

      Definition: Indicates how the system may be identified when referenced in electronic exchange

      Parameters:
      theValue - The uniqueId to add (must not be null)

    • getUniqueIdFirstRep

      public NamingSystem.UniqueId getUniqueIdFirstRep()
      Gets the first repetition for uniqueId (), creating it if it does not already exist.

      Definition: Indicates how the system may be identified when referenced in electronic exchange

    • getReplacedBy

      public ResourceReferenceDt getReplacedBy()
      Gets the value(s) for replacedBy (). creating it if it does not exist. Will not return null.

      Definition: For naming systems that are retired, indicates the naming system that should be used in their place (if any)

    • setReplacedBy

      public NamingSystem setReplacedBy​(ResourceReferenceDt theValue)
      Sets the value(s) for replacedBy ()

      Definition: For naming systems that are retired, indicates the naming system that should be used in their place (if any)

    • getResourceName

      public String getResourceName()
      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource

    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource