{
"description": "RelativeTime Type: RelativeTime is used to express a point in time or an interval of time relative to an event defined in data types other than dateTime.",
"_filename": "StructureDefinition-RelativeTime.json",
"package_name": "hl7.fhir.r6.examples",
"date": "2023-12-18T15:12:07+11:00",
"derivation": "specialization",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "RelativeTime",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "RelativeTime",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "rlt-1",
"human": "A RelativeTime can have either a contextReference or contextDefinition but not both",
"source": "http://hl7.org/fhir/StructureDefinition/RelativeTime",
"severity": "error",
"expression": "contextReference.empty() or contextDefinition.empty()"
}, {
"key": "rlt-2",
"human": "If RelativeTime has a contextPath, it SHALL have either a contextReference or a contextDefinition",
"source": "http://hl7.org/fhir/StructureDefinition/RelativeTime",
"severity": "error",
"expression": "contextPath.empty() or contextReference.exists() or contextDefinition.exists()"
} ],
"path": "RelativeTime",
"min": 0,
"definition": "RelativeTime is used to express a point in time or an interval of time relative to an event defined in data types other than dateTime.",
"isModifier": false,
"short": "A point in time or an interval of time relative to an event",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "*",
"id": "RelativeTime",
"base": {
"max": "*",
"min": 0,
"path": "RelativeTime"
}
}, {
"path": "RelativeTime.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "RelativeTime.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelativeTime.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RelativeTime.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelativeTime.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "RelativeTime.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneType.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelativeTime.contextReference",
"min": 0,
"definition": "The specific event occurrence or resource context used as a base point (reference point) in time. This establishes the context in which the 'path' is evaluated.",
"isModifier": false,
"short": "The specific event occurrence or resource context used as a base point (reference point) in time",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "1",
"id": "RelativeTime.contextReference",
"condition": [ "rlt-1" ],
"base": {
"max": "1",
"min": 0,
"path": "RelativeTime.contextReference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelativeTime.contextDefinition",
"min": 0,
"definition": "The type of event used as a base point. Instances of this definition will establish the context for evaluating the path to determine the base time for the offset.",
"isModifier": false,
"short": "The type of event used as a base point",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/ObservationDefinition" ]
} ],
"max": "1",
"id": "RelativeTime.contextDefinition",
"condition": [ "rlt-1" ],
"base": {
"max": "1",
"min": 0,
"path": "RelativeTime.contextDefinition"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelativeTime.contextPath",
"min": 0,
"definition": "Path to the element defining the point in time. Any valid FHIRPath expression.",
"isModifier": false,
"short": "Path to the element defining the point in time",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "RelativeTime.contextPath",
"condition": [ "rlt-2" ],
"base": {
"max": "1",
"min": 0,
"path": "RelativeTime.contextPath"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelativeTime.contextCode",
"min": 0,
"definition": "Coded representation of the event used as a base point (reference point) in time.",
"isModifier": false,
"short": "Coded representation of the event used as a base point (reference point) in time",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/evidence-variable-event",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The event used as a base point (reference point) in time."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EvidenceVariableEvent"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The event used as a base point (reference point) in time."
},
"max": "1",
"id": "RelativeTime.contextCode",
"base": {
"max": "1",
"min": 0,
"path": "RelativeTime.contextCode"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelativeTime.offset[x]",
"min": 0,
"definition": "An offset or offset range before (negative values) or after (positive values) the event. Range is limited to time-valued quantities (Durations).",
"isModifier": false,
"short": "An offset or offset range before (negative values) or after (positive values) the event",
"type": [ {
"code": "Duration"
}, {
"code": "Range"
} ],
"max": "1",
"id": "RelativeTime.offset[x]",
"base": {
"max": "1",
"min": 0,
"path": "RelativeTime.offset[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelativeTime.text",
"min": 0,
"definition": "Free-text (human-readable) description.",
"isModifier": false,
"short": "Free-text description",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "RelativeTime.text",
"base": {
"max": "1",
"min": 0,
"path": "RelativeTime.text"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "9191615e-e1d5-41e8-9e1f-6479f1707328",
"kind": "complex-type",
"url": "http://hl7.org/fhir/StructureDefinition/RelativeTime",
"version": "6.0.0-ballot1",
"differential": {
"element": [ {
"id": "RelativeTime",
"max": "*",
"min": 0,
"path": "RelativeTime",
"short": "A point in time or an interval of time relative to an event",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"constraint": [ {
"key": "rlt-2",
"human": "If RelativeTime has a contextPath, it SHALL have either a contextReference or a contextDefinition",
"source": "http://hl7.org/fhir/StructureDefinition/RelativeTime",
"severity": "error",
"expression": "contextPath.empty() or contextReference.exists() or contextDefinition.exists()"
}, {
"key": "rlt-1",
"human": "A RelativeTime can have either a contextReference or contextDefinition but not both",
"source": "http://hl7.org/fhir/StructureDefinition/RelativeTime",
"severity": "error",
"expression": "contextReference.empty() or contextDefinition.empty()"
} ],
"definition": "RelativeTime is used to express a point in time or an interval of time relative to an event defined in data types other than dateTime."
}, {
"path": "RelativeTime.contextReference",
"min": 0,
"definition": "The specific event occurrence or resource context used as a base point (reference point) in time. This establishes the context in which the 'path' is evaluated.",
"short": "The specific event occurrence or resource context used as a base point (reference point) in time",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "1",
"id": "RelativeTime.contextReference",
"condition": [ "rlt-1" ],
"isSummary": true
}, {
"path": "RelativeTime.contextDefinition",
"min": 0,
"definition": "The type of event used as a base point. Instances of this definition will establish the context for evaluating the path to determine the base time for the offset.",
"short": "The type of event used as a base point",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/ObservationDefinition" ]
} ],
"max": "1",
"id": "RelativeTime.contextDefinition",
"condition": [ "rlt-1" ],
"isSummary": true
}, {
"path": "RelativeTime.contextPath",
"min": 0,
"definition": "Path to the element defining the point in time. Any valid FHIRPath expression.",
"short": "Path to the element defining the point in time",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "RelativeTime.contextPath",
"condition": [ "rlt-2" ],
"isSummary": true
}, {
"path": "RelativeTime.contextCode",
"min": 0,
"definition": "Coded representation of the event used as a base point (reference point) in time.",
"short": "Coded representation of the event used as a base point (reference point) in time",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/evidence-variable-event",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The event used as a base point (reference point) in time."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EvidenceVariableEvent"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The event used as a base point (reference point) in time."
},
"max": "1",
"id": "RelativeTime.contextCode",
"isSummary": true
}, {
"id": "RelativeTime.offset[x]",
"max": "1",
"min": 0,
"path": "RelativeTime.offset[x]",
"type": [ {
"code": "Duration"
}, {
"code": "Range"
} ],
"short": "An offset or offset range before (negative values) or after (positive values) the event",
"isSummary": true,
"definition": "An offset or offset range before (negative values) or after (positive values) the event. Range is limited to time-valued quantities (Durations)."
}, {
"id": "RelativeTime.text",
"max": "1",
"min": 0,
"path": "RelativeTime.text",
"type": [ {
"code": "string"
} ],
"short": "Free-text description",
"isSummary": true,
"definition": "Free-text (human-readable) description."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/BackboneType"
}