org.hl7.fhir.dstu3.model

Class DataRequirement

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.model.Type

org.hl7.fhir.dstu3.model.DataRequirement

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseDatatype, IBaseElement, IBaseHasExtensions, ICompositeType

public class DataRequirement
extends Type
implements ICompositeType

Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataRequirement.DataRequirementCodeFilterComponent
static class	DataRequirement.DataRequirementDateFilterComponent

Field Summary

Fields

Modifier and Type	Field and Description
protected List<DataRequirement.DataRequirementCodeFilterComponent>	codeFilter Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.
protected List<DataRequirement.DataRequirementDateFilterComponent>	dateFilter Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.
protected List<StringType>	mustSupport Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation.
protected List<UriType>	profile The profile of the required data, specified as the uri of the profile definition.
protected CodeType	type The type of the required data, specified as the type name of a resource.

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

extension, id

Constructor Summary

Constructors

Constructor and Description
DataRequirement() Constructor
DataRequirement(CodeType type) Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
DataRequirement.DataRequirementCodeFilterComponent	addCodeFilter()
DataRequirement	addCodeFilter(DataRequirement.DataRequirementCodeFilterComponent t)
DataRequirement.DataRequirementDateFilterComponent	addDateFilter()
DataRequirement	addDateFilter(DataRequirement.DataRequirementDateFilterComponent t)
DataRequirement	addMustSupport(String value)
StringType	addMustSupportElement()
DataRequirement	addProfile(String value)
UriType	addProfileElement()
DataRequirement	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
List<DataRequirement.DataRequirementCodeFilterComponent>	getCodeFilter()
DataRequirement.DataRequirementCodeFilterComponent	getCodeFilterFirstRep()
List<DataRequirement.DataRequirementDateFilterComponent>	getDateFilter()
DataRequirement.DataRequirementDateFilterComponent	getDateFilterFirstRep()
List<StringType>	getMustSupport()
List<UriType>	getProfile()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getType()
CodeType	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCodeFilter()
boolean	hasDateFilter()
boolean	hasMustSupport()
boolean	hasMustSupport(String value)
boolean	hasProfile()
boolean	hasProfile(String value)
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
DataRequirement	setCodeFilter(List<DataRequirement.DataRequirementCodeFilterComponent> theCodeFilter)
DataRequirement	setDateFilter(List<DataRequirement.DataRequirementDateFilterComponent> theDateFilter)
DataRequirement	setMustSupport(List<StringType> theMustSupport)
DataRequirement	setProfile(List<UriType> theProfile)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DataRequirement	setType(String value)
DataRequirement	setTypeElement(CodeType value)
protected DataRequirement	typedCopy()

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

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, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, listChildrenByName, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

type

protected CodeType type

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

profile

protected List<UriType> profile

The profile of the required data, specified as the uri of the profile definition.

mustSupport

protected List<StringType> mustSupport

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.

codeFilter

protected List<DataRequirement.DataRequirementCodeFilterComponent> codeFilter

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.

dateFilter

protected List<DataRequirement.DataRequirementDateFilterComponent> dateFilter

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.

Constructor Detail

DataRequirement

public DataRequirement()

Constructor

DataRequirement

public DataRequirement(CodeType type)

Constructor

Method Detail

getTypeElement

public CodeType getTypeElement()

Returns:

type (The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public DataRequirement setTypeElement(CodeType value)

Parameters:

value - type (The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public String getType()

Returns:

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

setType

public DataRequirement setType(String value)

Parameters:

value - The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

getProfile

public List<UriType> getProfile()

Returns:

profile (The profile of the required data, specified as the uri of the profile definition.)

setProfile

public DataRequirement setProfile(List<UriType> theProfile)

Returns:

Returns a reference to this for easy method chaining

hasProfile

public boolean hasProfile()

addProfileElement

public UriType addProfileElement()

Returns:

profile (The profile of the required data, specified as the uri of the profile definition.)

addProfile

public DataRequirement addProfile(String value)

Parameters:

value - profile (The profile of the required data, specified as the uri of the profile definition.)

hasProfile

public boolean hasProfile(String value)

Parameters:

value - profile (The profile of the required data, specified as the uri of the profile definition.)

getMustSupport

public List<StringType> getMustSupport()

Returns:

mustSupport (Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.)

setMustSupport

public DataRequirement setMustSupport(List<StringType> theMustSupport)

Returns:

Returns a reference to this for easy method chaining

hasMustSupport

public boolean hasMustSupport()

addMustSupportElement

public StringType addMustSupportElement()

Returns:

mustSupport (Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.)

addMustSupport

public DataRequirement addMustSupport(String value)

Parameters:

value - mustSupport (Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.)

hasMustSupport

public boolean hasMustSupport(String value)

Parameters:

value - mustSupport (Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.)

getCodeFilter

public List<DataRequirement.DataRequirementCodeFilterComponent> getCodeFilter()

Returns:

codeFilter (Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.)

setCodeFilter

public DataRequirement setCodeFilter(List<DataRequirement.DataRequirementCodeFilterComponent> theCodeFilter)

Returns:

Returns a reference to this for easy method chaining

hasCodeFilter

public boolean hasCodeFilter()

addCodeFilter

public DataRequirement.DataRequirementCodeFilterComponent addCodeFilter()

addCodeFilter

public DataRequirement addCodeFilter(DataRequirement.DataRequirementCodeFilterComponent t)

getCodeFilterFirstRep

public DataRequirement.DataRequirementCodeFilterComponent getCodeFilterFirstRep()

Returns:

The first repetition of repeating field codeFilter, creating it if it does not already exist

getDateFilter

public List<DataRequirement.DataRequirementDateFilterComponent> getDateFilter()

Returns:

dateFilter (Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.)

setDateFilter

public DataRequirement setDateFilter(List<DataRequirement.DataRequirementDateFilterComponent> theDateFilter)

Returns:

Returns a reference to this for easy method chaining

hasDateFilter

public boolean hasDateFilter()

addDateFilter

public DataRequirement.DataRequirementDateFilterComponent addDateFilter()

addDateFilter

public DataRequirement addDateFilter(DataRequirement.DataRequirementDateFilterComponent t)

getDateFilterFirstRep

public DataRequirement.DataRequirementDateFilterComponent getDateFilterFirstRep()

Returns:

The first repetition of repeating field dateFilter, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class Element

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException

Overrides:

getProperty in class Element

Throws:

FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class Element

Throws:

FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class Element

Throws:

FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws FHIRException

Overrides:

makeProperty in class Element

Throws:

FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException

Overrides:

getTypesForProperty in class Element

Throws:

FHIRException

addChild

public Base addChild(String name)
              throws FHIRException

Overrides:

addChild in class Element

Throws:

FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class Element

copy

public DataRequirement copy()

Overrides:

copy in class Type

typedCopy

protected DataRequirement typedCopy()

Specified by:

typedCopy in class Type

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class Element