FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Extension: Extended Contact Availability

Official URL: http://hl7.org/fhir/StructureDefinition/extended-contact-availability				Version: 5.2.0-ballot
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):

• Element ID: ExtendedContactDetail
• Element ID: ContactDetail
• Element ID: Address

Usage info

Usage:

• Examples for this Extension: HL7 itself

Formal Views of Extension Content

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

 

Other representations of profile: CSV, Excel, Schematron

Constraints

Id	Grade	Path(s)	Details	Requirements
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
• 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
Extension		0..1	Extension	Extension
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:_datatype		1..1	(Complex)	DataType name 'Availability' from R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype
value[x]		1.. 1	string	Value of extension Fixed Value: Availability
extension:availableTime		0..*	Extension	Times the {item} is available
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:daysOfWeek		0..*	Extension	mon | tue | wed | thu | fri | sat | sun
extension		0 .. 0
url		1 .. 1	uri	"daysOfWeek"
value[x]		1.. 1	code	Value of extension Binding: DaysOfWeek ( required ): The purpose for which an extended contact detail should be used.
extension:allDay		0..1	Extension	Always available? i.e. 24 hour service
extension		0 .. 0
url		1 .. 1	uri	"allDay"
value[x]		1.. 1	boolean	Value of extension
extension:availableStartTime		0..1	Extension	Opening time of day (ignored if allDay = true)
extension		0 .. 0
url		1 .. 1	uri	"availableStartTime"
value[x]		1.. 1	time	Value of extension
extension:availableEndTime		0..1	Extension	Closing time of day (ignored if allDay = true)
extension		0 .. 0
url		1 .. 1	uri	"availableEndTime"
value[x]		1.. 1	time	Value of extension
url		1 .. 1	uri	"availableTime"
value[x]		0 .. 0
extension:notAvailableTime		0..*	Extension	Not available during this time due to provided reason
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:description		0..1	Extension	Reason presented to the user explaining why time not available
extension		0 .. 0
url		1 .. 1	uri	"description"
value[x]		1.. 1	string	Value of extension
extension:during		0..1	Extension	Service not available during this period
extension		0 .. 0
url		1 .. 1	uri	"during"
value[x]		1.. 1	Period	Value of extension
url		1 .. 1	uri	"notAvailableTime"
value[x]		0 .. 0
url		1 .. 1	uri	"http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
value[x]		0 .. 0
Documentation for this format

R4

The extension is represented a little differently in R4:

• Remove the extension context ExtendedContactDetail
• 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
Extension		0..1	Extension	Extension
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:_datatype		1..1	(Complex)	DataType name 'Availability' from R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype
value[x]		1.. 1	string	Value of extension Fixed Value: Availability
extension:availableTime		0..*	Extension	Times the {item} is available
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:daysOfWeek		0..*	Extension	mon | tue | wed | thu | fri | sat | sun
extension		0 .. 0
url		1 .. 1	uri	"daysOfWeek"
value[x]		1.. 1	code	Value of extension Binding: DaysOfWeek ( required ): The purpose for which an extended contact detail should be used.
extension:allDay		0..1	Extension	Always available? i.e. 24 hour service
extension		0 .. 0
url		1 .. 1	uri	"allDay"
value[x]		1.. 1	boolean	Value of extension
extension:availableStartTime		0..1	Extension	Opening time of day (ignored if allDay = true)
extension		0 .. 0
url		1 .. 1	uri	"availableStartTime"
value[x]		1.. 1	time	Value of extension
extension:availableEndTime		0..1	Extension	Closing time of day (ignored if allDay = true)
extension		0 .. 0
url		1 .. 1	uri	"availableEndTime"
value[x]		1.. 1	time	Value of extension
url		1 .. 1	uri	"availableTime"
value[x]		0 .. 0
extension:notAvailableTime		0..*	Extension	Not available during this time due to provided reason
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:description		0..1	Extension	Reason presented to the user explaining why time not available
extension		0 .. 0
url		1 .. 1	uri	"description"
value[x]		1.. 1	string	Value of extension
extension:during		0..1	Extension	Service not available during this period
extension		0 .. 0
url		1 .. 1	uri	"during"
value[x]		1.. 1	Period	Value of extension
url		1 .. 1	uri	"notAvailableTime"
value[x]		0 .. 0
url		1 .. 1	uri	"http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
value[x]		0 .. 0
Documentation for this format

R3

The extension is represented a little differently in R3:

• Remove the extension context ExtendedContactDetail
• 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
Extension		0..1	Extension	Extension
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:_datatype		1..1	(Complex)	DataType name 'Availability' from R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype
value[x]		1.. 1	string	Value of extension Fixed Value: Availability
extension:availableTime		0..*	Extension	Times the {item} is available
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:daysOfWeek		0..*	Extension	mon | tue | wed | thu | fri | sat | sun
extension		0 .. 0
url		1 .. 1	uri	"daysOfWeek"
value[x]		1.. 1	code	Value of extension Binding: DaysOfWeek ( required ): The purpose for which an extended contact detail should be used.
extension:allDay		0..1	Extension	Always available? i.e. 24 hour service
extension		0 .. 0
url		1 .. 1	uri	"allDay"
value[x]		1.. 1	boolean	Value of extension
extension:availableStartTime		0..1	Extension	Opening time of day (ignored if allDay = true)
extension		0 .. 0
url		1 .. 1	uri	"availableStartTime"
value[x]		1.. 1	time	Value of extension
extension:availableEndTime		0..1	Extension	Closing time of day (ignored if allDay = true)
extension		0 .. 0
url		1 .. 1	uri	"availableEndTime"
value[x]		1.. 1	time	Value of extension
url		1 .. 1	uri	"availableTime"
value[x]		0 .. 0
extension:notAvailableTime		0..*	Extension	Not available during this time due to provided reason
Slices for extension		0 ..*	Extension	Extension Slice: Unordered, Open by value:url
extension:description		0..1	Extension	Reason presented to the user explaining why time not available
extension		0 .. 0
url		1 .. 1	uri	"description"
value[x]		1.. 1	string	Value of extension
extension:during		0..1	Extension	Service not available during this period
extension		0 .. 0
url		1 .. 1	uri	"during"
value[x]		1.. 1	Period	Value of extension
url		1 .. 1	uri	"notAvailableTime"
value[x]		0 .. 0
url		1 .. 1	uri	"http://hl7.org/fhir/StructureDefinition/extended-contact-availability"
value[x]		0 .. 0
Documentation for this format

Search Parameters for this Extension

(none found)