{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DataType","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg"}]}],"date":"2026-03-29T21:54:20+00:00","derivation":"specialization","description":"DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.","differential":{"element":[{"definition":"Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.","id":"DataRequirement","max":"*","min":0,"path":"DataRequirement","short":"Describes a required data item"},{"binding":{"description":"List of FHIR types (resources, data types).","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"List of FHIR types (resources, data types)."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"FHIRTypes"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/fhir-types|6.0.0-ballot4"},"definition":"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.","id":"DataRequirement.type","isSummary":true,"max":"1","min":1,"path":"DataRequirement.type","short":"The type of the required data","type":[{"code":"code"}]},{"definition":"The profile of the required data, specified as the uri of the profile definition.","id":"DataRequirement.profile","isSummary":true,"max":"*","min":0,"path":"DataRequirement.profile","short":"The profile of the required data","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]}]},{"binding":{"description":"The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.)."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"SubjectType"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/participant-resource-types"},"comment":"The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.","definition":"The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.","id":"DataRequirement.subject[x]","isSummary":true,"max":"1","meaningWhenMissing":"Patient","min":0,"path":"DataRequirement.subject[x]","short":"E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device","type":[{"code":"CodeableConcept"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Group"]}]},{"definition":"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. \n\nThe value of mustSupport SHALL be a FHIRPath resolvable 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).","id":"DataRequirement.mustSupport","isSummary":true,"max":"*","min":0,"path":"DataRequirement.mustSupport","short":"Indicates specific structure elements that are referenced by the knowledge module","type":[{"code":"string"}]},{"constraint":[{"expression":"path.exists() xor searchParam.exists()","human":"Either a path or a searchParam must be provided, but not both","key":"drq-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DataRequirement"}],"definition":"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.","id":"DataRequirement.codeFilter","isSummary":true,"max":"*","min":0,"path":"DataRequirement.codeFilter","short":"What codes are expected","type":[{"code":"Element"}]},{"comment":"The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.","condition":["drq-1"],"definition":"The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.","id":"DataRequirement.codeFilter.path","isSummary":true,"max":"1","min":0,"path":"DataRequirement.codeFilter.path","short":"A code-valued attribute to filter on","type":[{"code":"string"}]},{"condition":["drq-1"],"definition":"A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.","id":"DataRequirement.codeFilter.searchParam","isSummary":true,"max":"1","min":0,"path":"DataRequirement.codeFilter.searchParam","short":"A coded (token) parameter to search on","type":[{"code":"string"}]},{"definition":"The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.","id":"DataRequirement.codeFilter.valueSet","isSummary":true,"max":"1","min":0,"path":"DataRequirement.codeFilter.valueSet","short":"ValueSet for the filter","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ValueSet"]}]},{"definition":"The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.","id":"DataRequirement.codeFilter.code","isSummary":true,"max":"*","min":0,"path":"DataRequirement.codeFilter.code","short":"What code is expected","type":[{"code":"Coding"}]},{"constraint":[{"expression":"path.exists() xor searchParam.exists()","human":"Either a path or a searchParam must be provided, but not both","key":"drq-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DataRequirement"}],"definition":"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.","id":"DataRequirement.dateFilter","isSummary":true,"max":"*","min":0,"path":"DataRequirement.dateFilter","short":"What dates/date ranges are expected","type":[{"code":"Element"}]},{"comment":"The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.","condition":["drq-2"],"definition":"The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.","id":"DataRequirement.dateFilter.path","isSummary":true,"max":"1","min":0,"path":"DataRequirement.dateFilter.path","short":"A date-valued attribute to filter on","type":[{"code":"string"}]},{"condition":["drq-2"],"definition":"A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.","id":"DataRequirement.dateFilter.searchParam","isSummary":true,"max":"1","min":0,"path":"DataRequirement.dateFilter.searchParam","short":"A date valued parameter to search on","type":[{"code":"string"}]},{"definition":"The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.","id":"DataRequirement.dateFilter.value[x]","isSummary":true,"max":"1","min":0,"path":"DataRequirement.dateFilter.value[x]","short":"The value of the filter, as a Period, DateTime, or Duration value","type":[{"code":"dateTime"},{"code":"Period"},{"code":"Duration"}]},{"definition":"Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).","id":"DataRequirement.valueFilter","isSummary":true,"max":"*","min":0,"path":"DataRequirement.valueFilter","short":"What values are expected","type":[{"code":"Element"}]},{"comment":"The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.","definition":"The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.","id":"DataRequirement.valueFilter.path","isSummary":true,"max":"1","min":0,"path":"DataRequirement.valueFilter.path","short":"An attribute to filter on","type":[{"code":"string"}]},{"definition":"A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.","id":"DataRequirement.valueFilter.searchParam","isSummary":true,"max":"1","min":0,"path":"DataRequirement.valueFilter.searchParam","short":"A parameter to search on","type":[{"code":"string"}]},{"binding":{"description":"Possible comparators for the valueFilter element.","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"Possible comparators for the valueFilter element."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ValueFilterComparator"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/value-filter-comparator|6.0.0-ballot4"},"definition":"The comparator to be used to determine whether the value is matching.","id":"DataRequirement.valueFilter.comparator","isSummary":true,"max":"1","min":0,"path":"DataRequirement.valueFilter.comparator","short":"eq | gt | lt | ge | le | sa | eb","type":[{"code":"code"}]},{"definition":"The value of the filter.","id":"DataRequirement.valueFilter.value[x]","isSummary":true,"max":"1","min":0,"path":"DataRequirement.valueFilter.value[x]","short":"The value of the filter, as a Period, DateTime, or Duration value","type":[{"code":"dateTime"},{"code":"Period"},{"code":"Duration"}]},{"comment":"This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\".","definition":"Specifies a maximum number of results that are required (uses the _count search parameter).","id":"DataRequirement.limit","isSummary":true,"max":"1","min":0,"path":"DataRequirement.limit","requirements":"Enables the requirement \"most recent 5 results\" to be expressed.","short":"Number of results","type":[{"code":"positiveInt"}]},{"comment":"This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\". When multiple sorts are specified, they are applied in the order they appear in the resource.","definition":"Specifies the order of the results to be returned.","id":"DataRequirement.sort","isSummary":true,"max":"*","min":0,"path":"DataRequirement.sort","requirements":"Enables the requirement \"most recent 5 results\" to be expressed.","short":"Order of the results","type":[{"code":"Element"}]},{"definition":"The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.","id":"DataRequirement.sort.path","isSummary":true,"max":"1","min":1,"path":"DataRequirement.sort.path","short":"The name of the attribute to perform the sort","type":[{"code":"string"}]},{"binding":{"description":"The possible sort directions, ascending or descending.","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"The possible sort directions, ascending or descending."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"SortDirection"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/sort-direction|6.0.0-ballot4"},"definition":"The direction of the sort, ascending or descending.","id":"DataRequirement.sort.direction","isSummary":true,"max":"1","min":1,"path":"DataRequirement.sort.direction","short":"ascending | descending","type":[{"code":"code"}]}]},"experimental":false,"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"}],"fhirVersion":"6.0.0-ballot4","id":"DataRequirement","jurisdiction":[{"coding":[{"code":"001","display":"World","system":"http://unstats.un.org/unsd/methods/m49/m49.htm"}]}],"kind":"complex-type","mapping":[{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"}],"name":"DataRequirement","publisher":"HL7 International / FHIR Infrastructure","resourceType":"StructureDefinition","snapshot":{"element":[{"base":{"max":"*","min":0,"path":"DataRequirement"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.","id":"DataRequirement","isModifier":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"DataRequirement","short":"Describes a required data item"},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"DataRequirement.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"DataRequirement.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"DataRequirement.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"DataRequirement.extension","short":"Additional content defined by implementations","slicing":{"description":"Extensions are always sliced by (at least) url","discriminator":[{"path":"url","type":"value"}],"rules":"open"},"type":[{"code":"Extension"}]},{"base":{"max":"1","min":1,"path":"DataRequirement.type"},"binding":{"description":"List of FHIR types (resources, data types).","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"List of FHIR types (resources, data types)."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"FHIRTypes"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/fhir-types|6.0.0-ballot4"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"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.","id":"DataRequirement.type","isModifier":false,"isSummary":true,"max":"1","min":1,"path":"DataRequirement.type","short":"The type of the required data","type":[{"code":"code"}]},{"base":{"max":"*","min":0,"path":"DataRequirement.profile"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The profile of the required data, specified as the uri of the profile definition.","id":"DataRequirement.profile","isModifier":false,"isSummary":true,"max":"*","min":0,"path":"DataRequirement.profile","short":"The profile of the required data","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]}]},{"base":{"max":"1","min":0,"path":"DataRequirement.subject[x]"},"binding":{"description":"The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.)."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"SubjectType"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSet":"http://hl7.org/fhir/ValueSet/participant-resource-types"},"comment":"The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.","id":"DataRequirement.subject[x]","isModifier":false,"isSummary":true,"max":"1","meaningWhenMissing":"Patient","min":0,"path":"DataRequirement.subject[x]","short":"E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device","type":[{"code":"CodeableConcept"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Group"]}]},{"base":{"max":"*","min":0,"path":"DataRequirement.mustSupport"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"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. \n\nThe value of mustSupport SHALL be a FHIRPath resolvable 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).","id":"DataRequirement.mustSupport","isModifier":false,"isSummary":true,"max":"*","min":0,"path":"DataRequirement.mustSupport","short":"Indicates specific structure elements that are referenced by the knowledge module","type":[{"code":"string"}]},{"base":{"max":"*","min":0,"path":"DataRequirement.codeFilter"},"constraint":[{"expression":"path.exists() xor searchParam.exists()","human":"Either a path or a searchParam must be provided, but not both","key":"drq-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DataRequirement"},{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children or both","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"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.","id":"DataRequirement.codeFilter","isModifier":false,"isSummary":true,"max":"*","min":0,"path":"DataRequirement.codeFilter","short":"What codes are expected","type":[{"code":"Element"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"DataRequirement.codeFilter.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"DataRequirement.codeFilter.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"DataRequirement.codeFilter.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"DataRequirement.codeFilter.extension","short":"Additional content defined by implementations","slicing":{"description":"Extensions are always sliced by (at least) url","discriminator":[{"path":"url","type":"value"}],"rules":"open"},"type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.codeFilter.path"},"comment":"The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.","condition":["drq-1"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.","id":"DataRequirement.codeFilter.path","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.codeFilter.path","short":"A code-valued attribute to filter on","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.codeFilter.searchParam"},"condition":["drq-1"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.","id":"DataRequirement.codeFilter.searchParam","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.codeFilter.searchParam","short":"A coded (token) parameter to search on","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.codeFilter.valueSet"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.","id":"DataRequirement.codeFilter.valueSet","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.codeFilter.valueSet","short":"ValueSet for the filter","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/ValueSet"]}]},{"base":{"max":"*","min":0,"path":"DataRequirement.codeFilter.code"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.","id":"DataRequirement.codeFilter.code","isModifier":false,"isSummary":true,"max":"*","min":0,"path":"DataRequirement.codeFilter.code","short":"What code is expected","type":[{"code":"Coding"}]},{"base":{"max":"*","min":0,"path":"DataRequirement.dateFilter"},"constraint":[{"expression":"path.exists() xor searchParam.exists()","human":"Either a path or a searchParam must be provided, but not both","key":"drq-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DataRequirement"},{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children or both","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"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.","id":"DataRequirement.dateFilter","isModifier":false,"isSummary":true,"max":"*","min":0,"path":"DataRequirement.dateFilter","short":"What dates/date ranges are expected","type":[{"code":"Element"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"DataRequirement.dateFilter.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"DataRequirement.dateFilter.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"DataRequirement.dateFilter.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"DataRequirement.dateFilter.extension","short":"Additional content defined by implementations","slicing":{"description":"Extensions are always sliced by (at least) url","discriminator":[{"path":"url","type":"value"}],"rules":"open"},"type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.dateFilter.path"},"comment":"The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.","condition":["drq-2"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.","id":"DataRequirement.dateFilter.path","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.dateFilter.path","short":"A date-valued attribute to filter on","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.dateFilter.searchParam"},"condition":["drq-2"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.","id":"DataRequirement.dateFilter.searchParam","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.dateFilter.searchParam","short":"A date valued parameter to search on","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.dateFilter.value[x]"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.","id":"DataRequirement.dateFilter.value[x]","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.dateFilter.value[x]","short":"The value of the filter, as a Period, DateTime, or Duration value","type":[{"code":"dateTime"},{"code":"Period"},{"code":"Duration"}]},{"base":{"max":"*","min":0,"path":"DataRequirement.valueFilter"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children or both","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).","id":"DataRequirement.valueFilter","isModifier":false,"isSummary":true,"max":"*","min":0,"path":"DataRequirement.valueFilter","short":"What values are expected","type":[{"code":"Element"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"DataRequirement.valueFilter.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"DataRequirement.valueFilter.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"DataRequirement.valueFilter.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"DataRequirement.valueFilter.extension","short":"Additional content defined by implementations","slicing":{"description":"Extensions are always sliced by (at least) url","discriminator":[{"path":"url","type":"value"}],"rules":"open"},"type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.valueFilter.path"},"comment":"The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.","id":"DataRequirement.valueFilter.path","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.valueFilter.path","short":"An attribute to filter on","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.valueFilter.searchParam"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.","id":"DataRequirement.valueFilter.searchParam","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.valueFilter.searchParam","short":"A parameter to search on","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.valueFilter.comparator"},"binding":{"description":"Possible comparators for the valueFilter element.","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"Possible comparators for the valueFilter element."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ValueFilterComparator"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/value-filter-comparator|6.0.0-ballot4"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The comparator to be used to determine whether the value is matching.","id":"DataRequirement.valueFilter.comparator","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.valueFilter.comparator","short":"eq | gt | lt | ge | le | sa | eb","type":[{"code":"code"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.valueFilter.value[x]"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The value of the filter.","id":"DataRequirement.valueFilter.value[x]","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.valueFilter.value[x]","short":"The value of the filter, as a Period, DateTime, or Duration value","type":[{"code":"dateTime"},{"code":"Period"},{"code":"Duration"}]},{"base":{"max":"1","min":0,"path":"DataRequirement.limit"},"comment":"This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\".","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Specifies a maximum number of results that are required (uses the _count search parameter).","id":"DataRequirement.limit","isModifier":false,"isSummary":true,"max":"1","min":0,"path":"DataRequirement.limit","requirements":"Enables the requirement \"most recent 5 results\" to be expressed.","short":"Number of results","type":[{"code":"positiveInt"}]},{"base":{"max":"*","min":0,"path":"DataRequirement.sort"},"comment":"This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\". When multiple sorts are specified, they are applied in the order they appear in the resource.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children or both","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Specifies the order of the results to be returned.","id":"DataRequirement.sort","isModifier":false,"isSummary":true,"max":"*","min":0,"path":"DataRequirement.sort","requirements":"Enables the requirement \"most recent 5 results\" to be expressed.","short":"Order of the results","type":[{"code":"Element"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"DataRequirement.sort.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"DataRequirement.sort.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"DataRequirement.sort.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"DataRequirement.sort.extension","short":"Additional content defined by implementations","slicing":{"description":"Extensions are always sliced by (at least) url","discriminator":[{"path":"url","type":"value"}],"rules":"open"},"type":[{"code":"Extension"}]},{"base":{"max":"1","min":1,"path":"DataRequirement.sort.path"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.","id":"DataRequirement.sort.path","isModifier":false,"isSummary":true,"max":"1","min":1,"path":"DataRequirement.sort.path","short":"The name of the attribute to perform the sort","type":[{"code":"string"}]},{"base":{"max":"1","min":1,"path":"DataRequirement.sort.direction"},"binding":{"description":"The possible sort directions, ascending or descending.","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"The possible sort directions, ascending or descending."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"SortDirection"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/sort-direction|6.0.0-ballot4"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The direction of the sort, ascending or descending.","id":"DataRequirement.sort.direction","isModifier":false,"isSummary":true,"max":"1","min":1,"path":"DataRequirement.sort.direction","short":"ascending | descending","type":[{"code":"code"}]}]},"status":"active","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" DataRequirementΣNElementDescribes a required data item

Elements defined in Ancestors: id, extension
\".\"\".\"\".\" typeΣ1..1codeThe type of the required data
Binding: All FHIR Types (Required)
\".\"\".\"\".\" profileΣ0..*canonical(StructureDefinition)The profile of the required data

\".\"\".\"\".\" subject[x]Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Participant Resource Types (Extensible)
\".\"\".\"\".\"\".\" subjectCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\" subjectReferenceReference(Group)
\".\"\".\"\".\" mustSupportΣ0..*stringIndicates specific structure elements that are referenced by the knowledge module

\".\"\".\"\".\" codeFilterΣC0..*ElementWhat codes are expected
+ Rule: Either a path or a searchParam must be provided, but not both

\".\"\".\"\".\"\".\" pathΣC0..1stringA code-valued attribute to filter on
\".\"\".\"\".\"\".\" searchParamΣC0..1stringA coded (token) parameter to search on
\".\"\".\"\".\"\".\" valueSetΣ0..1canonical(ValueSet)ValueSet for the filter
\".\"\".\"\".\"\".\" codeΣ0..*CodingWhat code is expected

\".\"\".\"\".\" dateFilterΣC0..*ElementWhat dates/date ranges are expected
+ Rule: Either a path or a searchParam must be provided, but not both

\".\"\".\"\".\"\".\" pathΣC0..1stringA date-valued attribute to filter on
\".\"\".\"\".\"\".\" searchParamΣC0..1stringA date valued parameter to search on
\".\"\".\"\".\"\".\" value[x]Σ0..1The value of the filter, as a Period, DateTime, or Duration value
\".\"\".\"\".\"\".\"\".\" valueDateTimedateTime
\".\"\".\"\".\"\".\"\".\" valuePeriodPeriod
\".\"\".\"\".\"\".\"\".\" valueDurationDuration
\".\"\".\"\".\" valueFilterΣ0..*ElementWhat values are expected

\".\"\".\"\".\"\".\" pathΣ0..1stringAn attribute to filter on
\".\"\".\"\".\"\".\" searchParamΣ0..1stringA parameter to search on
\".\"\".\"\".\"\".\" comparatorΣ0..1codeeq | gt | lt | ge | le | sa | eb
Binding: Value Filter Comparator (Required)
\".\"\".\"\".\"\".\" value[x]Σ0..1The value of the filter, as a Period, DateTime, or Duration value
\".\"\".\"\".\"\".\"\".\" valueDateTimedateTime
\".\"\".\"\".\"\".\"\".\" valuePeriodPeriod
\".\"\".\"\".\"\".\"\".\" valueDurationDuration
\".\"\".\"\".\" limitΣ0..1positiveIntNumber of results
\".\"\".\"\".\" sortΣ0..*ElementOrder of the results

\".\"\".\"\".\"\".\" pathΣ1..1stringThe name of the attribute to perform the sort
\".\"\".\"\".\"\".\" directionΣ1..1codeascending | descending
Binding: SortDirection (Required)

\"doco\" Documentation for this format
","status":"generated"},"type":"DataRequirement","url":"http://hl7.org/fhir/StructureDefinition/DataRequirement","version":"6.0.0-ballot4"}