org.hl7.fhir.dstu3.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 MetadataResource

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 class`	`DataElement.DataElementMappingComponent`
`static class`	`DataElement.DataElementStringency`
`static class`	`DataElement.DataElementStringencyEnumFactory`

Field Summary

Fields
Modifier and Type	Field	Description
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CODE`	Fluent Client search parameter constant for code
`protected MarkdownType`	`copyright`	A copyright statement relating to the data element and/or its contents.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE`	Fluent Client search parameter constant for date
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`DESCRIPTION`	Fluent Client search parameter constant for description
`protected List<ElementDefinition>`	`element`	Defines the structure, type, allowed values and other constraining characteristics of the data element.
`protected List<Identifier>`	`identifier`	A 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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`JURISDICTION`	Fluent Client search parameter constant for jurisdiction
`protected List<DataElement.DataElementMappingComponent>`	`mapping`	Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`NAME`	Fluent Client search parameter constant for name
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`PUBLISHER`	Fluent Client search parameter constant for publisher
`static String`	`SP_CODE`	Search parameter: code
`static String`	`SP_DATE`	Search parameter: date
`static String`	`SP_DESCRIPTION`	Search parameter: description
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_JURISDICTION`	Search parameter: jurisdiction
`static String`	`SP_NAME`	Search parameter: name
`static String`	`SP_PUBLISHER`	Search parameter: publisher
`static String`	`SP_STATUS`	Search parameter: status
`static String`	`SP_STRINGENCY`	Search parameter: stringency
`static String`	`SP_TITLE`	Search parameter: title
`static String`	`SP_URL`	Search parameter: url
`static String`	`SP_VERSION`	Search parameter: version
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS`	Fluent Client search parameter constant for status
`protected Enumeration<DataElement.DataElementStringency>`	`stringency`	Identifies how precise the data element is in its definition.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STRINGENCY`	Fluent Client search parameter constant for stringency
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`TITLE`	Fluent Client search parameter constant for title
`static ca.uhn.fhir.rest.gclient.UriClientParam`	`URL`	Fluent Client search parameter constant for url
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`VERSION`	Fluent Client search parameter constant for version

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource

contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor Description

DataElement()
Constructor

DataElement(Enumeration<Enumerations.PublicationStatus> status)
Constructor

Method Summary

Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`ContactDetail`	`addContact()`
`DataElement`	`addContact(ContactDetail t)`
`ElementDefinition`	`addElement()`
`DataElement`	`addElement(ElementDefinition t)`
`Identifier`	`addIdentifier()`
`DataElement`	`addIdentifier(Identifier t)`
`CodeableConcept`	`addJurisdiction()`
`DataElement`	`addJurisdiction(CodeableConcept t)`
`DataElement.DataElementMappingComponent`	`addMapping()`
`DataElement`	`addMapping(DataElement.DataElementMappingComponent t)`
`UsageContext`	`addUseContext()`
`DataElement`	`addUseContext(UsageContext t)`
`DataElement`	`copy()`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<ContactDetail>`	`getContact()`
`ContactDetail`	`getContactFirstRep()`
`String`	`getCopyright()`
`MarkdownType`	`getCopyrightElement()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`List<ElementDefinition>`	`getElement()`
`ElementDefinition`	`getElementFirstRep()`
`boolean`	`getExperimental()`
`BooleanType`	`getExperimentalElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`List<CodeableConcept>`	`getJurisdiction()`
`CodeableConcept`	`getJurisdictionFirstRep()`
`List<DataElement.DataElementMappingComponent>`	`getMapping()`
`DataElement.DataElementMappingComponent`	`getMappingFirstRep()`
`String`	`getName()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`StringType`	`getNameElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getPublisher()`
`StringType`	`getPublisherElement()`
`ResourceType`	`getResourceType()`
`Enumerations.PublicationStatus`	`getStatus()`
`Enumeration<Enumerations.PublicationStatus>`	`getStatusElement()`
`DataElement.DataElementStringency`	`getStringency()`
`Enumeration<DataElement.DataElementStringency>`	`getStringencyElement()`
`String`	`getTitle()`
`StringType`	`getTitleElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`String`	`getUrl()`
`UriType`	`getUrlElement()`
`List<UsageContext>`	`getUseContext()`
`UsageContext`	`getUseContextFirstRep()`
`String`	`getVersion()`
`StringType`	`getVersionElement()`
`boolean`	`hasContact()`
`boolean`	`hasCopyright()`
`boolean`	`hasCopyrightElement()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasElement()`
`boolean`	`hasExperimental()`
`boolean`	`hasExperimentalElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasJurisdiction()`
`boolean`	`hasMapping()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasPublisher()`
`boolean`	`hasPublisherElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasStringency()`
`boolean`	`hasStringencyElement()`
`boolean`	`hasTitle()`
`boolean`	`hasTitleElement()`
`boolean`	`hasUrl()`
`boolean`	`hasUrlElement()`
`boolean`	`hasUseContext()`
`boolean`	`hasVersion()`
`boolean`	`hasVersionElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`DataElement`	`setContact(List<ContactDetail> theContact)`
`DataElement`	`setCopyright(String value)`
`DataElement`	`setCopyrightElement(MarkdownType value)`
`DataElement`	`setDate(Date value)`
`DataElement`	`setDateElement(DateTimeType value)`
`DataElement`	`setElement(List<ElementDefinition> theElement)`
`DataElement`	`setExperimental(boolean value)`
`DataElement`	`setExperimentalElement(BooleanType value)`
`DataElement`	`setIdentifier(List<Identifier> theIdentifier)`
`DataElement`	`setJurisdiction(List<CodeableConcept> theJurisdiction)`
`DataElement`	`setMapping(List<DataElement.DataElementMappingComponent> theMapping)`
`DataElement`	`setName(String value)`
`DataElement`	`setNameElement(StringType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`DataElement`	`setPublisher(String value)`
`DataElement`	`setPublisherElement(StringType value)`
`DataElement`	`setStatus(Enumerations.PublicationStatus value)`
`DataElement`	`setStatusElement(Enumeration<Enumerations.PublicationStatus> value)`
`DataElement`	`setStringency(DataElement.DataElementStringency value)`
`DataElement`	`setStringencyElement(Enumeration<DataElement.DataElementStringency> value)`
`DataElement`	`setTitle(String value)`
`DataElement`	`setTitleElement(StringType value)`
`DataElement`	`setUrl(String value)`
`DataElement`	`setUrlElement(UriType value)`
`DataElement`	`setUseContext(List<UsageContext> theUseContext)`
`DataElement`	`setVersion(String value)`
`DataElement`	`setVersionElement(StringType value)`
`protected DataElement`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource

checkCanUseUrl, copyValues, getDescription, getDescriptionElement, hasDescription, hasDescriptionElement, setDescription, setDescriptionElement, toString

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Field Details
- identifier
  
  protected List<Identifier> identifier
  
  A 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.
- copyright
  
  protected MarkdownType copyright
  
  A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing 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
  
  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: External identifier for 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: External identifier for the data element
  Type: token
  Path: DataElement.identifier
- 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_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_JURISDICTION
  
  public static final String SP_JURISDICTION
  
  Search parameter: jurisdiction
  Description: Intended jurisdiction for the data element
  Type: token
  Path: DataElement.jurisdiction
  
  See Also:
  
  Constant Field Values
- JURISDICTION
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
  
  Fluent Client search parameter constant for jurisdiction
  Description: Intended jurisdiction for the data element
  Type: token
  Path: DataElement.jurisdiction
- SP_NAME
  
  public static final String SP_NAME
  
  Search parameter: name
  Description: Computationally friendly 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: Computationally friendly name of the data element
  Type: string
  Path: DataElement.name
- 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_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_TITLE
  
  public static final String SP_TITLE
  
  Search parameter: title
  Description: The human-friendly name of the data element
  Type: string
  Path: DataElement.title
  
  See Also:
  
  Constant Field Values
- TITLE
  
  public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
  
  Fluent Client search parameter constant for title
  Description: The human-friendly name of the data element
  Type: string
  Path: DataElement.title
- SP_VERSION
  
  public static final String SP_VERSION
  
  Search parameter: version
  Description: The business version of the data element
  Type: token
  Path: DataElement.version
  
  See Also:
  
  Constant Field Values
- VERSION
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
  
  Fluent Client search parameter constant for version
  Description: The business version of the data element
  Type: token
  Path: DataElement.version
- SP_URL
  
  public static final String SP_URL
  
  Search parameter: url
  Description: The uri that identifies 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 uri that identifies the data element
  Type: uri
  Path: DataElement.url
- 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
Constructor Details
- DataElement
  
  public DataElement()
  
  Constructor
- DataElement
  
  public DataElement(Enumeration<Enumerations.PublicationStatus> status)
  
  Constructor
Method Details
- getUrlElement
  
  public UriType getUrlElement()
  
  Overrides:
  
  getUrlElement in class MetadataResource
  
  Returns:
  
  MetadataResource.url (An absolute URI 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. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
- hasUrlElement
  
  public boolean hasUrlElement()
  
  Overrides:
  
  hasUrlElement in class MetadataResource
- hasUrl
  
  public boolean hasUrl()
  
  Overrides:
  
  hasUrl in class MetadataResource
- setUrlElement
  
  public DataElement setUrlElement(UriType value)
  
  Overrides:
  
  setUrlElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.url (An absolute URI 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. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
- getUrl
  
  public String getUrl()
  
  Overrides:
  
  getUrl in class MetadataResource
  
  Returns:
  
  An absolute URI 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. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).
- setUrl
  
  public DataElement setUrl(String value)
  
  Overrides:
  
  setUrl in class MetadataResource
  
  Parameters:
  
  value - An absolute URI 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. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).
- getIdentifier
  
  public List<Identifier> getIdentifier()
  
  Returns:
  
  identifier (A 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<Identifier> theIdentifier)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasIdentifier
  
  public boolean hasIdentifier()
- addIdentifier
  
  public Identifier addIdentifier()
- addIdentifier
  
  public DataElement addIdentifier(Identifier t)
- getIdentifierFirstRep
  
  public Identifier getIdentifierFirstRep()
  
  Returns:
  
  The first repetition of repeating field identifier, creating it if it does not already exist
- getVersionElement
  
  public StringType getVersionElement()
  
  Overrides:
  
  getVersionElement in class MetadataResource
  
  Returns:
  
  MetadataResource.version (The identifier that is used to identify this version of the data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
- hasVersionElement
  
  public boolean hasVersionElement()
  
  Overrides:
  
  hasVersionElement in class MetadataResource
- hasVersion
  
  public boolean hasVersion()
  
  Overrides:
  
  hasVersion in class MetadataResource
- setVersionElement
  
  public DataElement setVersionElement(StringType value)
  
  Overrides:
  
  setVersionElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.version (The identifier that is used to identify this version of the data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
- getVersion
  
  public String getVersion()
  
  Overrides:
  
  getVersion in class MetadataResource
  
  Returns:
  
  The identifier that is used to identify this version of the data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- setVersion
  
  public DataElement setVersion(String value)
  
  Overrides:
  
  setVersion in class MetadataResource
  
  Parameters:
  
  value - The identifier that is used to identify this version of the data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- getStatusElement
  
  public Enumeration<Enumerations.PublicationStatus> getStatusElement()
  
  Overrides:
  
  getStatusElement in class MetadataResource
  
  Returns:
  
  MetadataResource.status (The status of this data element. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
- hasStatusElement
  
  public boolean hasStatusElement()
  
  Overrides:
  
  hasStatusElement in class MetadataResource
- hasStatus
  
  public boolean hasStatus()
  
  Overrides:
  
  hasStatus in class MetadataResource
- setStatusElement
  
  public DataElement setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
  
  Overrides:
  
  setStatusElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.status (The status of this data element. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
- getStatus
  
  public Enumerations.PublicationStatus getStatus()
  
  Overrides:
  
  getStatus in class MetadataResource
  
  Returns:
  
  The status of this data element. Enables tracking the life-cycle of the content.
- setStatus
  
  public DataElement setStatus(Enumerations.PublicationStatus value)
  
  Overrides:
  
  setStatus in class MetadataResource
  
  Parameters:
  
  value - The status of this data element. Enables tracking the life-cycle of the content.
- getExperimentalElement
  
  public BooleanType getExperimentalElement()
  
  Overrides:
  
  getExperimentalElement in class MetadataResource
  
  Returns:
  
  MetadataResource.experimental (A boolean value to indicate that this data element 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()
  
  Overrides:
  
  hasExperimentalElement in class MetadataResource
- hasExperimental
  
  public boolean hasExperimental()
  
  Overrides:
  
  hasExperimental in class MetadataResource
- setExperimentalElement
  
  public DataElement setExperimentalElement(BooleanType value)
  
  Overrides:
  
  setExperimentalElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.experimental (A boolean value to indicate that this data element 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()
  
  Overrides:
  
  getExperimental in class MetadataResource
  
  Returns:
  
  A boolean value to indicate that this data element 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)
  
  Overrides:
  
  setExperimental in class MetadataResource
  
  Parameters:
  
  value - A boolean value to indicate that this data element is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
- getDateElement
  
  public DateTimeType getDateElement()
  
  Overrides:
  
  getDateElement in class MetadataResource
  
  Returns:
  
  MetadataResource.date (The date (and optionally time) when the data element was published. The date must change if and when the business version changes 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()
  
  Overrides:
  
  hasDateElement in class MetadataResource
- hasDate
  
  public boolean hasDate()
  
  Overrides:
  
  hasDate in class MetadataResource
- setDateElement
  
  public DataElement setDateElement(DateTimeType value)
  
  Overrides:
  
  setDateElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.date (The date (and optionally time) when the data element was published. The date must change if and when the business version changes 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()
  
  Overrides:
  
  getDate in class MetadataResource
  
  Returns:
  
  The date (and optionally time) when the data element was published. The date must change if and when the business version changes 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)
  
  Overrides:
  
  setDate in class MetadataResource
  
  Parameters:
  
  value - The date (and optionally time) when the data element was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the data element changes.
- getPublisherElement
  
  public StringType getPublisherElement()
  
  Overrides:
  
  getPublisherElement in class MetadataResource
  
  Returns:
  
  MetadataResource.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()
  
  Overrides:
  
  hasPublisherElement in class MetadataResource
- hasPublisher
  
  public boolean hasPublisher()
  
  Overrides:
  
  hasPublisher in class MetadataResource
- setPublisherElement
  
  public DataElement setPublisherElement(StringType value)
  
  Overrides:
  
  setPublisherElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.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()
  
  Overrides:
  
  getPublisher in class MetadataResource
  
  Returns:
  
  The name of the individual or organization that published the data element.
- setPublisher
  
  public DataElement setPublisher(String value)
  
  Overrides:
  
  setPublisher in class MetadataResource
  
  Parameters:
  
  value - The name of the individual or organization that published the data element.
- getNameElement
  
  public StringType getNameElement()
  
  Overrides:
  
  getNameElement in class MetadataResource
  
  Returns:
  
  MetadataResource.name (A natural language name identifying the data element. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
- hasNameElement
  
  public boolean hasNameElement()
  
  Overrides:
  
  hasNameElement in class MetadataResource
- hasName
  
  public boolean hasName()
  
  Overrides:
  
  hasName in class MetadataResource
- setNameElement
  
  public DataElement setNameElement(StringType value)
  
  Overrides:
  
  setNameElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.name (A natural language name identifying the data element. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
- getName
  
  public String getName()
  
  Overrides:
  
  getName in class MetadataResource
  
  Returns:
  
  A natural language name identifying the data element. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- setName
  
  public DataElement setName(String value)
  
  Overrides:
  
  setName in class MetadataResource
  
  Parameters:
  
  value - A natural language name identifying the data element. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- getTitleElement
  
  public StringType getTitleElement()
  
  Overrides:
  
  getTitleElement in class MetadataResource
  
  Returns:
  
  MetadataResource.title (A short, descriptive, user-friendly title for the data element.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
- hasTitleElement
  
  public boolean hasTitleElement()
  
  Overrides:
  
  hasTitleElement in class MetadataResource
- hasTitle
  
  public boolean hasTitle()
  
  Overrides:
  
  hasTitle in class MetadataResource
- setTitleElement
  
  public DataElement setTitleElement(StringType value)
  
  Overrides:
  
  setTitleElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.title (A short, descriptive, user-friendly title for the data element.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
- getTitle
  
  public String getTitle()
  
  Overrides:
  
  getTitle in class MetadataResource
  
  Returns:
  
  A short, descriptive, user-friendly title for the data element.
- setTitle
  
  public DataElement setTitle(String value)
  
  Overrides:
  
  setTitle in class MetadataResource
  
  Parameters:
  
  value - A short, descriptive, user-friendly title for the data element.
- getContact
  
  public List<ContactDetail> getContact()
  
  Overrides:
  
  getContact in class MetadataResource
  
  Returns:
  
  MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)
- setContact
  
  public DataElement setContact(List<ContactDetail> theContact)
  
  Overrides:
  
  setContact in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasContact
  
  public boolean hasContact()
  
  Overrides:
  
  hasContact in class MetadataResource
- addContact
  
  public ContactDetail addContact()
  
  Overrides:
  
  addContact in class MetadataResource
- addContact
  
  public DataElement addContact(ContactDetail t)
  
  Overrides:
  
  addContact in class MetadataResource
- getContactFirstRep
  
  public ContactDetail getContactFirstRep()
  
  Overrides:
  
  getContactFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist
- getUseContext
  
  public List<UsageContext> getUseContext()
  
  Overrides:
  
  getUseContext in class MetadataResource
  
  Returns:
  
  MetadataResource.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 for appropriate data element instances.)
- setUseContext
  
  public DataElement setUseContext(List<UsageContext> theUseContext)
  
  Overrides:
  
  setUseContext in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasUseContext
  
  public boolean hasUseContext()
  
  Overrides:
  
  hasUseContext in class MetadataResource
- addUseContext
  
  public UsageContext addUseContext()
  
  Overrides:
  
  addUseContext in class MetadataResource
- addUseContext
  
  public DataElement addUseContext(UsageContext t)
  
  Overrides:
  
  addUseContext in class MetadataResource
- getUseContextFirstRep
  
  public UsageContext getUseContextFirstRep()
  
  Overrides:
  
  getUseContextFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist
- getJurisdiction
  
  public List<CodeableConcept> getJurisdiction()
  
  Overrides:
  
  getJurisdiction in class MetadataResource
  
  Returns:
  
  MetadataResource.jurisdiction (A legal or geographic region in which the data element is intended to be used.)
- setJurisdiction
  
  public DataElement setJurisdiction(List<CodeableConcept> theJurisdiction)
  
  Overrides:
  
  setJurisdiction in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasJurisdiction
  
  public boolean hasJurisdiction()
  
  Overrides:
  
  hasJurisdiction in class MetadataResource
- addJurisdiction
  
  public CodeableConcept addJurisdiction()
  
  Overrides:
  
  addJurisdiction in class MetadataResource
- addJurisdiction
  
  public DataElement addJurisdiction(CodeableConcept t)
  
  Overrides:
  
  addJurisdiction in class MetadataResource
- getJurisdictionFirstRep
  
  public CodeableConcept getJurisdictionFirstRep()
  
  Overrides:
  
  getJurisdictionFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist
- getCopyrightElement
  
  public MarkdownType getCopyrightElement()
  
  Returns:
  
  copyright (A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing 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(MarkdownType value)
  
  Parameters:
  
  value - copyright (A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing 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 data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element.
- setCopyright
  
  public DataElement setCopyright(String value)
  
  Parameters:
  
  value - A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing 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.)
- setMapping
  
  public DataElement setMapping(List<DataElement.DataElementMappingComponent> theMapping)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasMapping
  
  public boolean hasMapping()
- addMapping
  
  public DataElement.DataElementMappingComponent addMapping()
- addMapping
  
  public DataElement addMapping(DataElement.DataElementMappingComponent t)
- getMappingFirstRep
  
  public DataElement.DataElementMappingComponent getMappingFirstRep()
  
  Returns:
  
  The first repetition of repeating field mapping, creating it if it does not already exist
- getElement
  
  public List<ElementDefinition> getElement()
  
  Returns:
  
  element (Defines the structure, type, allowed values and other constraining characteristics of the data element.)
- setElement
  
  public DataElement setElement(List<ElementDefinition> theElement)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasElement
  
  public boolean hasElement()
- addElement
  
  public ElementDefinition addElement()
- addElement
  
  public DataElement addElement(ElementDefinition t)
- getElementFirstRep
  
  public ElementDefinition getElementFirstRep()
  
  Returns:
  
  The first repetition of repeating field element, creating it if it does not already exist
- listChildren
  
  protected void listChildren(List<Property> children)
  
  Overrides:
  
  listChildren in class MetadataResource
- getNamedProperty
  
  public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getNamedProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- getProperty
  
  public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- setProperty
  
  public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  setProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- setProperty
  
  public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  setProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- makeProperty
  
  public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  makeProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- getTypesForProperty
  
  public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getTypesForProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- addChild
  
  public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  addChild in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- fhirType
  
  public String fhirType()
  
  Specified by:
  
  fhirType in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  fhirType in class MetadataResource
- copy
  
  public DataElement copy()
  
  Specified by:
  
  copy in class MetadataResource
- typedCopy
  
  protected DataElement typedCopy()
- equalsDeep
  
  public boolean equalsDeep(Base other_)
  
  Overrides:
  
  equalsDeep in class MetadataResource
- equalsShallow
  
  public boolean equalsShallow(Base other_)
  
  Overrides:
  
  equalsShallow in class MetadataResource
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  isEmpty in class MetadataResource
- getResourceType
  
  public ResourceType getResourceType()
  
  Specified by:
  
  getResourceType in class Resource

Constructor	Description
`DataElement()`	Constructor
`DataElement(Enumeration<Enumerations.PublicationStatus> status)`	Constructor

Class DataElement

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Details

identifier

copyright

stringency

mapping

element

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_CODE

CODE

SP_STRINGENCY

STRINGENCY

SP_JURISDICTION

JURISDICTION

SP_NAME

NAME

SP_PUBLISHER

PUBLISHER

SP_DESCRIPTION

DESCRIPTION

SP_TITLE

TITLE

SP_VERSION

VERSION

SP_URL

URL

SP_STATUS

STATUS

Constructor Details

DataElement

DataElement

Method Details

getUrlElement

hasUrlElement

hasUrl

setUrlElement

getUrl

setUrl

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getVersionElement

hasVersionElement

hasVersion

setVersionElement

getVersion

setVersion

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getExperimentalElement

hasExperimentalElement

hasExperimental