FHIR Extensions Pack
5.4.0 - May 2026 International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Extended Contact Availability

Official URL: http://hl7.org/fhir/StructureDefinition/extended-contact-availability Version: 5.4.0
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Patient Administration Computable Name: ExtendedContactAvailability
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1580

The details provided in this contact may be used according to the attached availability guidelines.

Context of Use

This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 5.3.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension with the type Availability: The details provided in this contact may be used according to the attached availability guidelines.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..1 Extension Extension
    Extension.extension 0..0 Extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
    Extension.value[x] 1..1 Availability Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..1 Extension Extension
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
    Extension.value[x] 1..1 Availability Value of extension

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type Availability: The details provided in this contact may be used according to the attached availability guidelines.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..1 Extension Extension
    Extension.extension 0..0 Extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
    Extension.value[x] 1..1 Availability Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..1 Extension Extension
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
    Extension.value[x] 1..1 Availability Value of extension

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    R4B

    The extension is represented a little differently in R4B:

    • Remove the extension context ExtendedContactDetail (not for this version)
    • Replace the type Availability with a set of extensions for the content of the type along with the _datatype extension
    • Note: Extensions that have been modified for R4B are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: doco
    Extension 0..1 Extension Extension
    Extension. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension. extension:_datatype 1..1 (Complex) DataType name 'Availability' from R5
    URL: http://hl7.org/fhir/StructureDefinition/_datatype
    Extension.Slices for extension.extension:_datatype. value[x] 1.. 1 string Value of extension
    Fixed Value: Availability
    Extension.Slices for extension. extension:availableTime 0..* Extension Times the {item} is available
    Extension.Slices for extension.extension:availableTime. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:availableTime. Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:daysOfWeek 0..* Extension mon | tue | wed | thu | fri | sat | sun
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. url 1 .. 1 uri "daysOfWeek"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. value[x] 1.. 1 code Value of extension
    Binding: DaysOfWeek ( required ) : The purpose for which an extended contact detail should be used.
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:allDay 0..1 Extension Always available? i.e. 24 hour service
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. url 1 .. 1 uri "allDay"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. value[x] 1.. 1 boolean Value of extension
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:availableStartTime 0..1 Extension Opening time of day (ignored if allDay = true)
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. url 1 .. 1 uri "availableStartTime"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. value[x] 1.. 1 time Value of extension
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:availableEndTime 0..1 Extension Closing time of day (ignored if allDay = true)
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. url 1 .. 1 uri "availableEndTime"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. value[x] 1.. 1 time Value of extension
    Extension.Slices for extension.extension:availableTime. url 1 .. 1 uri "availableTime"
    Extension.Slices for extension.extension:availableTime. value[x] 0 .. 0 Value of extension
    Extension.Slices for extension. extension:notAvailableTime 0..* Extension Not available during this time due to provided reason
    Extension.Slices for extension.extension:notAvailableTime. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:notAvailableTime. Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension. extension:description 0..1 Extension Reason presented to the user explaining why time not available
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. url 1 .. 1 uri "description"
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. value[x] 1.. 1 string Value of extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension. extension:during 0..1 Extension Service not available during this period
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. url 1 .. 1 uri "during"
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. value[x] 1.. 1 Period Value of extension
    Extension.Slices for extension.extension:notAvailableTime. url 1 .. 1 uri "notAvailableTime"
    Extension.Slices for extension.extension:notAvailableTime. value[x] 0 .. 0 Value of extension
    Extension. url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
    Extension. value[x] 0 .. 0 Value of extension

    doco Documentation for this format

    R4

    The extension is represented a little differently in R4:

    • Remove the extension context ExtendedContactDetail (not for this version)
    • Replace the type Availability with a set of extensions for the content of the type along with the _datatype extension
    • Note: Extensions that have been modified for R4 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: doco
    Extension 0..1 Extension Extension
    Extension. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension. extension:_datatype 1..1 (Complex) DataType name 'Availability' from R5
    URL: http://hl7.org/fhir/StructureDefinition/_datatype
    Extension.Slices for extension.extension:_datatype. value[x] 1.. 1 string Value of extension
    Fixed Value: Availability
    Extension.Slices for extension. extension:availableTime 0..* Extension Times the {item} is available
    Extension.Slices for extension.extension:availableTime. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:availableTime. Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:daysOfWeek 0..* Extension mon | tue | wed | thu | fri | sat | sun
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. url 1 .. 1 uri "daysOfWeek"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. value[x] 1.. 1 code Value of extension
    Binding: DaysOfWeek ( required ) : The purpose for which an extended contact detail should be used.
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:allDay 0..1 Extension Always available? i.e. 24 hour service
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. url 1 .. 1 uri "allDay"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. value[x] 1.. 1 boolean Value of extension
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:availableStartTime 0..1 Extension Opening time of day (ignored if allDay = true)
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. url 1 .. 1 uri "availableStartTime"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. value[x] 1.. 1 time Value of extension
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:availableEndTime 0..1 Extension Closing time of day (ignored if allDay = true)
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. url 1 .. 1 uri "availableEndTime"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. value[x] 1.. 1 time Value of extension
    Extension.Slices for extension.extension:availableTime. url 1 .. 1 uri "availableTime"
    Extension.Slices for extension.extension:availableTime. value[x] 0 .. 0 Value of extension
    Extension.Slices for extension. extension:notAvailableTime 0..* Extension Not available during this time due to provided reason
    Extension.Slices for extension.extension:notAvailableTime. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:notAvailableTime. Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension. extension:description 0..1 Extension Reason presented to the user explaining why time not available
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. url 1 .. 1 uri "description"
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. value[x] 1.. 1 string Value of extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension. extension:during 0..1 Extension Service not available during this period
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. url 1 .. 1 uri "during"
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. value[x] 1.. 1 Period Value of extension
    Extension.Slices for extension.extension:notAvailableTime. url 1 .. 1 uri "notAvailableTime"
    Extension.Slices for extension.extension:notAvailableTime. value[x] 0 .. 0 Value of extension
    Extension. url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
    Extension. value[x] 0 .. 0 Value of extension

    doco Documentation for this format

    R3

    The extension is represented a little differently in R3:

    • Remove the extension context ExtendedContactDetail (not for this version)
    • Replace the type Availability with a set of extensions for the content of the type along with the _datatype extension
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: doco
    Extension 0..1 Extension Extension
    Extension. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension. extension:_datatype 1..1 (Complex) DataType name 'Availability' from R5
    URL: http://hl7.org/fhir/StructureDefinition/_datatype
    Extension.Slices for extension.extension:_datatype. value[x] 1.. 1 string Value of extension
    Fixed Value: Availability
    Extension.Slices for extension. extension:availableTime 0..* Extension Times the {item} is available
    Extension.Slices for extension.extension:availableTime. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:availableTime. Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:daysOfWeek 0..* Extension mon | tue | wed | thu | fri | sat | sun
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. url 1 .. 1 uri "daysOfWeek"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:daysOfWeek. value[x] 1.. 1 code Value of extension
    Binding: DaysOfWeek ( required ) : The purpose for which an extended contact detail should be used.
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:allDay 0..1 Extension Always available? i.e. 24 hour service
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. url 1 .. 1 uri "allDay"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:allDay. value[x] 1.. 1 boolean Value of extension
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:availableStartTime 0..1 Extension Opening time of day (ignored if allDay = true)
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. url 1 .. 1 uri "availableStartTime"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableStartTime. value[x] 1.. 1 time Value of extension
    Extension.Slices for extension.extension:availableTime.Slices for extension. extension:availableEndTime 0..1 Extension Closing time of day (ignored if allDay = true)
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. url 1 .. 1 uri "availableEndTime"
    Extension.Slices for extension.extension:availableTime.Slices for extension.extension:availableEndTime. value[x] 1.. 1 time Value of extension
    Extension.Slices for extension.extension:availableTime. url 1 .. 1 uri "availableTime"
    Extension.Slices for extension.extension:availableTime. value[x] 0 .. 0 Value of extension
    Extension.Slices for extension. extension:notAvailableTime 0..* Extension Not available during this time due to provided reason
    Extension.Slices for extension.extension:notAvailableTime. Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:notAvailableTime. Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension. extension:description 0..1 Extension Reason presented to the user explaining why time not available
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. url 1 .. 1 uri "description"
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:description. value[x] 1.. 1 string Value of extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension. extension:during 0..1 Extension Service not available during this period
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. extension 0 .. 0 Extension
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. url 1 .. 1 uri "during"
    Extension.Slices for extension.extension:notAvailableTime.Slices for extension.extension:during. value[x] 1.. 1 Period Value of extension
    Extension.Slices for extension.extension:notAvailableTime. url 1 .. 1 uri "notAvailableTime"
    Extension.Slices for extension.extension:notAvailableTime. value[x] 0 .. 0 Value of extension
    Extension. url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
    Extension. value[x] 0 .. 0 Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)