Class DataElement

  • 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 DataElement
    extends DomainResource
    The formal description of a single piece of information that can be gathered and reported.
    See Also:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published.
      • identifier

        protected List<Identifier> identifier
        Formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance.
      • version

        protected StringType version
        The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually.
      • experimental

        protected BooleanType experimental
        A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • publisher

        protected StringType publisher
        The name of the individual or organization that published the data element.
      • date

        protected DateTimeType date
        The date this version of the data element was 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 data element changes.
      • name

        protected StringType name
        The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used.
      • 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 data element definitions.
      • copyright

        protected StringType copyright
        A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element.
      • element

        protected List<ElementDefinition> element
        Defines the structure, type, allowed values and other constraining characteristics of the data element.
      • SP_STRINGENCY

        public static final String SP_STRINGENCY
        Search parameter: stringency

        Description: The stringency of the data element definition
        Type: token
        Path: DataElement.stringency

        See Also:
        Constant Field Values
      • STRINGENCY

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

        Description: The stringency of the data element definition
        Type: token
        Path: DataElement.stringency

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The current status of the data element
        Type: token
        Path: DataElement.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: The current status of the data element
        Type: token
        Path: DataElement.status

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: Text search in the description of the data element. This corresponds to the definition of the first DataElement.element.
        Type: string
        Path: DataElement.element.definition

        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
        Fluent Client search parameter constant for description

        Description: Text search in the description of the data element. This corresponds to the definition of the first DataElement.element.
        Type: string
        Path: DataElement.element.definition

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Name of the data element
        Type: string
        Path: DataElement.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: Name of the data element
        Type: string
        Path: DataElement.name

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the data element
        Type: token
        Path: DataElement.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: A use context assigned to the data element
        Type: token
        Path: DataElement.useContext

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: A code for the data element (server may choose to do subsumption)
        Type: token
        Path: DataElement.element.code

        See Also:
        Constant Field Values
      • CODE

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

        Description: A code for the data element (server may choose to do subsumption)
        Type: token
        Path: DataElement.element.code

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: The data element publication date
        Type: date
        Path: DataElement.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: The data element publication date
        Type: date
        Path: DataElement.date

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: The identifier of the data element
        Type: token
        Path: DataElement.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

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

        Description: The identifier of the data element
        Type: token
        Path: DataElement.identifier

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: The official URL for the data element
        Type: uri
        Path: DataElement.url

        See Also:
        Constant Field Values
      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: The official URL for the data element
        Type: uri
        Path: DataElement.url

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Name of the publisher of the data element
        Type: string
        Path: DataElement.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 of the data element
        Type: string
        Path: DataElement.publisher

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: The version identifier of the data element
        Type: string
        Path: DataElement.version

        See Also:
        Constant Field Values
      • VERSION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam VERSION
        Fluent Client search parameter constant for version

        Description: The version identifier of the data element
        Type: string
        Path: DataElement.version

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • hasUrl

        public boolean hasUrl()
      • setUrlElement

        public DataElement setUrlElement​(UriType value)
        Parameters:
        value - url (An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • getUrl

        public String getUrl()
        Returns:
        An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published.
      • setUrl

        public DataElement setUrl​(String value)
        Parameters:
        value - An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published.
      • getIdentifier

        public List<IdentifiergetIdentifier()
        Returns:
        identifier (Formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance.)
      • addIdentifier

        public Identifier addIdentifier()
        Returns:
        identifier (Formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance.)
      • getVersionElement

        public StringType getVersionElement()
        Returns:
        version (The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • setVersionElement

        public DataElement setVersionElement​(StringType value)
        Parameters:
        value - version (The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • getVersion

        public String getVersion()
        Returns:
        The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually.
      • setVersion

        public DataElement setVersion​(String value)
        Parameters:
        value - The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually.
      • getExperimentalElement

        public BooleanType getExperimentalElement()
        Returns:
        experimental (A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
      • setExperimentalElement

        public DataElement setExperimentalElement​(BooleanType value)
        Parameters:
        value - experimental (A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
      • getExperimental

        public boolean getExperimental()
        Returns:
        A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • setExperimental

        public DataElement setExperimental​(boolean value)
        Parameters:
        value - A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • getPublisherElement

        public StringType getPublisherElement()
        Returns:
        publisher (The name of the individual or organization that published the data element.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
      • setPublisherElement

        public DataElement setPublisherElement​(StringType value)
        Parameters:
        value - publisher (The name of the individual or organization that published the data element.). 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 data element.
      • setPublisher

        public DataElement setPublisher​(String value)
        Parameters:
        value - The name of the individual or organization that published the data element.
      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (The date this version of the data element was 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 data element 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 DataElement setDateElement​(DateTimeType value)
        Parameters:
        value - date (The date this version of the data element was 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 data element 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 this version of the data element was 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 data element changes.
      • setDate

        public DataElement setDate​(Date value)
        Parameters:
        value - The date this version of the data element was 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 data element changes.
      • getNameElement

        public StringType getNameElement()
        Returns:
        name (The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used.). 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 DataElement setNameElement​(StringType value)
        Parameters:
        value - name (The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used.). 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 term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used.
      • setName

        public DataElement setName​(String value)
        Parameters:
        value - The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used.
      • getUseContext

        public List<CodeableConceptgetUseContext()
        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 data element definitions.)
      • 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 data element definitions.)
      • getCopyrightElement

        public StringType getCopyrightElement()
        Returns:
        copyright (A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
      • setCopyrightElement

        public DataElement setCopyrightElement​(StringType value)
        Parameters:
        value - copyright (A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
      • getCopyright

        public String getCopyright()
        Returns:
        A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element.
      • setCopyright

        public DataElement setCopyright​(String value)
        Parameters:
        value - A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element.
      • addElement

        public ElementDefinition addElement()
        Returns:
        element (Defines the structure, type, allowed values and other constraining characteristics of the data element.)
      • 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