Current Build

Extension: abatement

Patient Care Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement

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

The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.

Comment:

Age is generally used when the patient reports an age at which the allergy or intolerance abated. If there is no abatement element, the clinicalStatus can be used to convey whether allergy or intolerance has resolved or not. When abatementString exists, it conveys that the allergy or intolerance is abated.

Context of Use: Use on Element ID AllergyIntolerance

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. abatement0..1dateTime, Age, Period, Range, stringURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
abatement: The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.


Use on Element ID AllergyIntolerance

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
abatement: The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.


Use on Element ID AllergyIntolerance
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
... value[x] 1..1dateTime, Age, Period, Range, stringValue of extension

doco Documentation for this format

XML Template

<!-- abatement -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement" >
  <!-- from Element: extension -->
 <value[x]><!-- 1..1 dateTime|Age|Period|Range|string 
     Value of extension --></value[x]>
</extension>

JSON Template

{ // abatement
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement", // R! 
// value[x]: Value of extension. One of these 5:
    "valueDateTime" : "<dateTime>" // R! Value of extension
    "valueAge" : { Age }, // R! Value of extension
    "valuePeriod" : { Period }, // R! Value of extension
    "valueRange" : { Range }, // R! Value of extension
    "valueString" : "<string>", // R! Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. abatement0..1dateTime, Age, Period, Range, stringURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
abatement: The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.


Use on Element ID AllergyIntolerance

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
abatement: The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.


Use on Element ID AllergyIntolerance
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
... value[x] 1..1dateTime, Age, Period, Range, stringValue of extension

doco Documentation for this format

XML Template

<!-- abatement -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement" >
  <!-- from Element: extension -->
 <value[x]><!-- 1..1 dateTime|Age|Period|Range|string 
     Value of extension --></value[x]>
</extension>

JSON Template

{ // abatement
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement", // R! 
// value[x]: Value of extension. One of these 5:
    "valueDateTime" : "<dateTime>" // R! Value of extension
    "valueAge" : { Age }, // R! Value of extension
    "valuePeriod" : { Period }, // R! Value of extension
    "valueRange" : { Range }, // R! Value of extension
    "valueString" : "<string>", // R! Value of extension
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))