This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "Availability FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
m
Line 37: Line 37:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
The Availability is used to cover:
 +
* a "planning horizon" of time where a resource has availability resources defined
 +
* What type of appointment(s) may be booked into the slots associated with this availability (This may be over-ruled by the associated slots)
 +
* Although the Availability will normally be associated with Location, Practitioner, Device, Patient or RelatedPerson resources, they should be able to be associated with any resource type (likely other resources could be Group, or the yet to be defined EpisodeOfCare or HealthcareService)
 +
 +
The availability does not cover:
 +
* the start/end times for any particular available time (this is covered by the Slot resource)
 +
* a template that could be used to "derive" associated slots (at this point - this would be an extension if desired as in many systems this is a very complex structure and interaction with timezones would also need to be considered)
 +
*
  
 
==RIM scope==
 
==RIM scope==
  
 
<!-- Identify the formal RIM mapping for the root concept of the resource.  The expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. -->
 
<!-- Identify the formal RIM mapping for the root concept of the resource.  The expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. -->
 +
Act(Classcode=schedule)
  
 
==Resource appropriateness==
 
==Resource appropriateness==
Line 56: Line 66:
 
* Have the characteristics of high cohesion & low coupling – need to explore whether coupling is good some places, not elsewhere – layers from Bo’s document  
 
* Have the characteristics of high cohesion & low coupling – need to explore whether coupling is good some places, not elsewhere – layers from Bo’s document  
 
  -->
 
  -->
 +
Many existing systems publish their resource availability information for consumers (software and people) to be able to understand if/when they can request to book appointments.
 +
 +
Existing products that have calendaring information publish this type of information - often in the iCal standard Free-Busy format.
 +
  
 
==Expected implementations==
 
==Expected implementations==
 +
This resource is expected to be implemented by clinics, general practices and specialist healthcare provider's software solutions to publish their availability information to take appointments directly from users internal or external to the organization providing the information.
 +
The users could be either the Patient, the Provider, or an agent acting on the Patients behalf (such as his General Practitioner or Care Manager)
  
<!--Key resources are justified by CCDA, for resources not deemed "key", what interest is there by implementers in using this particular resource. Provide named implementations if possible - ideally provide multiple independent implementations. -->
 
  
 
==Content sources==
 
==Content sources==
 +
The slot resource has some overlap with the iCal standard, the mapping to this standard will also be in scope of the resource. We also considered the HL7 v2 and v3 schedule messages and models which are closely related.
  
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
 
  
Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? -->
+
==Example Scenarios==
 +
A Physio-Therapy clinic wants to publish a 2 month planning horizon for where appointments can be booked. It will publish a single Availability resource describing the 2 month range; what it can be used for, and then create the set of time slots that can actually be booked against.
  
==Example Scenarios==
+
An outpatients clinic's Operating Room publishes its availability information. Several availability records are created to cover the different types of surgery that can be booked into the associated time slots. At this particular outpatient clinic, the mornings slots are available for general surgery appointments, and the afternoon is restricted in the types of appointments due to staffing restrictions and reduced recovery times. By using several availability records the slots associated with these would not need to over-ride the default service type.
  
<!-- Provide a listing of the types of scenarios to be represented in the examples produced for this resource.  They should demonstrate the full scope of the resource and allow exercising of the resources capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.) -->
 
  
 
==Resource Relationships==
 
==Resource Relationships==
<!-- What are the resources do you expect will reference this resource and in what context?
+
The Availability Resource can reference "any" other resource as the individual that it is defining availability information for, but will typically only be used for Location, Practitioner, Device, Patient or RelatedPerson resources.
  
What resources do you expect this resource reference and in what context?
+
This resource will be referenced by the new Slot resource.
  
Note: These may be existing resources or "expected" resource
+
Note: This resource will not be referenced by Appointment resources, the Appointment will reference the Slot resource directly (which then references this availability record)
  
Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording)
 
-->
 
  
 
==Timelines==
 
==Timelines==

Revision as of 01:57, 28 April 2014



Availability

Owning committee name

Patient Administration

Contributing or Reviewing Work Groups

  • "None"

FHIR Resource Development Project Insight ID

pending

Scope of coverage

The Availability is used to cover:

  • a "planning horizon" of time where a resource has availability resources defined
  • What type of appointment(s) may be booked into the slots associated with this availability (This may be over-ruled by the associated slots)
  • Although the Availability will normally be associated with Location, Practitioner, Device, Patient or RelatedPerson resources, they should be able to be associated with any resource type (likely other resources could be Group, or the yet to be defined EpisodeOfCare or HealthcareService)

The availability does not cover:

  • the start/end times for any particular available time (this is covered by the Slot resource)
  • a template that could be used to "derive" associated slots (at this point - this would be an extension if desired as in many systems this is a very complex structure and interaction with timezones would also need to be considered)

RIM scope

Act(Classcode=schedule)

Resource appropriateness

Many existing systems publish their resource availability information for consumers (software and people) to be able to understand if/when they can request to book appointments.

Existing products that have calendaring information publish this type of information - often in the iCal standard Free-Busy format.


Expected implementations

This resource is expected to be implemented by clinics, general practices and specialist healthcare provider's software solutions to publish their availability information to take appointments directly from users internal or external to the organization providing the information. The users could be either the Patient, the Provider, or an agent acting on the Patients behalf (such as his General Practitioner or Care Manager)


Content sources

The slot resource has some overlap with the iCal standard, the mapping to this standard will also be in scope of the resource. We also considered the HL7 v2 and v3 schedule messages and models which are closely related.


Example Scenarios

A Physio-Therapy clinic wants to publish a 2 month planning horizon for where appointments can be booked. It will publish a single Availability resource describing the 2 month range; what it can be used for, and then create the set of time slots that can actually be booked against.

An outpatients clinic's Operating Room publishes its availability information. Several availability records are created to cover the different types of surgery that can be booked into the associated time slots. At this particular outpatient clinic, the mornings slots are available for general surgery appointments, and the afternoon is restricted in the types of appointments due to staffing restrictions and reduced recovery times. By using several availability records the slots associated with these would not need to over-ride the default service type.


Resource Relationships

The Availability Resource can reference "any" other resource as the individual that it is defining availability information for, but will typically only be used for Location, Practitioner, Device, Patient or RelatedPerson resources.

This resource will be referenced by the new Slot resource.

Note: This resource will not be referenced by Appointment resources, the Appointment will reference the Slot resource directly (which then references this availability record)


Timelines

Given the progress to date, we expect that this resource will be ready for inclusion in the next Ballot (expecting September 2014) the resource has already undergone a great deal of review in PA over the last 6 months.

gForge Users

brian_pos ewoutkramer grahameg