public class DataElement extends MetadataResource
| Modifier and Type | Class and Description |
|---|---|
static class |
DataElement.DataElementMappingComponent |
static class |
DataElement.DataElementStringency |
static class |
DataElement.DataElementStringencyEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
static 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 DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static 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 TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static 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 StringClientParam |
NAME
Fluent Client search parameter constant for name
|
static 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 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 TokenClientParam |
STRINGENCY
Fluent Client search parameter constant for stringency
|
static StringClientParam |
TITLE
Fluent Client search parameter constant for title
|
static UriClientParam |
URL
Fluent Client search parameter constant for url
|
static TokenClientParam |
VERSION
Fluent Client search parameter constant for version
|
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, versioncontained, extension, modifierExtension, textid, implicitRules, language, metaRES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
DataElement()
Constructor
|
DataElement(Enumeration<Enumerations.PublicationStatus> status)
Constructor
|
copyValues, getDescription, getDescriptionElement, hasDescription, hasDescriptionElement, setDescription, setDescriptionElement, toStringaddContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, 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, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDatagetMeta, getStructureFhirVersionEnum, setIdgetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentprotected List<Identifier> identifier
protected MarkdownType copyright
protected Enumeration<DataElement.DataElementStringency> stringency
protected List<DataElement.DataElementMappingComponent> mapping
protected List<ElementDefinition> element
public static final String SP_DATE
Description: The data element publication date
Type: date
Path: DataElement.date
public static final DateClientParam DATE
Description: The data element publication date
Type: date
Path: DataElement.date
public static final String SP_IDENTIFIER
Description: External identifier for the data element
Type: token
Path: DataElement.identifier
public static final TokenClientParam IDENTIFIER
Description: External identifier for the data element
Type: token
Path: DataElement.identifier
public static final String SP_CODE
Description: A code for the data element (server may choose to do subsumption)
Type: token
Path: DataElement.element.code
public static final TokenClientParam CODE
Description: A code for the data element (server may choose to do subsumption)
Type: token
Path: DataElement.element.code
public static final String SP_STRINGENCY
Description: The stringency of the data element definition
Type: token
Path: DataElement.stringency
public static final TokenClientParam STRINGENCY
Description: The stringency of the data element definition
Type: token
Path: DataElement.stringency
public static final String SP_JURISDICTION
Description: Intended jurisdiction for the data element
Type: token
Path: DataElement.jurisdiction
public static final TokenClientParam JURISDICTION
Description: Intended jurisdiction for the data element
Type: token
Path: DataElement.jurisdiction
public static final String SP_NAME
Description: Computationally friendly name of the data element
Type: string
Path: DataElement.name
public static final StringClientParam NAME
Description: Computationally friendly name of the data element
Type: string
Path: DataElement.name
public static final String SP_PUBLISHER
Description: Name of the publisher of the data element
Type: string
Path: DataElement.publisher
public static final StringClientParam PUBLISHER
Description: Name of the publisher of the data element
Type: string
Path: DataElement.publisher
public static final String SP_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
public static final StringClientParam 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
public static final String SP_TITLE
Description: The human-friendly name of the data element
Type: string
Path: DataElement.title
public static final StringClientParam TITLE
Description: The human-friendly name of the data element
Type: string
Path: DataElement.title
public static final String SP_VERSION
Description: The business version of the data element
Type: token
Path: DataElement.version
public static final TokenClientParam VERSION
Description: The business version of the data element
Type: token
Path: DataElement.version
public static final String SP_URL
Description: The uri that identifies the data element
Type: uri
Path: DataElement.url
public static final UriClientParam URL
Description: The uri that identifies the data element
Type: uri
Path: DataElement.url
public static final String SP_STATUS
Description: The current status of the data element
Type: token
Path: DataElement.status
public static final TokenClientParam STATUS
Description: The current status of the data element
Type: token
Path: DataElement.status
public DataElement()
public DataElement(Enumeration<Enumerations.PublicationStatus> status)
public UriType getUrlElement()
getUrlElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasUrlElement()
hasUrlElement in class MetadataResourcepublic boolean hasUrl()
hasUrl in class MetadataResourcepublic DataElement setUrlElement(UriType value)
setUrlElement in class MetadataResourcevalue - 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 valuepublic String getUrl()
getUrl in class MetadataResourcepublic DataElement setUrl(String value)
setUrl in class MetadataResourcevalue - 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).public List<Identifier> getIdentifier()
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.)public DataElement setIdentifier(List<Identifier> theIdentifier)
this for easy method chainingpublic boolean hasIdentifier()
public Identifier addIdentifier()
public DataElement addIdentifier(Identifier t)
public Identifier getIdentifierFirstRep()
identifier, creating it if it does not already existpublic StringType getVersionElement()
getVersionElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasVersionElement()
hasVersionElement in class MetadataResourcepublic boolean hasVersion()
hasVersion in class MetadataResourcepublic DataElement setVersionElement(StringType value)
setVersionElement in class MetadataResourcevalue - 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 valuepublic String getVersion()
getVersion in class MetadataResourcepublic DataElement setVersion(String value)
setVersion in class MetadataResourcevalue - 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.public Enumeration<Enumerations.PublicationStatus> getStatusElement()
getStatusElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasStatusElement()
hasStatusElement in class MetadataResourcepublic boolean hasStatus()
hasStatus in class MetadataResourcepublic DataElement setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
setStatusElement in class MetadataResourcevalue - 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 valuepublic Enumerations.PublicationStatus getStatus()
getStatus in class MetadataResourcepublic DataElement setStatus(Enumerations.PublicationStatus value)
setStatus in class MetadataResourcevalue - The status of this data element. Enables tracking the life-cycle of the content.public BooleanType getExperimentalElement()
getExperimentalElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasExperimentalElement()
hasExperimentalElement in class MetadataResourcepublic boolean hasExperimental()
hasExperimental in class MetadataResourcepublic DataElement setExperimentalElement(BooleanType value)
setExperimentalElement in class MetadataResourcevalue - 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 valuepublic boolean getExperimental()
getExperimental in class MetadataResourcepublic DataElement setExperimental(boolean value)
setExperimental in class MetadataResourcevalue - 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.public DateTimeType getDateElement()
getDateElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasDateElement()
hasDateElement in class MetadataResourcepublic boolean hasDate()
hasDate in class MetadataResourcepublic DataElement setDateElement(DateTimeType value)
setDateElement in class MetadataResourcevalue - 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 valuepublic Date getDate()
getDate in class MetadataResourcepublic DataElement setDate(Date value)
setDate in class MetadataResourcevalue - 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.public StringType getPublisherElement()
getPublisherElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasPublisherElement()
hasPublisherElement in class MetadataResourcepublic boolean hasPublisher()
hasPublisher in class MetadataResourcepublic DataElement setPublisherElement(StringType value)
setPublisherElement in class MetadataResourcevalue - 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 valuepublic String getPublisher()
getPublisher in class MetadataResourcepublic DataElement setPublisher(String value)
setPublisher in class MetadataResourcevalue - The name of the individual or organization that published the data element.public StringType getNameElement()
getNameElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasNameElement()
hasNameElement in class MetadataResourcepublic boolean hasName()
hasName in class MetadataResourcepublic DataElement setNameElement(StringType value)
setNameElement in class MetadataResourcevalue - 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 valuepublic String getName()
getName in class MetadataResourcepublic DataElement setName(String value)
setName in class MetadataResourcevalue - 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.public StringType getTitleElement()
getTitleElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasTitleElement()
hasTitleElement in class MetadataResourcepublic boolean hasTitle()
hasTitle in class MetadataResourcepublic DataElement setTitleElement(StringType value)
setTitleElement in class MetadataResourcevalue - 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 valuepublic String getTitle()
getTitle in class MetadataResourcepublic DataElement setTitle(String value)
setTitle in class MetadataResourcevalue - A short, descriptive, user-friendly title for the data element.public List<ContactDetail> getContact()
getContact in class MetadataResourceMetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)public DataElement setContact(List<ContactDetail> theContact)
setContact in class MetadataResourcethis for easy method chainingpublic boolean hasContact()
hasContact in class MetadataResourcepublic ContactDetail addContact()
addContact in class MetadataResourcepublic DataElement addContact(ContactDetail t)
addContact in class MetadataResourcepublic ContactDetail getContactFirstRep()
getContactFirstRep in class MetadataResourceMetadataResource.contact, creating it if it does not already existpublic List<UsageContext> getUseContext()
getUseContext in class MetadataResourceMetadataResource.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.)public DataElement setUseContext(List<UsageContext> theUseContext)
setUseContext in class MetadataResourcethis for easy method chainingpublic boolean hasUseContext()
hasUseContext in class MetadataResourcepublic UsageContext addUseContext()
addUseContext in class MetadataResourcepublic DataElement addUseContext(UsageContext t)
addUseContext in class MetadataResourcepublic UsageContext getUseContextFirstRep()
getUseContextFirstRep in class MetadataResourceMetadataResource.useContext, creating it if it does not already existpublic List<CodeableConcept> getJurisdiction()
getJurisdiction in class MetadataResourceMetadataResource.jurisdiction (A legal or geographic region in which the data element is intended to be used.)public DataElement setJurisdiction(List<CodeableConcept> theJurisdiction)
setJurisdiction in class MetadataResourcethis for easy method chainingpublic boolean hasJurisdiction()
hasJurisdiction in class MetadataResourcepublic CodeableConcept addJurisdiction()
addJurisdiction in class MetadataResourcepublic DataElement addJurisdiction(CodeableConcept t)
addJurisdiction in class MetadataResourcepublic CodeableConcept getJurisdictionFirstRep()
getJurisdictionFirstRep in class MetadataResourceMetadataResource.jurisdiction, creating it if it does not already existpublic MarkdownType getCopyrightElement()
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 valuepublic boolean hasCopyrightElement()
public boolean hasCopyright()
public DataElement setCopyrightElement(MarkdownType value)
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 valuepublic String getCopyright()
public DataElement setCopyright(String value)
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.public Enumeration<DataElement.DataElementStringency> getStringencyElement()
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 valuepublic boolean hasStringencyElement()
public boolean hasStringency()
public DataElement setStringencyElement(Enumeration<DataElement.DataElementStringency> value)
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 valuepublic DataElement.DataElementStringency getStringency()
public DataElement setStringency(DataElement.DataElementStringency value)
value - Identifies how precise the data element is in its definition.public List<DataElement.DataElementMappingComponent> getMapping()
mapping (Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.)public DataElement setMapping(List<DataElement.DataElementMappingComponent> theMapping)
this for easy method chainingpublic boolean hasMapping()
public DataElement.DataElementMappingComponent addMapping()
public DataElement addMapping(DataElement.DataElementMappingComponent t)
public DataElement.DataElementMappingComponent getMappingFirstRep()
mapping, creating it if it does not already existpublic List<ElementDefinition> getElement()
element (Defines the structure, type, allowed values and other constraining characteristics of the data element.)public DataElement setElement(List<ElementDefinition> theElement)
this for easy method chainingpublic boolean hasElement()
public ElementDefinition addElement()
public DataElement addElement(ElementDefinition t)
public ElementDefinition getElementFirstRep()
element, creating it if it does not already existprotected void listChildren(List<Property> childrenList)
listChildren in class MetadataResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws FHIRException
getProperty in class MetadataResourceFHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws FHIRException
setProperty in class MetadataResourceFHIRExceptionpublic Base setProperty(String name, Base value) throws FHIRException
setProperty in class MetadataResourceFHIRExceptionpublic Base makeProperty(int hash, String name) throws FHIRException
makeProperty in class MetadataResourceFHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws FHIRException
getTypesForProperty in class MetadataResourceFHIRExceptionpublic Base addChild(String name) throws FHIRException
addChild in class MetadataResourceFHIRExceptionpublic String fhirType()
fhirType in class MetadataResourcepublic DataElement copy()
copy in class MetadataResourceprotected DataElement typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class MetadataResourcepublic boolean equalsShallow(Base other)
equalsShallow in class MetadataResourcepublic boolean isEmpty()
isEmpty in interface IBaseisEmpty in class MetadataResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2017 University Health Network. All rights reserved.