FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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 . Page versions: R4B R4 R3 R2

Extension: birthTime

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

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/patient-birthTime

Status: draft. Extension maintained by: HL7

The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.

Context of Use: Use on element: Patient.birthDate

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1dateTimeURL = http://hl7.org/fhir/StructureDefinition/patient-birthTime
birthTime: The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Use on element: Patient.birthDate

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-birthTime
birthTime: The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Use on element: Patient.birthDate
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
... valueDateTime 0..1dateTimeValue of extension

doco Documentation for this format

XML Template

<!-- birthTime -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-birthTime" >
  <!-- from Element: extension -->
 <valueDateTime value="[dateTime]"/><!-- 0..1 Value of extension -->
</extension>

JSON Template

{ // birthTime
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-birthTime", // R! 
    "valueDateTime" : "<dateTime>" //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1dateTimeURL = http://hl7.org/fhir/StructureDefinition/patient-birthTime
birthTime: The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Use on element: Patient.birthDate

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-birthTime
birthTime: The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Use on element: Patient.birthDate
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
... valueDateTime 0..1dateTimeValue of extension

doco Documentation for this format

XML Template

<!-- birthTime -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-birthTime" >
  <!-- from Element: extension -->
 <valueDateTime value="[dateTime]"/><!-- 0..1 Value of extension -->
</extension>

JSON Template

{ // birthTime
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-birthTime", // R! 
    "valueDateTime" : "<dateTime>" //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')]))