Package org.hl7.fhir.dstu2016may.model

Class 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

    • Field Detail

      • name

        protected StringType name
        The descriptive name of this particular identifier type or code system.

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

      • publisher

        protected StringType publisher
        The name of the individual or organization that published the naming system.

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

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

      • 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_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_STATUS

        public static final String SP_STATUS
        Search parameter: status

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

      • 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_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Publication Date(/time)
        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: Publication Date(/time)
        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_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_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_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Name of the publisher (Organization or individual)
        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 (Organization or individual)
        Type: string
        Path: NamingSystem.publisher

      • 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_NAME

        public static final String SP_NAME
        Search parameter: name

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

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: Content intends to support these contexts
        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: Content intends to support these contexts
        Type: token
        Path: NamingSystem.useContext

      • 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_TELECOM

        public static final String SP_TELECOM
        Search parameter: telecom

        Description: Contact details for individual or publisher
        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 publisher
        Type: token
        Path: NamingSystem.contact.telecom

      • REPLACED_BY

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

        Description: Use this instead
        Type: reference
        Path: NamingSystem.replacedBy

      • 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".

    • 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

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

      • 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

      • hasKind

        public boolean hasKind()

      • 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

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

      • 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

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

      • 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

      • 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()

      • 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

      • 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.)

      • 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.)

      • 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

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

      • 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).)

      • getReplacedByTarget

        public NamingSystem getReplacedByTarget()
        Returns:
        replacedBy The 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 - replacedBy The 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).)

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

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