Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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 R3 R2

Extension: abatement

Patient Care Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

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

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

The approximate date, age, or flag indicating that the condition of the family member resolved. The abatement should only be specified if the condition is stated in the positive sense, i.e., the didNotHave flag is false.

Context of Use: Use on Element ID FamilyMemberHistory.condition

Summary

Name	Flags	Card.	Type	Description & Constraints
abatement		0..1	date, Age, boolean	URL = http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement abatement: The approximate date, age, or flag indicating that the condition of the family member resolved. The abatement should only be specified if the condition is stated in the positive sense, i.e., the didNotHave flag is false. Use on Element ID FamilyMemberHistory.condition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement abatement: The approximate date, age, or flag indicating that the condition of the family member resolved. The abatement should only be specified if the condition is stated in the positive sense, i.e., the didNotHave flag is false. Use on Element ID FamilyMemberHistory.condition
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement"
value[x]	1..1		Value of extension
valueDate		date
valueAge		Age
valueBoolean		boolean
Documentation for this format

XML Template

<!-- abatement -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement" >
  <!-- from Element: extension -->
 <value[x]><!--  1..1 date|Age|boolean 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/familymemberhistory-abatement", // R! 
// value[x]: Value of extension. One of these 3:
    "valueDate" : "<date>" // C? R! Value of extension
    "valueAge" : { Age }, // C? R! Value of extension
    "valueBoolean" : <boolean>, // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
abatement		0..1	date, Age, boolean	URL = http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement abatement: The approximate date, age, or flag indicating that the condition of the family member resolved. The abatement should only be specified if the condition is stated in the positive sense, i.e., the didNotHave flag is false. Use on Element ID FamilyMemberHistory.condition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement abatement: The approximate date, age, or flag indicating that the condition of the family member resolved. The abatement should only be specified if the condition is stated in the positive sense, i.e., the didNotHave flag is false. Use on Element ID FamilyMemberHistory.condition
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement"
value[x]	1..1		Value of extension
valueDate		date
valueAge		Age
valueBoolean		boolean
Documentation for this format

XML Template

<!-- abatement -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement" >
  <!-- from Element: extension -->
 <value[x]><!--  1..1 date|Age|boolean 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/familymemberhistory-abatement", // R! 
// value[x]: Value of extension. One of these 3:
    "valueDate" : "<date>" // C? R! Value of extension
    "valueAge" : { Age }, // C? R! Value of extension
    "valueBoolean" : <boolean>, // 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)