FHIR Release 3 (STU) R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.5.0: R4 Ballot #2). 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: Element ID FamilyMemberHistory.condition

usage info: insert a list of places where this extension is used

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 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: Element ID FamilyMemberHistory.condition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . 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: Element ID FamilyMemberHistory.condition
. . . extension 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement" "http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement"
. . . value[x] 1..1 date , Age , boolean Value of extension

doco Documentation for this format

XML Template 

<!-- abatement -->doco

<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>" // R! Value of extension
    "valueAge" : { Age }, // R! Value of extension
    "valueBoolean" : <boolean>, // R! Value of extension
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 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: Element ID FamilyMemberHistory.condition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . 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: Element ID FamilyMemberHistory.condition
. . . extension 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement" "http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement"
. . . value[x] 1..1 date , Age , boolean Value of extension

doco Documentation for this format

XML Template 

<!-- abatement -->doco

<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>" // R! Value of extension
    "valueAge" : { Age }, // R! Value of extension
    "valueBoolean" : <boolean>, // 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')]) )