FHIR IG analytics| Package | hl7.fhir.uv.xver-r4.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ext-R4-DataRequirement.sort.json |
| FHIR Version | R3 |
| Source | http://hl7.org/fhir/uv/xver-r4.r3/0.1.0/StructureDefinition-ext-R4-DataRequirement.sort.html |
| URL | http://hl7.org/fhir/4.0/StructureDefinition/extension-DataRequirement.sort |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T21:02:03.8104715+00:00 |
| Name | ExtensionDataRequirement_Sort |
| Title | R4: Order of the results (new) |
| Realm | uv |
| Authority | hl7 |
| Description | R4: `DataRequirement.sort` (new:Element) |
| Purpose | This extension is part of the cross-version definitions generated to enable use of the element `DataRequirement.sort` as defined in FHIR R4 in FHIR STU3. The source element is defined as: `DataRequirement.sort` 0..* `Element` Following are the generation technical comments: Element `DataRequirement.sort` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`. Element `DataRequirement.sort` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). |
| Type | Extension |
| Kind | complex-type |
No resources found
| ValueSet | ||
| hl7.fhir.uv.xver-r4.r3#0.1.0 | R4-sort-direction-for-R3 | Cross-version ValueSet R4.SortDirection for use in FHIR STU3 |
No extension usage examples found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ext-R4-DataRequirement.sort
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | R4: Order of the results (new) | |
  Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:path | 1..1 | Extension | R4: The name of the attribute to perform the sort (new) | |
  url | 1..1 | uri | "path" | |
  value[x] | 1..1 | string | The name of the attribute to perform the sort | |
 extension:direction | 1..1 | Extension | R4: ascending | descending (new) | |
 url | 1..1 | uri | "direction" | |
| value[x] | 1..1 | code | ascending | descending Binding: R4SortDirectionForR3 (0.1.0) (required): The possible sort directions, ascending or descending. | |
| url | 1..1 | uri | "http://hl7.org/fhir/4.0/StructureDefinition/extension-DataRequirement.sort" | |
 value[x] | 0..0 | Value of extension | ||
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "ext-R4-DataRequirement.sort",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4.r3"
},
{
"url": "version",
"valueString": "0.1.0"
},
{
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-DataRequirement.sort",
"version": "0.1.0",
"name": "ExtensionDataRequirement_Sort",
"title": "R4: Order of the results (new)",
"status": "active",
"experimental": false,
"date": "2026-03-17T21:02:03.8104715+00:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "R4: `DataRequirement.sort` (new:Element)",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `DataRequirement.sort` as defined in FHIR R4\r\nin FHIR STU3.\r\n\r\nThe source element is defined as:\r\n`DataRequirement.sort` 0..* `Element`\r\n\r\nFollowing are the generation technical comments:\r\nElement `DataRequirement.sort` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"contextType": "datatype",
"context": [
"DataRequirement"
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R4: Order of the results (new)",
"definition": "R4: `DataRequirement.sort` (new:Element)",
"comment": "Element `DataRequirement.sort` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nThis element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\". When multiple sorts are specified, they are applied in the order they appear in the resource.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 2,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:path",
"path": "Extension.extension",
"sliceName": "path",
"short": "R4: The name of the attribute to perform the sort (new)",
"definition": "R4: `DataRequirement.sort.path` (new:string)",
"comment": "Element `DataRequirement.sort.path` is part of an existing definition because parent element `DataRequirement.sort` requires a cross-version extension.\nElement `DataRequirement.sort.path` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort.path` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `DataRequirement.sort.path` is part of an existing definition because parent element `DataRequirement.sort` requires a cross-version extension.\nElement `DataRequirement.sort.path` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort.path` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:path.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:path.extension",
"path": "Extension.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional Content defined by implementations",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:path.url",
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "path",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:path.value[x]",
"path": "Extension.extension.value[x]",
"short": "The name of the attribute to perform the sort",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:direction",
"path": "Extension.extension",
"sliceName": "direction",
"short": "R4: ascending | descending (new)",
"definition": "R4: `DataRequirement.sort.direction` (new:code)",
"comment": "Element `DataRequirement.sort.direction` is part of an existing definition because parent element `DataRequirement.sort` requires a cross-version extension.\nElement `DataRequirement.sort.direction` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort.direction` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `DataRequirement.sort.direction` is part of an existing definition because parent element `DataRequirement.sort` requires a cross-version extension.\nElement `DataRequirement.sort.direction` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort.direction` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:direction.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:direction.extension",
"path": "Extension.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional Content defined by implementations",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:direction.url",
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "direction",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:direction.value[x]",
"path": "Extension.extension.value[x]",
"short": "ascending | descending",
"definition": "The direction of the sort, ascending or descending.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The possible sort directions, ascending or descending.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R4-sort-direction-for-R3|0.1.0"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/4.0/StructureDefinition/extension-DataRequirement.sort",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"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).",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "Meta"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R4: Order of the results (new)",
"definition": "R4: `DataRequirement.sort` (new:Element)",
"comment": "Element `DataRequirement.sort` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nThis element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\". When multiple sorts are specified, they are applied in the order they appear in the resource.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 2,
"max": "*",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:path",
"path": "Extension.extension",
"sliceName": "path",
"short": "R4: The name of the attribute to perform the sort (new)",
"definition": "R4: `DataRequirement.sort.path` (new:string)",
"comment": "Element `DataRequirement.sort.path` is part of an existing definition because parent element `DataRequirement.sort` requires a cross-version extension.\nElement `DataRequirement.sort.path` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort.path` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `DataRequirement.sort.path` is part of an existing definition because parent element `DataRequirement.sort` requires a cross-version extension.\nElement `DataRequirement.sort.path` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort.path` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:path.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "path"
},
{
"id": "Extension.extension:path.value[x]",
"path": "Extension.extension.value[x]",
"short": "The name of the attribute to perform the sort",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:direction",
"path": "Extension.extension",
"sliceName": "direction",
"short": "R4: ascending | descending (new)",
"definition": "R4: `DataRequirement.sort.direction` (new:code)",
"comment": "Element `DataRequirement.sort.direction` is part of an existing definition because parent element `DataRequirement.sort` requires a cross-version extension.\nElement `DataRequirement.sort.direction` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort.direction` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `DataRequirement.sort.direction` is part of an existing definition because parent element `DataRequirement.sort` requires a cross-version extension.\nElement `DataRequirement.sort.direction` has a context of DataRequirement based on following the parent source element upwards and mapping to `DataRequirement`.\nElement `DataRequirement.sort.direction` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:direction.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "direction"
},
{
"id": "Extension.extension:direction.value[x]",
"path": "Extension.extension.value[x]",
"short": "ascending | descending",
"definition": "The direction of the sort, ascending or descending.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The possible sort directions, ascending or descending.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R4-sort-direction-for-R3|0.1.0"
}
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "http://hl7.org/fhir/4.0/StructureDefinition/extension-DataRequirement.sort"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
}
}
]
}
}