Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: TimezoneCode

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: TimezoneCode

Title: Timezone Code

Modifier: This extension is not a modifier extension

Status: draft

Definition: An IANA timezone code for the timezone offset per [BCP 175](https://www.iana.org/go/rfc6557). 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.

Committee: FHIR Infrastructure Work Group

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:

These are codes like "America/New_York" or "America/Los_Angeles". See https://www.iana.org/time-zones for the official source, and https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for more information.

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

Summary

Name	Flags	Card.	Type	Description & Constraints
TimezoneCode		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/timezone TimezoneCode: 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: IANA Timezones (required): IANA Timezones (BCP 175) Use on Element ID date, Element ID dateTime, Element ID instant, Element ID Meta or Element ID time
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/timezone TimezoneCode: 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, Element ID instant, Element ID Meta or Element ID time
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/timezone"
value[x]	1..1	code	Value of extension Binding: IANA Timezones (required): IANA Timezones (BCP 175)
Documentation for this format

XML Template

<!-- TimezoneCode -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
TimezoneCode		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/timezone TimezoneCode: 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: IANA Timezones (required): IANA Timezones (BCP 175) Use on Element ID date, Element ID dateTime, Element ID instant, Element ID Meta or Element ID time
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/timezone TimezoneCode: 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, Element ID instant, Element ID Meta or Element ID time
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/timezone"
value[x]	1..1	code	Value of extension Binding: IANA Timezones (required): IANA Timezones (BCP 175)
Documentation for this format

XML Template

<!-- TimezoneCode -->

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

JSON Template

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

Search

No Search Extensions defined for this resource

Examples of this extension

HL7: Organization/hl7