This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4
FHIR Infrastructure Work Group | Maturity Level: 1 | Informative | Use Context: Any |
URL for this extension:
http://hl7.org/fhir/StructureDefinition/relative-date
Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)
Specifies that a date is relative to some event. The event happens [Duration] after [Event].
Comment:
This extension is used when a precise date is not known, but rather, the date will be relative to some future event (e.g. Do this 2 weeks after an operation).
Context of Use: Use on Element ID date or Element ID dateTime
Summary
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Relative Date Criteria | 0..1 | Extension | URL = http://hl7.org/fhir/StructureDefinition/relative-date Relative Date Criteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event]. Use on Element ID date or Element ID dateTime | |
event | 1..1 | Reference(Resource), CodeableConcept | The event that the date(time) is relative to. | |
relationship | 1..1 | code | Defines the relationship between the event and the date. | |
offset | 1..1 | Duration | The duration after the event that the date(time) will happen. | |
Documentation for this format |
Full Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
extension | 0..1 | Extension | URL = http://hl7.org/fhir/StructureDefinition/relative-date Relative Date Criteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event]. Use on Element ID date or Element ID dateTime | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
extension:event | I | 1..1 | Extension | Event that the date is relative to |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "event" | |
value[x] | I | 1..1 | Value of extension | |
valueReference | Reference(Resource) | |||
valueCodeableConcept | CodeableConcept | |||
extension:relationship | I | 1..1 | Extension | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "relationship" | |
value[x] | I | 1..1 | code | Value of extension Binding: ActionRelationshipType (required) |
extension:offset | I | 1..1 | Extension | Duration after the event |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "offset" | |
value[x] | I | 1..1 | Duration | Value of extension |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/relative-date" | |
value[x] | I | 0..0 | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueInteger64 | integer64 | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
Documentation for this format |
XML Template
<!-- Relative Date Criteria --> <extension xmlns="http://hl7.org/fhir" url="http://hl7.org/fhir/StructureDefinition/relative-date" > <-- extension sliced by value:url in the specified orderOpen--> <extension url="event"> 1..1 Extension <!-- 1..1 Event that the date is relative to --> <value[x]><!-- 1..1 Reference(Resource)|CodeableConcept Value of extension --></value[x]> </extension> <extension url="relationship"> 1..1 Extension <!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end --> <valueCode value="[code]"/><!-- 1..1 Value of extension --> </extension> <extension url="offset"> 1..1 Extension <!-- 1..1 Duration after the event --> <valueDuration><!-- 1..1 Duration Value of extension --></valueDuration> </extension> </extension>
JSON Template
{ // Relative Date Criteria "extension" : [ // sliced by value:url in the specified order, Open { // Event that the date is relative to // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "event", // R! // value[x]: Value of extension. One of these 2: "valueReference" : { Reference(Resource) } // C? R! Value of extension "valueCodeableConcept" : { CodeableConcept }, // C? R! Value of extension }, { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "relationship", // R! "valueCode" : "<code>" // C? R! Value of extension }, { // Duration after the event // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "offset", // R! "valueDuration" : { Duration } // C? R! Value of extension } ], "url" : "http://hl7.org/fhir/StructureDefinition/relative-date", // R! // value[x]: Value of extension. One of these 51: }
Summary
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Relative Date Criteria | 0..1 | Extension | URL = http://hl7.org/fhir/StructureDefinition/relative-date Relative Date Criteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event]. Use on Element ID date or Element ID dateTime | |
event | 1..1 | Reference(Resource), CodeableConcept | The event that the date(time) is relative to. | |
relationship | 1..1 | code | Defines the relationship between the event and the date. | |
offset | 1..1 | Duration | The duration after the event that the date(time) will happen. | |
Documentation for this format |
Full Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
extension | 0..1 | Extension | URL = http://hl7.org/fhir/StructureDefinition/relative-date Relative Date Criteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event]. Use on Element ID date or Element ID dateTime | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
extension:event | I | 1..1 | Extension | Event that the date is relative to |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "event" | |
value[x] | I | 1..1 | Value of extension | |
valueReference | Reference(Resource) | |||
valueCodeableConcept | CodeableConcept | |||
extension:relationship | I | 1..1 | Extension | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "relationship" | |
value[x] | I | 1..1 | code | Value of extension Binding: ActionRelationshipType (required) |
extension:offset | I | 1..1 | Extension | Duration after the event |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "offset" | |
value[x] | I | 1..1 | Duration | Value of extension |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/relative-date" | |
value[x] | I | 0..0 | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueInteger64 | integer64 | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
Documentation for this format |
XML Template
<!-- Relative Date Criteria --> <extension xmlns="http://hl7.org/fhir" url="http://hl7.org/fhir/StructureDefinition/relative-date" > <-- extension sliced by value:url in the specified orderOpen--> <extension url="event"> 1..1 Extension <!-- 1..1 Event that the date is relative to --> <value[x]><!-- 1..1 Reference(Resource)|CodeableConcept Value of extension --></value[x]> </extension> <extension url="relationship"> 1..1 Extension <!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end --> <valueCode value="[code]"/><!-- 1..1 Value of extension --> </extension> <extension url="offset"> 1..1 Extension <!-- 1..1 Duration after the event --> <valueDuration><!-- 1..1 Duration Value of extension --></valueDuration> </extension> </extension>
JSON Template
{ // Relative Date Criteria "extension" : [ // sliced by value:url in the specified order, Open { // Event that the date is relative to // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "event", // R! // value[x]: Value of extension. One of these 2: "valueReference" : { Reference(Resource) } // C? R! Value of extension "valueCodeableConcept" : { CodeableConcept }, // C? R! Value of extension }, { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "relationship", // R! "valueCode" : "<code>" // C? R! Value of extension }, { // Duration after the event // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "offset", // R! "valueDuration" : { Duration } // C? R! Value of extension } ], "url" : "http://hl7.org/fhir/StructureDefinition/relative-date", // R! // value[x]: Value of extension. One of these 51: }
Constraints