Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the ext-R4B-Library.dataRequirement extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: Optional Extension Element - found in all resources. |
| Short | R4B: dataRequirement additional typesOptional Extensions Element |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 2. Extension.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:_datatype | |
| Slice Name | _datatype |
| Definition | Slice to indicate the presence of a R4B |
| Short | DataType slice for a FHIR R4B `DataRequirement` valueAdditional Content defined by implementations |
| Control | 10..1* |
| Type | Extension |
| 6. Extension.extension:_datatype.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/_datatype |
| 8. Extension.extension:_datatype.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Comments | Must be: DataRequirement |
| Control | 10..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | DataRequirement |
| 10. Extension.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: type additional codesAdditional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 12. Extension.extension:type.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | type |
| 14. Extension.extension:type.value[x] | |
| 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The type of the required dataValue of extension |
| Control | 10..1 |
| Binding | The codes SHALL be taken from For codes, see R4BAllTypesForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-all-types-for-R3|0.1.0) |
| Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Extension.extension:profile | |
| Slice Name | profile |
| Definition | R4B: |
| Short | R4B: profileAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:profile.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | profile |
| 20. Extension.extension:profile.value[x] | |
| Definition | The profile of the required data, specified as the uri of the profile definition. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The profile of the required dataValue of extension |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Extension.extension:subject | |
| Slice Name | subject |
| Definition | R4B: |
| Short | R4B: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 24. Extension.extension:subject.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | subject |
| 26. Extension.extension:subject.value[x] | |
| Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, DeviceValue of extension |
| Comments | 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see R4BSubjectTypeForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R4B-subject-type-for-R3|0.1.0) |
| Type | Choice of: CodeableConcept, Reference(Cross-version Profile for R4B.Group for use in FHIR STU3, Group), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 28. Extension.extension:mustSupport | |
| Slice Name | mustSupport |
| Definition | R4B: |
| Short | R4B: Indicates specific structure elements that are referenced by the knowledge moduleAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 30. Extension.extension:mustSupport.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | mustSupport |
| 32. Extension.extension:mustSupport.value[x] | |
| 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. 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 for full details). Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Indicates specific structure elements that are referenced by the knowledge moduleValue of extension |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. Extension.extension:codeFilter | |
| Slice Name | codeFilter |
| Definition | R4B: |
| Short | R4B: codeFilterAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 36. Extension.extension:codeFilter.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 38. Extension.extension:codeFilter.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: A code-valued attribute to filter onAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 40. Extension.extension:codeFilter.extension:path.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | path |
| 42. Extension.extension:codeFilter.extension:path.value[x] | |
| Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable 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 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | A code-valued attribute to filter onValue of extension |
| Comments | The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 44. Extension.extension:codeFilter.extension:searchParam | |
| Slice Name | searchParam |
| Definition | R4B: |
| Short | R4B: A coded (token) parameter to search on (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 46. Extension.extension:codeFilter.extension:searchParam.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | searchParam |
| 48. Extension.extension:codeFilter.extension:searchParam.value[x] | |
| 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | A coded (token) parameter to search onValue of extension |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. Extension.extension:codeFilter.extension:valueSet | |
| Slice Name | valueSet |
| Definition | R4B: |
| Short | R4B: valueSetAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 52. Extension.extension:codeFilter.extension:valueSet.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | valueSet |
| 54. Extension.extension:codeFilter.extension:valueSet.value[x] | |
| 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Valueset for the filterValue of extension |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.ValueSet for use in FHIR STU3, ValueSet), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. Extension.extension:codeFilter.extension:code | |
| Slice Name | code |
| Definition | R4B: |
| Short | R4B: What code is expectedAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 58. Extension.extension:codeFilter.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | code |
| 60. Extension.extension:codeFilter.extension:code.value[x] | |
| 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | What code is expectedValue of extension |
| Control | 0..1 |
| Type | Coding, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 62. Extension.extension:codeFilter.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | codeFilter |
| 64. Extension.extension:codeFilter.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 66. Extension.extension:dateFilter | |
| Slice Name | dateFilter |
| Definition | R4B: |
| Short | R4B: dateFilterAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 68. Extension.extension:dateFilter.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 70. Extension.extension:dateFilter.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: A date-valued attribute to filter onAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 72. Extension.extension:dateFilter.extension:path.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | path |
| 74. Extension.extension:dateFilter.extension:path.value[x] | |
| Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable 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 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | A date-valued attribute to filter onValue of extension |
| Comments | The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation. |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 76. Extension.extension:dateFilter.extension:searchParam | |
| Slice Name | searchParam |
| Definition | R4B: |
| Short | R4B: A date valued parameter to search on (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 78. Extension.extension:dateFilter.extension:searchParam.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | searchParam |
| 80. Extension.extension:dateFilter.extension:searchParam.value[x] | |
| 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | A date valued parameter to search onValue of extension |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 82. Extension.extension:dateFilter.extension:value | |
| Slice Name | value |
| Definition | R4B: |
| Short | R4B: value additional typesAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 84. Extension.extension:dateFilter.extension:value.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | value |
| 86. Extension.extension:dateFilter.extension:value.value[x] | |
| 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The value of the filter, as a Period, DateTime, or Duration valueValue of extension |
| Control | 0..1 |
| Type | Period, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 88. Extension.extension:dateFilter.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | dateFilter |
| 90. Extension.extension:dateFilter.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 92. Extension.extension:limit | |
| Slice Name | limit |
| Definition | R4B: |
| Short | R4B: Number of results (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Enables the requirement "most recent 5 results" to be expressed. Element |
| 94. Extension.extension:limit.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | limit |
| 96. Extension.extension:limit.value[x] | |
| Definition | Specifies a maximum number of results that are required (uses the _count search parameter). Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Number of resultsValue of extension |
| Comments | 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". |
| Control | 0..1 |
| Type | positiveInt, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 98. Extension.extension:sort | |
| Slice Name | sort |
| Definition | R4B: |
| Short | R4B: Order of the results (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Enables the requirement "most recent 5 results" to be expressed. Element |
| 100. Extension.extension:sort.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 20..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 102. Extension.extension:sort.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: The name of the attribute to perform the sort (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 104. Extension.extension:sort.extension:path.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | path |
| 106. Extension.extension:sort.extension:path.value[x] | |
| 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The name of the attribute to perform the sortValue of extension |
| Control | 10..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 108. Extension.extension:sort.extension:direction | |
| Slice Name | direction |
| Definition | R4B: |
| Short | R4B: ascending | descending (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 110. Extension.extension:sort.extension:direction.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | direction |
| 112. Extension.extension:sort.extension:direction.value[x] | |
| Definition | The direction of the sort, ascending or descending. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | ascending | descendingValue of extension |
| Control | 10..1 |
| Binding | The codes SHALL be taken from For codes, see R4BSortDirectionForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-sort-direction-for-R3|0.1.0) |
| Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 114. Extension.extension:sort.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | sort |
| 116. Extension.extension:sort.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 118. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-Library.dataRequirement |
| 120. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: |
| Short | R4B: dataRequirement additional types |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| 2. Extension.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:_datatype | |
| Slice Name | _datatype |
| Definition | Slice to indicate the presence of a R4B |
| Short | DataType slice for a FHIR R4B `DataRequirement` value |
| Control | 1..1 |
| 6. Extension.extension:_datatype.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/_datatype |
| 8. Extension.extension:_datatype.value[x] | |
| Comments | Must be: DataRequirement |
| Control | 1..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | DataRequirement |
| 10. Extension.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: type additional codes |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 12. Extension.extension:type.url | |
| Control | 1..1 |
| Fixed Value | type |
| 14. Extension.extension:type.value[x] | |
| 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. |
| Short | The type of the required data |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R4BAllTypesForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-all-types-for-R3|0.1.0) |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Extension.extension:profile | |
| Slice Name | profile |
| Definition | R4B: |
| Short | R4B: profile |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 18. Extension.extension:profile.url | |
| Control | 1..1 |
| Fixed Value | profile |
| 20. Extension.extension:profile.value[x] | |
| Definition | The profile of the required data, specified as the uri of the profile definition. |
| Short | The profile of the required data |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Extension.extension:subject | |
| Slice Name | subject |
| Definition | R4B: |
| Short | R4B: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 24. Extension.extension:subject.url | |
| Control | 1..1 |
| Fixed Value | subject |
| 26. Extension.extension:subject.value[x] | |
| Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. |
| Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device |
| Comments | 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R4BSubjectTypeForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R4B-subject-type-for-R3|0.1.0) |
| Type | Choice of: CodeableConcept, Reference(Cross-version Profile for R4B.Group for use in FHIR STU3, Group) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 28. Extension.extension:mustSupport | |
| Slice Name | mustSupport |
| Definition | R4B: |
| Short | R4B: Indicates specific structure elements that are referenced by the knowledge module |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 30. Extension.extension:mustSupport.url | |
| Control | 1..1 |
| Fixed Value | mustSupport |
| 32. Extension.extension:mustSupport.value[x] | |
| 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. 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 for full details). |
| Short | Indicates specific structure elements that are referenced by the knowledge module |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. Extension.extension:codeFilter | |
| Slice Name | codeFilter |
| Definition | R4B: |
| Short | R4B: codeFilter |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 36. Extension.extension:codeFilter.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 38. Extension.extension:codeFilter.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: A code-valued attribute to filter on |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 40. Extension.extension:codeFilter.extension:path.url | |
| Control | 1..1 |
| Fixed Value | path |
| 42. Extension.extension:codeFilter.extension:path.value[x] | |
| Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable 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 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. |
| Short | A code-valued attribute to filter on |
| Comments | The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 44. Extension.extension:codeFilter.extension:searchParam | |
| Slice Name | searchParam |
| Definition | R4B: |
| Short | R4B: A coded (token) parameter to search on (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 46. Extension.extension:codeFilter.extension:searchParam.url | |
| Control | 1..1 |
| Fixed Value | searchParam |
| 48. Extension.extension:codeFilter.extension:searchParam.value[x] | |
| 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. |
| Short | A coded (token) parameter to search on |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. Extension.extension:codeFilter.extension:valueSet | |
| Slice Name | valueSet |
| Definition | R4B: |
| Short | R4B: valueSet |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 52. Extension.extension:codeFilter.extension:valueSet.url | |
| Control | 1..1 |
| Fixed Value | valueSet |
| 54. Extension.extension:codeFilter.extension:valueSet.value[x] | |
| 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. |
| Short | Valueset for the filter |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.ValueSet for use in FHIR STU3, ValueSet) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. Extension.extension:codeFilter.extension:code | |
| Slice Name | code |
| Definition | R4B: |
| Short | R4B: What code is expected |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 58. Extension.extension:codeFilter.extension:code.url | |
| Control | 1..1 |
| Fixed Value | code |
| 60. Extension.extension:codeFilter.extension:code.value[x] | |
| 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. |
| Short | What code is expected |
| Control | 0..1 |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 62. Extension.extension:codeFilter.url | |
| Control | 1..1 |
| Fixed Value | codeFilter |
| 64. Extension.extension:codeFilter.value[x] | |
| Control | 0..0 |
| 66. Extension.extension:dateFilter | |
| Slice Name | dateFilter |
| Definition | R4B: |
| Short | R4B: dateFilter |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 68. Extension.extension:dateFilter.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 70. Extension.extension:dateFilter.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: A date-valued attribute to filter on |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 72. Extension.extension:dateFilter.extension:path.url | |
| Control | 1..1 |
| Fixed Value | path |
| 74. Extension.extension:dateFilter.extension:path.value[x] | |
| Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable 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 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. |
| Short | A date-valued attribute to filter on |
| Comments | The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation. |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 76. Extension.extension:dateFilter.extension:searchParam | |
| Slice Name | searchParam |
| Definition | R4B: |
| Short | R4B: A date valued parameter to search on (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 78. Extension.extension:dateFilter.extension:searchParam.url | |
| Control | 1..1 |
| Fixed Value | searchParam |
| 80. Extension.extension:dateFilter.extension:searchParam.value[x] | |
| 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. |
| Short | A date valued parameter to search on |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 82. Extension.extension:dateFilter.extension:value | |
| Slice Name | value |
| Definition | R4B: |
| Short | R4B: value additional types |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 84. Extension.extension:dateFilter.extension:value.url | |
| Control | 1..1 |
| Fixed Value | value |
| 86. Extension.extension:dateFilter.extension:value.value[x] | |
| 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. |
| Short | The value of the filter, as a Period, DateTime, or Duration value |
| Control | 0..1 |
| Type | Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 88. Extension.extension:dateFilter.url | |
| Control | 1..1 |
| Fixed Value | dateFilter |
| 90. Extension.extension:dateFilter.value[x] | |
| Control | 0..0 |
| 92. Extension.extension:limit | |
| Slice Name | limit |
| Definition | R4B: |
| Short | R4B: Number of results (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Enables the requirement "most recent 5 results" to be expressed. Element |
| 94. Extension.extension:limit.url | |
| Control | 1..1 |
| Fixed Value | limit |
| 96. Extension.extension:limit.value[x] | |
| Definition | Specifies a maximum number of results that are required (uses the _count search parameter). |
| Short | Number of results |
| Comments | 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". |
| Control | 0..1 |
| Type | positiveInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 98. Extension.extension:sort | |
| Slice Name | sort |
| Definition | R4B: |
| Short | R4B: Order of the results (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Enables the requirement "most recent 5 results" to be expressed. Element |
| 100. Extension.extension:sort.extension | |
| Control | 2..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 102. Extension.extension:sort.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: The name of the attribute to perform the sort (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 104. Extension.extension:sort.extension:path.url | |
| Control | 1..1 |
| Fixed Value | path |
| 106. Extension.extension:sort.extension:path.value[x] | |
| 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. |
| Short | The name of the attribute to perform the sort |
| Control | 1..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 108. Extension.extension:sort.extension:direction | |
| Slice Name | direction |
| Definition | R4B: |
| Short | R4B: ascending | descending (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 110. Extension.extension:sort.extension:direction.url | |
| Control | 1..1 |
| Fixed Value | direction |
| 112. Extension.extension:sort.extension:direction.value[x] | |
| Definition | The direction of the sort, ascending or descending. |
| Short | ascending | descending |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R4BSortDirectionForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-sort-direction-for-R3|0.1.0) |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 114. Extension.extension:sort.url | |
| Control | 1..1 |
| Fixed Value | sort |
| 116. Extension.extension:sort.value[x] | |
| Control | 0..0 |
| 118. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-Library.dataRequirement |
| 120. Extension.value[x] | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: |
| Short | R4B: dataRequirement additional types |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 2. Extension.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.extension:_datatype | |
| Slice Name | _datatype |
| Definition | Slice to indicate the presence of a R4B |
| Short | DataType slice for a FHIR R4B `DataRequirement` value |
| Control | 1..1 |
| Type | Extension |
| 8. Extension.extension:_datatype.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 10. Extension.extension:_datatype.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Extension.extension:_datatype.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/_datatype |
| 14. Extension.extension:_datatype.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Comments | Must be: DataRequirement |
| Control | 1..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | DataRequirement |
| 16. Extension.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: type additional codes |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:type.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 20. Extension.extension:type.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.extension:type.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | type |
| 24. Extension.extension:type.value[x] | |
| 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. |
| Short | The type of the required data |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R4BAllTypesForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-all-types-for-R3|0.1.0) |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. Extension.extension:profile | |
| Slice Name | profile |
| Definition | R4B: |
| Short | R4B: profile |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 28. Extension.extension:profile.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 30. Extension.extension:profile.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. Extension.extension:profile.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | profile |
| 34. Extension.extension:profile.value[x] | |
| Definition | The profile of the required data, specified as the uri of the profile definition. |
| Short | The profile of the required data |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. Extension.extension:subject | |
| Slice Name | subject |
| Definition | R4B: |
| Short | R4B: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 38. Extension.extension:subject.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 40. Extension.extension:subject.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. Extension.extension:subject.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | subject |
| 44. Extension.extension:subject.value[x] | |
| Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. |
| Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device |
| Comments | 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R4BSubjectTypeForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R4B-subject-type-for-R3|0.1.0) |
| Type | Choice of: CodeableConcept, Reference(Cross-version Profile for R4B.Group for use in FHIR STU3, Group) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 46. Extension.extension:mustSupport | |
| Slice Name | mustSupport |
| Definition | R4B: |
| Short | R4B: Indicates specific structure elements that are referenced by the knowledge module |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 48. Extension.extension:mustSupport.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 50. Extension.extension:mustSupport.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. Extension.extension:mustSupport.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | mustSupport |
| 54. Extension.extension:mustSupport.value[x] | |
| 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. 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 for full details). |
| Short | Indicates specific structure elements that are referenced by the knowledge module |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. Extension.extension:codeFilter | |
| Slice Name | codeFilter |
| Definition | R4B: |
| Short | R4B: codeFilter |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 58. Extension.extension:codeFilter.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 60. Extension.extension:codeFilter.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. Extension.extension:codeFilter.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: A code-valued attribute to filter on |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 64. Extension.extension:codeFilter.extension:path.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 66. Extension.extension:codeFilter.extension:path.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. Extension.extension:codeFilter.extension:path.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | path |
| 70. Extension.extension:codeFilter.extension:path.value[x] | |
| Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable 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 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. |
| Short | A code-valued attribute to filter on |
| Comments | The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 72. Extension.extension:codeFilter.extension:searchParam | |
| Slice Name | searchParam |
| Definition | R4B: |
| Short | R4B: A coded (token) parameter to search on (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 74. Extension.extension:codeFilter.extension:searchParam.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 76. Extension.extension:codeFilter.extension:searchParam.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 78. Extension.extension:codeFilter.extension:searchParam.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | searchParam |
| 80. Extension.extension:codeFilter.extension:searchParam.value[x] | |
| 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. |
| Short | A coded (token) parameter to search on |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 82. Extension.extension:codeFilter.extension:valueSet | |
| Slice Name | valueSet |
| Definition | R4B: |
| Short | R4B: valueSet |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 84. Extension.extension:codeFilter.extension:valueSet.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 86. Extension.extension:codeFilter.extension:valueSet.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 88. Extension.extension:codeFilter.extension:valueSet.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | valueSet |
| 90. Extension.extension:codeFilter.extension:valueSet.value[x] | |
| 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. |
| Short | Valueset for the filter |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.ValueSet for use in FHIR STU3, ValueSet) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 92. Extension.extension:codeFilter.extension:code | |
| Slice Name | code |
| Definition | R4B: |
| Short | R4B: What code is expected |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 94. Extension.extension:codeFilter.extension:code.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 96. Extension.extension:codeFilter.extension:code.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 98. Extension.extension:codeFilter.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | code |
| 100. Extension.extension:codeFilter.extension:code.value[x] | |
| 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. |
| Short | What code is expected |
| Control | 0..1 |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 102. Extension.extension:codeFilter.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | codeFilter |
| 104. Extension.extension:codeFilter.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 106. Extension.extension:dateFilter | |
| Slice Name | dateFilter |
| Definition | R4B: |
| Short | R4B: dateFilter |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 108. Extension.extension:dateFilter.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 110. Extension.extension:dateFilter.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 112. Extension.extension:dateFilter.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: A date-valued attribute to filter on |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 114. Extension.extension:dateFilter.extension:path.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 116. Extension.extension:dateFilter.extension:path.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 118. Extension.extension:dateFilter.extension:path.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | path |
| 120. Extension.extension:dateFilter.extension:path.value[x] | |
| Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable 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 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. |
| Short | A date-valued attribute to filter on |
| Comments | The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation. |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 122. Extension.extension:dateFilter.extension:searchParam | |
| Slice Name | searchParam |
| Definition | R4B: |
| Short | R4B: A date valued parameter to search on (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 124. Extension.extension:dateFilter.extension:searchParam.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 126. Extension.extension:dateFilter.extension:searchParam.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 128. Extension.extension:dateFilter.extension:searchParam.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | searchParam |
| 130. Extension.extension:dateFilter.extension:searchParam.value[x] | |
| 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. |
| Short | A date valued parameter to search on |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 132. Extension.extension:dateFilter.extension:value | |
| Slice Name | value |
| Definition | R4B: |
| Short | R4B: value additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 134. Extension.extension:dateFilter.extension:value.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 136. Extension.extension:dateFilter.extension:value.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 138. Extension.extension:dateFilter.extension:value.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | value |
| 140. Extension.extension:dateFilter.extension:value.value[x] | |
| 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. |
| Short | The value of the filter, as a Period, DateTime, or Duration value |
| Control | 0..1 |
| Type | Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 142. Extension.extension:dateFilter.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | dateFilter |
| 144. Extension.extension:dateFilter.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 146. Extension.extension:limit | |
| Slice Name | limit |
| Definition | R4B: |
| Short | R4B: Number of results (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Enables the requirement "most recent 5 results" to be expressed. Element |
| 148. Extension.extension:limit.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 150. Extension.extension:limit.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 152. Extension.extension:limit.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | limit |
| 154. Extension.extension:limit.value[x] | |
| Definition | Specifies a maximum number of results that are required (uses the _count search parameter). |
| Short | Number of results |
| Comments | 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". |
| Control | 0..1 |
| Type | positiveInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 156. Extension.extension:sort | |
| Slice Name | sort |
| Definition | R4B: |
| Short | R4B: Order of the results (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Enables the requirement "most recent 5 results" to be expressed. Element |
| 158. Extension.extension:sort.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 160. Extension.extension:sort.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 2..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 162. Extension.extension:sort.extension:path | |
| Slice Name | path |
| Definition | R4B: |
| Short | R4B: The name of the attribute to perform the sort (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 164. Extension.extension:sort.extension:path.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 166. Extension.extension:sort.extension:path.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 168. Extension.extension:sort.extension:path.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | path |
| 170. Extension.extension:sort.extension:path.value[x] | |
| 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. |
| Short | The name of the attribute to perform the sort |
| Control | 1..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 172. Extension.extension:sort.extension:direction | |
| Slice Name | direction |
| Definition | R4B: |
| Short | R4B: ascending | descending (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 174. Extension.extension:sort.extension:direction.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 176. Extension.extension:sort.extension:direction.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 178. Extension.extension:sort.extension:direction.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | direction |
| 180. Extension.extension:sort.extension:direction.value[x] | |
| Definition | The direction of the sort, ascending or descending. |
| Short | ascending | descending |
| Control | 1..1 |
| Binding | The codes SHALL be taken from R4BSortDirectionForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R4B-sort-direction-for-R3|0.1.0) |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 182. Extension.extension:sort.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | sort |
| 184. Extension.extension:sort.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 186. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-Library.dataRequirement |
| 188. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r4b.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change