Release 4 4B

This page is part of the FHIR Specification (v4.0.1: R4 (v4.3.0: R4B - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). ). 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 R4B R4

Extension: relevantHistory

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/request-relevantHistory

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Comment :

This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. Referenced provenances should adhere to the provenance-relevant-history profile.

Context of Use: Use on Element ID NutritionOrder or Element ID CommunicationRequest

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . relevantHistory 0..* Reference ( Provenance ) URL = http://hl7.org/fhir/StructureDefinition/request-relevantHistory
relevantHistory: Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.


Use on Element ID NutritionOrder or Element ID CommunicationRequest

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/request-relevantHistory
relevantHistory: Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.


Use on Element ID NutritionOrder or Element ID CommunicationRequest
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-relevantHistory"
. . . value[x] I 1..1 Reference ( Provenance ) Value of extension

doco Documentation for this format

XML Template 

<!-- relevantHistory -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/request-relevantHistory" >
  <!-- from Element: extension -->
 <</valueReference>

 <valueReference><!-- ?? 1..1 Reference(Provenance) Value of extension --></valueReference>

</extension>

JSON Template 

{ // relevantHistory
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/request-relevantHistory", // R! 
    "

    "valueReference" : { Reference(Provenance) } // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . relevantHistory 0..* Reference ( Provenance ) URL = http://hl7.org/fhir/StructureDefinition/request-relevantHistory
relevantHistory: Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.


Use on Element ID NutritionOrder or Element ID CommunicationRequest

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/request-relevantHistory
relevantHistory: Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.


Use on Element ID NutritionOrder or Element ID CommunicationRequest
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-relevantHistory"
. . . value[x] I 1..1 Reference ( Provenance ) Value of extension

doco Documentation for this format

XML Template 

<!-- relevantHistory -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/request-relevantHistory" >
  <!-- from Element: extension -->
 <</valueReference>

 <valueReference><!-- ?? 1..1 Reference(Provenance) Value of extension --></valueReference>

</extension>

JSON Template 

{ // relevantHistory
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/request-relevantHistory", // R! 
    "

    "valueReference" : { Reference(Provenance) } // C? R! Value of extension

  }

 

Constraints

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