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

Class DataElement

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.DataElement
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 DataElement extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR DataElement Resource ()

Definition: The formal description of a single piece of information that can be gathered and reported.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/DataElement

See Also:

  • Field Details

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

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

      See Also:

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

      public static final String SP_VERSION
      Search parameter constant for version

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

      See Also:

    • 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

    • SP_NAME

      public static final String SP_NAME
      Search parameter constant for name

      Description: Name of the data element
      Type: string
      Path: DataElement.name

      See Also:

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

      public static final String SP_PUBLISHER
      Search parameter constant for publisher

      Description: Name of the publisher of the data element
      Type: string
      Path: DataElement.publisher

      See Also:

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

      public static final String SP_DESCRIPTION
      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

      See Also:

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

      public static final String SP_STATUS
      Search parameter constant for status

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

      See Also:

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

      public static final String SP_DATE
      Search parameter constant for date

      Description: The data element publication date
      Type: date
      Path: DataElement.date

      See Also:

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

      public static final String SP_CODE
      Search parameter constant for code

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

      See Also:

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

      public static final String SP_CONTEXT
      Search parameter constant for context

      Description: A use context assigned to the data element
      Type: token
      Path: DataElement.useContext

      See Also:

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

      public static final String SP_URL
      Search parameter constant for url

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

      See Also:

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

      public static final String SP_STRINGENCY
      Search parameter constant for stringency

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

      See Also:

    • 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

  • 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

    • getUrlElement

      public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
      Gets the value(s) for url (). creating it if it does not exist. Will not return null.

      Definition: 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

    • getUrl

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

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

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

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

      Definition: 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.

    • setIdentifier

      public DataElement setIdentifier(List<IdentifierDt> theValue)
      Sets the value(s) for identifier ()

      Definition: 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 IdentifierDt addIdentifier()
      Adds and returns a new value for identifier ()

      Definition: 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 DataElement addIdentifier(IdentifierDt theValue)
      Adds a given new value for identifier ()

      Definition: 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.

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

    • getIdentifierFirstRep

      public IdentifierDt getIdentifierFirstRep()
      Gets the first repetition for identifier (), creating it if it does not already exist.

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getVersionElement()
      Gets the value(s) for version (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • getVersion

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

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

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

      Definition: 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.

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

    • getName

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

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

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

      Definition: 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.

    • getStatusElement

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

      Definition: The status of the data element

    • getStatus

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

      Definition: The status of the data element

    • setStatus

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

      Definition: The status of the data element

    • setStatus

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

      Definition: The status of the data element

    • getExperimentalElement

      public ca.uhn.fhir.model.primitive.BooleanDt getExperimentalElement()
      Gets the value(s) for experimental (). creating it if it does not exist. Will not return null.

      Definition: 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

    • getExperimental

      public Boolean getExperimental()
      Gets the value(s) for experimental (). creating it if it does not exist. This method may return null.

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

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

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
      Gets the value(s) for publisher (). creating it if it does not exist. Will not return null.

      Definition: The name of the individual or organization that published the data element

    • getPublisher

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

      Definition: The name of the individual or organization that published the data element

    • setPublisher

      public DataElement setPublisher(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for publisher ()

      Definition: The name of the individual or organization that published the data element

    • setPublisher

      public DataElement setPublisher(String theString)
      Sets the value for publisher ()

      Definition: The name of the individual or organization that published the data element

    • getContact

      public List<DataElement.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 DataElement setContact(List<DataElement.Contact> theValue)
      Sets the value(s) for contact ()

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

    • addContact

      public DataElement.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 DataElement addContact(DataElement.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 DataElement.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

    • getDateElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
      Gets the value(s) for date (). creating it if it does not exist. Will not return null.

      Definition: 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

    • getDate

      public Date getDate()
      Gets the value(s) for date (). creating it if it does not exist. This method may return null.

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

      Definition: 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

    • setDateWithSecondsPrecision

      public DataElement setDateWithSecondsPrecision(Date theDate)
      Sets the value for date ()

      Definition: 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 theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for date ()

      Definition: 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

    • 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 data element definitions.

    • setUseContext

      public DataElement 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 data element definitions.

    • 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 data element definitions.

    • addUseContext

      public DataElement 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 data element definitions.

      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 data element definitions.

    • getCopyrightElement

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

      Definition: 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

    • getCopyright

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

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

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

      Definition: 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

    • getStringencyElement

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

      Definition: Identifies how precise the data element is in its definition

    • getStringency

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

      Definition: Identifies how precise the data element is in its definition

    • setStringency

      public DataElement setStringency(ca.uhn.fhir.model.primitive.BoundCodeDt<DataElementStringencyEnum> theValue)
      Sets the value(s) for stringency ()

      Definition: Identifies how precise the data element is in its definition

    • setStringency

      public DataElement setStringency(DataElementStringencyEnum theValue)
      Sets the value(s) for stringency ()

      Definition: Identifies how precise the data element is in its definition

    • getMapping

      public List<DataElement.Mapping> getMapping()
      Gets the value(s) for mapping (). creating it if it does not exist. Will not return null.

      Definition: Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with

    • setMapping

      public DataElement setMapping(List<DataElement.Mapping> theValue)
      Sets the value(s) for mapping ()

      Definition: Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with

    • addMapping

      public DataElement.Mapping addMapping()
      Adds and returns a new value for mapping ()

      Definition: Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with

    • addMapping

      public DataElement addMapping(DataElement.Mapping theValue)
      Adds a given new value for mapping ()

      Definition: Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with

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

    • getMappingFirstRep

      public DataElement.Mapping getMappingFirstRep()
      Gets the first repetition for mapping (), creating it if it does not already exist.

      Definition: Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with

    • getElement

      public List<ElementDefinitionDt> getElement()
      Gets the value(s) for element (). creating it if it does not exist. Will not return null.

      Definition: Defines the structure, type, allowed values and other constraining characteristics of the data element

    • setElement

      public DataElement setElement(List<ElementDefinitionDt> theValue)
      Sets the value(s) for element ()

      Definition: Defines the structure, type, allowed values and other constraining characteristics of the data element

    • addElement

      public ElementDefinitionDt addElement()
      Adds and returns a new value for element ()

      Definition: Defines the structure, type, allowed values and other constraining characteristics of the data element

    • addElement

      public DataElement addElement(ElementDefinitionDt theValue)
      Adds a given new value for element ()

      Definition: Defines the structure, type, allowed values and other constraining characteristics of the data element

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

    • getElementFirstRep

      public ElementDefinitionDt getElementFirstRep()
      Gets the first repetition for element (), creating it if it does not already exist.

      Definition: Defines the structure, type, allowed values and other constraining characteristics of the data element

    • 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