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

Extension: Timezone Code

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/timezone

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

An IANA timezone code for the timezone offset per BCP 175. The offset is specified as part of a dateTime/instant (or using the tzOffset extension on a date if necessary). The timezone code may also be provided to allow for human display of the location associated with the offset.

Comment:

See https://www.iana.org/time-zones.

Context of Use: Use on Element ID date, Element ID dateTime or Element ID instant

Summary

Name	Flags	Card.	Type	Description & Constraints
Timezone Code		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/timezone Timezone Code: An IANA timezone code for the timezone offset per BCP 175. The offset is specified as part of a dateTime/instant (or using the tzOffset extension on a date if necessary). The timezone code may also be provided to allow for human display of the location associated with the offset. Binding: I a n a timezones (required): IANA Timezones (BCP 175) Use on Element ID date, Element ID dateTime or Element ID instant
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/timezone Timezone Code: An IANA timezone code for the timezone offset per BCP 175. The offset is specified as part of a dateTime/instant (or using the tzOffset extension on a date if necessary). The timezone code may also be provided to allow for human display of the location associated with the offset. Use on Element ID date, Element ID dateTime or Element ID instant
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/timezone"
value[x]	1..1	code	Value of extension Binding: I a n a timezones (required): IANA Timezones (BCP 175)
Documentation for this format

XML Template

<!-- Timezone Code -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/timezone" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // Timezone Code
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/timezone", // R! 
    "valueCode" : "<code>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
Timezone Code		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/timezone Timezone Code: An IANA timezone code for the timezone offset per BCP 175. The offset is specified as part of a dateTime/instant (or using the tzOffset extension on a date if necessary). The timezone code may also be provided to allow for human display of the location associated with the offset. Binding: I a n a timezones (required): IANA Timezones (BCP 175) Use on Element ID date, Element ID dateTime or Element ID instant
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/timezone Timezone Code: An IANA timezone code for the timezone offset per BCP 175. The offset is specified as part of a dateTime/instant (or using the tzOffset extension on a date if necessary). The timezone code may also be provided to allow for human display of the location associated with the offset. Use on Element ID date, Element ID dateTime or Element ID instant
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/timezone"
value[x]	1..1	code	Value of extension Binding: I a n a timezones (required): IANA Timezones (BCP 175)
Documentation for this format

XML Template

<!-- Timezone Code -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/timezone" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

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