Validated Healthcare Directory IG STU1 Draft for Comment

This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) v3.2.0. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: location-availability - Content

An extension to describe the general availability of a location. Similar to the availability attributes found in the practitionerRole resource.

Consists of:

  • availableTime - indicates the times the location is available
    • availableTime.daysOfWeek - indicates the day(s) of the week the location is available
    • availableTime.allDay - indicates the location is always available
    • availableTime.availableStartTime - indicates when the location opens
    • availableTime.availableEndTime - indicates when the location closes
  • notAvailable - indicates why a location is not available at a particular time
    • notAvailable.description - describes the reason the location is not available
    • notAvailable.during - indicates a period for which the location is not available
  • availabilityExceptions - describes any exceptions to when this location is typically available

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability

Information about when this location is available

This profile builds on Extension.

This profile was published on Fri Nov 17 06:22:57 AEDT 2017 as a draft by null.

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

  1. If using notAvailable:
  2. One description is required in notAvailable.description
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Availability
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability"
... value[x] 0..0
... extension 0..*ExtensionAvailable time
.... extension 0..*ExtensionDays of week
..... url 1..1uri"daysOfWeek"
..... valueCode 0..1codeDays of Week
.... extension 0..1ExtensionAll day
..... url 1..1uri"allDay"
..... valueBoolean 0..1booleanAll day
.... extension 0..1ExtensionAvailable start time
..... url 1..1uri"availableStartTime"
..... valueTime 0..1timeAvailable start time
.... extension 0..1ExtensionAvailable end time
..... url 1..1uri"availableEndTime"
..... valueTime 0..1timeAvailable end time
.... url 1..1uri"availableTime"
.... value[x] 0..0
... extension 0..*ExtensionNot available
.... extension 1..1ExtensionDescription
..... url 1..1uri"description"
..... valueString 0..1stringDescription
.... extension 0..1ExtensionDuring
..... url 1..1uri"during"
..... valuePeriod 0..1PeriodDescription
.... url 1..1uri"notAvailable"
.... value[x] 0..0
... extension 0..1ExtensionAvailability exceptions
.... url 1..1uri"availabilityExceptions"
.... valueString 0..1stringAvailability exceptions

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*Availability
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAvailable time
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionDays of week
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"daysOfWeek"
..... valueCode 0..1codeDays of Week
.... extension 0..1ExtensionAll day
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"allDay"
..... valueBoolean 0..1booleanAll day
.... extension 0..1ExtensionAvailable start time
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"availableStartTime"
..... valueTime 0..1timeAvailable start time
.... extension 0..1ExtensionAvailable end time
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"availableEndTime"
..... valueTime 0..1timeAvailable end time
.... url 1..1uri"availableTime"
... extension 0..*ExtensionNot available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 1..1ExtensionDescription
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"description"
..... valueString 0..1stringDescription
.... extension 0..1ExtensionDuring
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"during"
..... valuePeriod 0..1PeriodDescription
.... url 1..1uri"notAvailable"
... extension 0..1ExtensionAvailability exceptions
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"availabilityExceptions"
.... valueString 0..1stringAvailability exceptions
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability"

doco Documentation for this format
  1. If using notAvailable:
  2. One description is required in notAvailable.description

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Availability
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability"
... value[x] 0..0
... extension 0..*ExtensionAvailable time
.... extension 0..*ExtensionDays of week
..... url 1..1uri"daysOfWeek"
..... valueCode 0..1codeDays of Week
.... extension 0..1ExtensionAll day
..... url 1..1uri"allDay"
..... valueBoolean 0..1booleanAll day
.... extension 0..1ExtensionAvailable start time
..... url 1..1uri"availableStartTime"
..... valueTime 0..1timeAvailable start time
.... extension 0..1ExtensionAvailable end time
..... url 1..1uri"availableEndTime"
..... valueTime 0..1timeAvailable end time
.... url 1..1uri"availableTime"
.... value[x] 0..0
... extension 0..*ExtensionNot available
.... extension 1..1ExtensionDescription
..... url 1..1uri"description"
..... valueString 0..1stringDescription
.... extension 0..1ExtensionDuring
..... url 1..1uri"during"
..... valuePeriod 0..1PeriodDescription
.... url 1..1uri"notAvailable"
.... value[x] 0..0
... extension 0..1ExtensionAvailability exceptions
.... url 1..1uri"availabilityExceptions"
.... valueString 0..1stringAvailability exceptions

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*Availability
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAvailable time
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionDays of week
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"daysOfWeek"
..... valueCode 0..1codeDays of Week
.... extension 0..1ExtensionAll day
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"allDay"
..... valueBoolean 0..1booleanAll day
.... extension 0..1ExtensionAvailable start time
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"availableStartTime"
..... valueTime 0..1timeAvailable start time
.... extension 0..1ExtensionAvailable end time
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"availableEndTime"
..... valueTime 0..1timeAvailable end time
.... url 1..1uri"availableTime"
... extension 0..*ExtensionNot available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 1..1ExtensionDescription
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"description"
..... valueString 0..1stringDescription
.... extension 0..1ExtensionDuring
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"during"
..... valuePeriod 0..1PeriodDescription
.... url 1..1uri"notAvailable"
... extension 0..1ExtensionAvailability exceptions
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"availabilityExceptions"
.... valueString 0..1stringAvailability exceptions
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability"

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

No Search criteria for location-availability extension.