Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: abatement

Patient Care Work Group

Maturity Level: 1

Informative

Use 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

Summary

Name	Flags	Card.	Type	Description & Constraints
abatement		0..1	dateTime, Age, Period, Range, string	URL = 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
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = 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	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
value[x]	I	1..1		Value of extension
valueDateTime			dateTime
valueAge			Age
valuePeriod			Period
valueRange			Range
valueString			string
Documentation for this format

XML Template

<!-- abatement -->

<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>" // C? R! Value of extension
    "valueAge" : { Age }, // C? R! Value of extension
    "valuePeriod" : { Period }, // C? R! Value of extension
    "valueRange" : { Range }, // C? R! Value of extension
    "valueString" : "<string>", // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
abatement		0..1	dateTime, Age, Period, Range, string	URL = 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
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = 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	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
value[x]	I	1..1		Value of extension
valueDateTime			dateTime
valueAge			Age
valuePeriod			Period
valueRange			Range
valueString			string
Documentation for this format

XML Template

<!-- abatement -->

<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>" // C? R! Value of extension
    "valueAge" : { Age }, // C? R! Value of extension
    "valuePeriod" : { Period }, // C? R! Value of extension
    "valueRange" : { Range }, // C? R! Value of extension
    "valueString" : "<string>", // C? 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')]))
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)