Package org.hl7.fhir.r4.model
Class DataRequirement
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
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionCode filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.protected PositiveIntType
Specifies a maximum number of results that are required (uses the _count search parameter).protected List
<StringType> 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> The profile of the required data, specified as the uri of the profile definition.protected List
<DataRequirement.DataRequirementSortComponent> Specifies the order of the results to be returned.protected Type
The intended subjects of the data requirement.protected CodeType
The type of the required data, specified as the type name of a resource. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddMustSupport
(String value) addProfile
(String value) addSort()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
int
getLimit()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getSort()
getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
hasLimit()
boolean
boolean
boolean
hasMustSupport
(String value) boolean
boolean
hasProfile
(String value) boolean
hasSort()
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCodeFilter
(List<DataRequirement.DataRequirementCodeFilterComponent> theCodeFilter) setDateFilter
(List<DataRequirement.DataRequirementDateFilterComponent> theDateFilter) setLimit
(int value) setLimitElement
(PositiveIntType value) setMustSupport
(List<StringType> theMustSupport) setProfile
(List<CanonicalType> theProfile) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setSubject
(Type value) setTypeElement
(CodeType value) protected DataRequirement
Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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 Details
-
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
The profile of the required data, specified as the uri of the profile definition. -
subject
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. -
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
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
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
Specifies a maximum number of results that are required (uses the _count search parameter). -
sort
Specifies the order of the results to be returned.
-
-
Constructor Details
-
DataRequirement
public DataRequirement()Constructor -
DataRequirement
Constructor
-
-
Method Details
-
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
-
hasType
-
setTypeElement
- 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
- 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
- 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
- Returns:
profile
(The profile of the required data, specified as the uri of the profile definition.)
-
setProfile
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProfile
-
addProfileElement
- Returns:
profile
(The profile of the required data, specified as the uri of the profile definition.)
-
addProfile
- Parameters:
value
-profile
(The profile of the required data, specified as the uri of the profile definition.)
-
hasProfile
- Parameters:
value
-profile
(The profile of the required data, specified as the uri of the profile definition.)
-
getSubject
- Returns:
subject
(The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.)
-
getSubjectCodeableConcept
- 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
-
getSubjectReference
- 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
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.)
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasMustSupport
-
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
- 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
- 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
- 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
-
addCodeFilter
-
addCodeFilter
-
getCodeFilterFirstRep
- Returns:
- The first repetition of repeating field
codeFilter
, creating it if it does not already exist
-
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
-
addDateFilter
-
addDateFilter
-
getDateFilterFirstRep
- Returns:
- The first repetition of repeating field
dateFilter
, creating it if it does not already exist
-
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
-
hasLimit
-
setLimitElement
- 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
- Returns:
- Specifies a maximum number of results that are required (uses the _count search parameter).
-
setLimit
- Parameters:
value
- Specifies a maximum number of results that are required (uses the _count search parameter).
-
getSort
- Returns:
sort
(Specifies the order of the results to be returned.)
-
setSort
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSort
-
addSort
-
addSort
-
getSortFirstRep
- Returns:
- The first repetition of repeating field
sort
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classElement
- 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 classElement
- 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 classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
-
fhirType
-
copy
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classElement
-
equalsShallow
- Overrides:
equalsShallow
in classElement
-
isEmpty
-