DataRequirement (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.Type
    - - org.hl7.fhir.r4.model.DataRequirement

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType
```
public class DataRequirement
extends Type
implements org.hl7.fhir.instance.model.api.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`
`static class`	`DataRequirement.DataRequirementSortComponent`
`static class`	`DataRequirement.SortDirection`
`static class`	`DataRequirement.SortDirectionEnumFactory`

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 PositiveIntType`	`limit` Specifies a maximum number of results that are required (uses the _count search parameter).
`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<CanonicalType>`	`profile` The profile of the required data, specified as the uri of the profile definition.
`protected List<DataRequirement.DataRequirementSortComponent>`	`sort` Specifies the order of the results to be returned.
`protected Type`	`subject` The intended subjects of the data requirement.
`protected CodeType`	`type` The type of the required data, specified as the type name of a resource.

Fields inherited from class org.hl7.fhir.r4.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

DataRequirement()
Constructor

DataRequirement(CodeType type)
Constructor

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

Method Summary

All Methods Instance Methods Concrete Methods
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)`
`CanonicalType`	`addProfileElement()`
`DataRequirement.DataRequirementSortComponent`	`addSort()`
`DataRequirement`	`addSort(DataRequirement.DataRequirementSortComponent t)`
`DataRequirement`	`copy()`
`void`	`copyValues(DataRequirement dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<DataRequirement.DataRequirementCodeFilterComponent>`	`getCodeFilter()`
`DataRequirement.DataRequirementCodeFilterComponent`	`getCodeFilterFirstRep()`
`List<DataRequirement.DataRequirementDateFilterComponent>`	`getDateFilter()`
`DataRequirement.DataRequirementDateFilterComponent`	`getDateFilterFirstRep()`
`int`	`getLimit()`
`PositiveIntType`	`getLimitElement()`
`List<StringType>`	`getMustSupport()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<CanonicalType>`	`getProfile()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<DataRequirement.DataRequirementSortComponent>`	`getSort()`
`DataRequirement.DataRequirementSortComponent`	`getSortFirstRep()`
`Type`	`getSubject()`
`CodeableConcept`	`getSubjectCodeableConcept()`
`Reference`	`getSubjectReference()`
`String`	`getType()`
`CodeType`	`getTypeElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasCodeFilter()`
`boolean`	`hasDateFilter()`
`boolean`	`hasLimit()`
`boolean`	`hasLimitElement()`
`boolean`	`hasMustSupport()`
`boolean`	`hasMustSupport(String value)`
`boolean`	`hasProfile()`
`boolean`	`hasProfile(String value)`
`boolean`	`hasSort()`
`boolean`	`hasSubject()`
`boolean`	`hasSubjectCodeableConcept()`
`boolean`	`hasSubjectReference()`
`boolean`	`hasType()`
`boolean`	`hasTypeElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`DataRequirement`	`setCodeFilter(List<DataRequirement.DataRequirementCodeFilterComponent> theCodeFilter)`
`DataRequirement`	`setDateFilter(List<DataRequirement.DataRequirementDateFilterComponent> theDateFilter)`
`DataRequirement`	`setLimit(int value)`
`DataRequirement`	`setLimitElement(PositiveIntType value)`
`DataRequirement`	`setMustSupport(List<StringType> theMustSupport)`
`DataRequirement`	`setProfile(List<CanonicalType> theProfile)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`DataRequirement`	`setSort(List<DataRequirement.DataRequirementSortComponent> theSort)`
`DataRequirement`	`setSubject(Type value)`
`DataRequirement`	`setType(String value)`
`DataRequirement`	`setTypeElement(CodeType value)`
`protected DataRequirement`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData

- 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<CanonicalType> profile
```
    The profile of the required data, specified as the uri of the profile definition.
  - subject
```
protected Type subject
```
    The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
  - 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. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
  - 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. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
  - dateFilter
```
protected List<DataRequirement.DataRequirementDateFilterComponent> dateFilter
```
    Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
  - limit
```
protected PositiveIntType limit
```
    Specifies a maximum number of results that are required (uses the _count search parameter).
  - sort
```
protected List<DataRequirement.DataRequirementSortComponent> sort
```
    Specifies the order of the results to be returned.
- 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<CanonicalType> getProfile()
```
    Returns:
    
    profile (The profile of the required data, specified as the uri of the profile definition.)
  - setProfile
```
public DataRequirement setProfile(List<CanonicalType> theProfile)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasProfile
```
public boolean hasProfile()
```
  - addProfileElement
```
public CanonicalType 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.)
  - getSubject
```
public Type getSubject()
```
    Returns:
    
    subject (The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.)
  - getSubjectCodeableConcept
```
public CodeableConcept getSubjectCodeableConcept()
                                          throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    subject (The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasSubjectCodeableConcept
```
public boolean hasSubjectCodeableConcept()
```
  - getSubjectReference
```
public Reference getSubjectReference()
                              throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    subject (The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasSubjectReference
```
public boolean hasSubjectReference()
```
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public DataRequirement setSubject(Type value)
```
    Parameters:
    
    value - subject (The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.)
  - 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. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).)
  - 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. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).)
  - 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. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).)
  - 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. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).)
  - 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. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.)
  - 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. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.)
  - 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
  - getLimitElement
```
public PositiveIntType getLimitElement()
```
    Returns:
    
    limit (Specifies a maximum number of results that are required (uses the _count search parameter).). This is the underlying object with id, value and extensions. The accessor "getLimit" gives direct access to the value
  - hasLimitElement
```
public boolean hasLimitElement()
```
  - hasLimit
```
public boolean hasLimit()
```
  - setLimitElement
```
public DataRequirement setLimitElement(PositiveIntType value)
```
    Parameters:
    
    value - limit (Specifies a maximum number of results that are required (uses the _count search parameter).). This is the underlying object with id, value and extensions. The accessor "getLimit" gives direct access to the value
  - getLimit
```
public int getLimit()
```
    Returns:
    
    Specifies a maximum number of results that are required (uses the _count search parameter).
  - setLimit
```
public DataRequirement setLimit(int value)
```
    Parameters:
    
    value - Specifies a maximum number of results that are required (uses the _count search parameter).
  - getSort
```
public List<DataRequirement.DataRequirementSortComponent> getSort()
```
    Returns:
    
    sort (Specifies the order of the results to be returned.)
  - setSort
```
public DataRequirement setSort(List<DataRequirement.DataRequirementSortComponent> theSort)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSort
```
public boolean hasSort()
```
  - addSort
```
public DataRequirement.DataRequirementSortComponent addSort()
```
  - addSort
```
public DataRequirement addSort(DataRequirement.DataRequirementSortComponent t)
```
  - getSortFirstRep
```
public DataRequirement.DataRequirementSortComponent getSortFirstRep()
```
    Returns:
    
    The first repetition of repeating field sort, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class Element
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class Element
    
    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 Element
    
    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 Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class Element
    
    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 Element
  - copy
```
public DataRequirement copy()
```
    Overrides:
    
    copy in class Type
  - copyValues
```
public void copyValues(DataRequirement dst)
```
  - 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 org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class Element

Class DataRequirement

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

type

profile

subject

mustSupport

codeFilter

dateFilter

limit

sort

Constructor Detail

DataRequirement

DataRequirement

Method Detail

getTypeElement

hasTypeElement

hasType

setTypeElement

getType

setType

getProfile

setProfile

hasProfile

addProfileElement

addProfile

hasProfile

getSubject

getSubjectCodeableConcept

hasSubjectCodeableConcept

getSubjectReference

hasSubjectReference

hasSubject

setSubject

getMustSupport

setMustSupport

hasMustSupport

addMustSupportElement

addMustSupport

hasMustSupport

getCodeFilter

setCodeFilter

hasCodeFilter

addCodeFilter

addCodeFilter

getCodeFilterFirstRep

getDateFilter

setDateFilter

hasDateFilter

addDateFilter

addDateFilter

getDateFilterFirstRep

getLimitElement

hasLimitElement

hasLimit

setLimitElement

getLimit

setLimit

getSort

setSort

hasSort

addSort

addSort

getSortFirstRep

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty