Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.3.0: R4B - STU ). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Extension: Relative Date Criteria

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Trial Use Use Context : Any
Official URL for this extension: : http://hl7.org/fhir/StructureDefinition/relative-date Version : 5.0.0-snapshot3
draft as of 2013-12-05 Computable Name : RelativeDateCriteria
Flags : Non-Modifier OID : TBD

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure) Context of Use : Use on Element ID date or Element ID dateTime

Definition

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

Extension Content

Summary

The duration
Name Flags Card. Type Description & Constraints doco
. . Relative Date Criteria RelativeDateCriteria 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/relative-date
Relative Date Criteria: RelativeDateCriteria: 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 target 1..1 Reference ( Resource ), CodeableConcept CodeableReference () The event Event that the date(time) date is relative to. to

. . . relationship targetPath 1..1 0..1 code string Defines the relationship between Relative to which element on the event and the date.

. . . offset relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end

Binding: ActionRelationshipType ( preferred )

doco Documentation for this format

Full Structure

valueReference Reference ( Resource ) valueCodeableConcept CodeableConcept valueDate valueId valuePositiveInt valueUnsignedInt valueUrl url valueUuid uuid valueAddress CodeableConcept valueContactPoint ContactPoint valueHumanName HumanName valueIdentifier Identifier valueMoney Money valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueContributor DataRequirement valueParameterDefinition ParameterDefinition Dosage
Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/relative-date
Relative Date Criteria: RelativeDateCriteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event].


Use on Element ID date or Element ID dateTime
. . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:event extension:target 1..1 Extension Event that the date is relative to
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "event" "target"
. . . . value[x] 1..1 CodeableReference () Value of extension
. . . extension:relationship extension:targetPath 1..1 0..1 Extension before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Relative to which element on the event
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "relationship" "targetPath"
. . . . value[x] 1..1 code string Value of extension Binding: ActionRelationshipType ( required )
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "offset" "relationship"
. . . . value[x] 1..1 Duration code Value of extension url 1..1 uri "http://hl7.org/fhir/StructureDefinition/relative-date" value[x] 0 .. 0
valueBase64Binary Binding: base64Binary ActionRelationshipType valueBoolean boolean ( preferred )
. valueCanonical . canonical . extension:offset (Any) valueCode code 1..1 date Extension Duration after the event
. . . . valueDateTime dateTime id valueDecimal decimal 0..1 id valueInstant instant valueInteger integer Unique id for inter-element referencing
. valueMarkdown . . markdown . extension valueOid oid positiveInt 0..0
. . . . valueString string url valueTime time unsignedInt 1..1 valueUri uri Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept "offset"
. valueCodeableReference . . CodeableReference . value[x] valueCoding Coding 1..1 valueCount Count Value of extension
. valueDistance Distance . . . . valueDuration Duration
. valuePeriod Period . . . . valueQuantity valueRange Quantity valueRange Range
. . valueTiming Timing . url valueContactDetail ContactDetail 1..1 Contributor uri valueDataRequirement "http://hl7.org/fhir/StructureDefinition/relative-date"
. . valueExpression . value[x] Expression valueRelatedArtifact RelatedArtifact valueTriggerDefinition 0 TriggerDefinition valueUsageContext .. UsageContext valueDosage 0

doco Documentation for this format

XML Template 

<!-- Relative Date Criteria -->

<!-- RelativeDateCriteria -->doco


<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/relative-date" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <
  <
      Value of extension</value[x]>

 <extension url="target"> I 1..1 Extension  <!-- I 1..1 Event that the date is relative to -->
  <valueCodeableReference><!-- I 1..1 CodeableReference 
      Value of extension --></valueCodeableReference>

 </extension>
 <
  <

 <extension url="targetPath"> I 0..1 Extension  <!-- I 0..1 Relative to which element on the event -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->

 </extension>
 <
  <</valueDuration>

 <extension url="relationship"> I 1..1 Extension  <!-- I 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="offset"> I 1..1 Extension  <!-- I 1..1 Duration after the event -->
  <value[x]><!-- I 1..1 Duration|Range 
      Value of extension --></value[x]>

 </extension>
</extension>

JSON Template 

{ // 

{ // RelativeDateCriteria

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { //  

      { // Event that the date is relative to // I R! 

        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        " 

        "
        "

        "url" : "target", // R! 
        "valueCodeableReference" : { CodeableReference } // I R! Value of extension

      },
      { //  

      { // Relative to which element on the event // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetPath", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // I R! 

        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationship", // R! 
        "

        "valueCode" : "<code>" // I R! Value of extension

      },
      { //  

      { // Duration after the event // I R! 

        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "offset", // R! 
        "
      }

// value[x]: Value of extension. One of these 2:
        "valueDuration" : { Duration }, // I R! Value of extension
        "valueRange" : { Range }, // I R! Value of extension
      },

    ],
    " 


    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Event that the date is relative to
    "extension" : { Extension }, // IRelative to which element on the event
    "extension" : { Extension }, // I R! before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    "extension" : { Extension }, // I R! Duration after the event
    "url" : "http://hl7.org/fhir/StructureDefinition/relative-date" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

The duration
Name Flags Card. Type Description & Constraints doco
. . Relative Date Criteria RelativeDateCriteria 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/relative-date
Relative Date Criteria: RelativeDateCriteria: 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 target 1..1 Reference ( Resource ), CodeableConcept CodeableReference () The event Event that the date(time) date is relative to. to

. . . relationship targetPath 1..1 0..1 code string Defines the relationship between Relative to which element on the event and the date.

. . . offset relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end

Binding: ActionRelationshipType ( preferred )

doco Documentation for this format

Full Structure

valueReference Reference ( Resource ) valueCodeableConcept CodeableConcept valueDate valueId valuePositiveInt valueUnsignedInt valueUrl url CodeableConcept valueContactPoint ContactPoint valueHumanName HumanName valueIdentifier Identifier valueMoney Money valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueContributor DataRequirement valueParameterDefinition ParameterDefinition Dosage
Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/relative-date
Relative Date Criteria: RelativeDateCriteria: Specifies that a date is relative to some event. The event happens [Duration] after [Event].


Use on Element ID date or Element ID dateTime
. . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:event extension:target 1..1 Extension Event that the date is relative to
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "event" "target"
. . . . value[x] 1..1 CodeableReference () Value of extension
. . . extension:relationship extension:targetPath 1..1 0..1 Extension before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Relative to which element on the event
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "relationship" "targetPath"
. . . . value[x] 1..1 code string Value of extension Binding: ActionRelationshipType ( required )
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "offset" "relationship"
. . . . value[x] 1..1 Duration code Value of extension url 1..1 uri "http://hl7.org/fhir/StructureDefinition/relative-date" value[x] 0 .. 0
valueBase64Binary Binding: base64Binary ActionRelationshipType valueBoolean boolean ( preferred )
. valueCanonical . canonical . extension:offset (Any) valueCode code 1..1 date Extension Duration after the event
. . . . valueDateTime dateTime id valueDecimal decimal 0..1 id valueInstant instant valueInteger integer Unique id for inter-element referencing
. valueMarkdown . . markdown . extension valueOid oid positiveInt 0..0
. . . . valueString string url valueTime time unsignedInt 1..1 valueUri uri valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept "offset"
. valueCodeableReference . . CodeableReference . value[x] valueCoding Coding 1..1 valueCount Count Value of extension
. valueDistance Distance . . . . valueDuration Duration
. valuePeriod Period . . . . valueQuantity valueRange Quantity valueRange Range
. . valueTiming Timing . url valueContactDetail ContactDetail 1..1 Contributor uri valueDataRequirement "http://hl7.org/fhir/StructureDefinition/relative-date"
. . valueExpression . value[x] Expression valueRelatedArtifact RelatedArtifact valueTriggerDefinition 0 TriggerDefinition valueUsageContext .. UsageContext valueDosage 0

doco Documentation for this format

XML Template 

<!-- Relative Date Criteria -->

<!-- RelativeDateCriteria -->doco


<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/relative-date" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <
  <
      Value of extension</value[x]>

 <extension url="target"> I 1..1 Extension  <!-- I 1..1 Event that the date is relative to -->
  <valueCodeableReference><!-- I 1..1 CodeableReference 
      Value of extension --></valueCodeableReference>

 </extension>
 <
  <

 <extension url="targetPath"> I 0..1 Extension  <!-- I 0..1 Relative to which element on the event -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->

 </extension>
 <
  <</valueDuration>

 <extension url="relationship"> I 1..1 Extension  <!-- I 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="offset"> I 1..1 Extension  <!-- I 1..1 Duration after the event -->
  <value[x]><!-- I 1..1 Duration|Range 
      Value of extension --></value[x]>

 </extension>
</extension>

JSON Template 

{ // 

{ // RelativeDateCriteria

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { //  

      { // Event that the date is relative to // I R! 

        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        " 

        "
        "

        "url" : "target", // R! 
        "valueCodeableReference" : { CodeableReference } // I R! Value of extension

      },
      { //  

      { // Relative to which element on the event // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetPath", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end // I R! 

        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationship", // R! 
        "

        "valueCode" : "<code>" // I R! Value of extension

      },
      { //  

      { // Duration after the event // I R! 

        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "offset", // R! 
        "
      }

// value[x]: Value of extension. One of these 2:
        "valueDuration" : { Duration }, // I R! Value of extension
        "valueRange" : { Range }, // I R! Value of extension
      },

    ],
    " 


    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Event that the date is relative to
    "extension" : { Extension }, // IRelative to which element on the event
    "extension" : { Extension }, // I R! before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    "extension" : { Extension }, // I R! Duration after the event
    "url" : "http://hl7.org/fhir/StructureDefinition/relative-date" // R! 
  // value[x]: Value of extension: Prohibited
  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters hasValue() or (children().count() > id.count()) )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.