Package org.hl7.fhir.dstu2.model
Class DataElement
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.model.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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDataElement.DataElementContactComponentstatic classDataElement.DataElementMappingComponentstatic classDataElement.DataElementStringencystatic classDataElement.DataElementStringencyEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<DataElement.DataElementContactComponent>contactContacts to assist a user in finding and communicating with the publisher.protected StringTypecopyrightA copyright statement relating to the definition of the data element.protected DateTimeTypedateThe date this version of the data element was published.protected List<ElementDefinition>elementDefines the structure, type, allowed values and other constraining characteristics of the data element.protected BooleanTypeexperimentalA 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.protected List<Identifier>identifierFormal 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.protected List<DataElement.DataElementMappingComponent>mappingIdentifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.protected StringTypenameThe term used by humans to refer to the data element.protected StringTypepublisherThe name of the individual or organization that published the data element.static StringSP_CODEstatic StringSP_CONTEXTstatic StringSP_DATEstatic StringSP_DESCRIPTIONstatic StringSP_IDENTIFIERstatic StringSP_NAMEstatic StringSP_PUBLISHERstatic StringSP_STATUSstatic StringSP_STRINGENCYstatic StringSP_URLstatic StringSP_VERSIONprotected Enumeration<Enumerations.ConformanceResourceStatus>statusThe status of the data element.protected Enumeration<DataElement.DataElementStringency>stringencyIdentifies how precise the data element is in its definition.protected UriTypeurlAn absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance.protected List<CodeableConcept>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description DataElement()DataElement(Enumeration<Enumerations.ConformanceResourceStatus> status)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
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.
-
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.
-
status
protected Enumeration<Enumerations.ConformanceResourceStatus> status
The status of the data element.
-
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.
-
contact
protected List<DataElement.DataElementContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher.
-
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.
-
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.
-
stringency
protected Enumeration<DataElement.DataElementStringency> stringency
Identifies how precise the data element is in its definition.
-
mapping
protected List<DataElement.DataElementMappingComponent> mapping
Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
-
element
protected List<ElementDefinition> element
Defines the structure, type, allowed values and other constraining characteristics of the data element.
-
SP_DATE
public static final String SP_DATE
- See Also:
- Constant Field Values
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
- See Also:
- Constant Field Values
-
SP_CODE
public static final String SP_CODE
- See Also:
- Constant Field Values
-
SP_STRINGENCY
public static final String SP_STRINGENCY
- See Also:
- Constant Field Values
-
SP_NAME
public static final String SP_NAME
- See Also:
- Constant Field Values
-
SP_CONTEXT
public static final String SP_CONTEXT
- See Also:
- Constant Field Values
-
SP_PUBLISHER
public static final String SP_PUBLISHER
- See Also:
- Constant Field Values
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
- See Also:
- Constant Field Values
-
SP_VERSION
public static final String SP_VERSION
- See Also:
- Constant Field Values
-
SP_URL
public static final String SP_URL
- See Also:
- Constant Field Values
-
SP_STATUS
public static final String SP_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DataElement
public DataElement()
-
DataElement
public DataElement(Enumeration<Enumerations.ConformanceResourceStatus> status)
-
-
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
-
hasUrlElement
public boolean hasUrlElement()
-
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<Identifier> getIdentifier()
- 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.)
-
hasIdentifier
public boolean hasIdentifier()
-
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.)
-
addIdentifier
public DataElement addIdentifier(Identifier t)
-
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
-
hasVersionElement
public boolean hasVersionElement()
-
hasVersion
public boolean hasVersion()
-
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.
-
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
-
hasNameElement
public boolean hasNameElement()
-
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.
-
getStatusElement
public Enumeration<Enumerations.ConformanceResourceStatus> getStatusElement()
- Returns:
status(The status of the data element.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public DataElement setStatusElement(Enumeration<Enumerations.ConformanceResourceStatus> value)
- Parameters:
value-status(The status of the data element.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.ConformanceResourceStatus getStatus()
- Returns:
- The status of the data element.
-
setStatus
public DataElement setStatus(Enumerations.ConformanceResourceStatus value)
- Parameters:
value- The status of the data element.
-
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
-
hasExperimentalElement
public boolean hasExperimentalElement()
-
hasExperimental
public boolean hasExperimental()
-
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
-
hasPublisherElement
public boolean hasPublisherElement()
-
hasPublisher
public boolean hasPublisher()
-
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.
-
getContact
public List<DataElement.DataElementContactComponent> getContact()
- Returns:
contact(Contacts to assist a user in finding and communicating with the publisher.)
-
hasContact
public boolean hasContact()
-
addContact
public DataElement.DataElementContactComponent addContact()
- Returns:
contact(Contacts to assist a user in finding and communicating with the publisher.)
-
addContact
public DataElement addContact(DataElement.DataElementContactComponent t)
-
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
-
hasDateElement
public boolean hasDateElement()
-
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.
-
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 data element definitions.)
-
hasUseContext
public boolean hasUseContext()
-
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.)
-
addUseContext
public DataElement addUseContext(CodeableConcept t)
-
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
-
hasCopyrightElement
public boolean hasCopyrightElement()
-
hasCopyright
public boolean hasCopyright()
-
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.
-
getStringencyElement
public Enumeration<DataElement.DataElementStringency> getStringencyElement()
- Returns:
stringency(Identifies how precise the data element is in its definition.). This is the underlying object with id, value and extensions. The accessor "getStringency" gives direct access to the value
-
hasStringencyElement
public boolean hasStringencyElement()
-
hasStringency
public boolean hasStringency()
-
setStringencyElement
public DataElement setStringencyElement(Enumeration<DataElement.DataElementStringency> value)
- Parameters:
value-stringency(Identifies how precise the data element is in its definition.). This is the underlying object with id, value and extensions. The accessor "getStringency" gives direct access to the value
-
getStringency
public DataElement.DataElementStringency getStringency()
- Returns:
- Identifies how precise the data element is in its definition.
-
setStringency
public DataElement setStringency(DataElement.DataElementStringency value)
- Parameters:
value- Identifies how precise the data element is in its definition.
-
getMapping
public List<DataElement.DataElementMappingComponent> getMapping()
- Returns:
mapping(Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.)
-
hasMapping
public boolean hasMapping()
-
addMapping
public DataElement.DataElementMappingComponent addMapping()
- Returns:
mapping(Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.)
-
addMapping
public DataElement addMapping(DataElement.DataElementMappingComponent t)
-
getElement
public List<ElementDefinition> getElement()
- Returns:
element(Defines the structure, type, allowed values and other constraining characteristics of the data element.)
-
hasElement
public boolean hasElement()
-
addElement
public ElementDefinition addElement()
- Returns:
element(Defines the structure, type, allowed values and other constraining characteristics of the data element.)
-
addElement
public DataElement addElement(ElementDefinition t)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public DataElement copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected DataElement typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-