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 . Page versions: R4B R4 R3 R2

Extension: birthTime

Patient Administration Work Group

Maturity Level: 1

Informative

Use 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 ID Patient.birthDate

Summary

Name	Flags	Card.	Type	Description & Constraints
birthTime		0..1	dateTime	URL = 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 ID Patient.birthDate
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = 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 ID Patient.birthDate
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	I	1..1	dateTime	Value of extension
Documentation for this format

XML Template

<!-- birthTime -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
birthTime		0..1	dateTime	URL = 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 ID Patient.birthDate
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = 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 ID Patient.birthDate
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	I	1..1	dateTime	Value of extension
Documentation for this format

XML Template

<!-- birthTime -->

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

JSON Template

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