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

Difference between revisions of "Slot FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
m (Slot)
Line 13: Line 13:
  
  
=PutProposedResourceNameHere=
+
=Slot=
 
 
<!-- Resource names should meet the following characteristics:
 
* Lower camel case
 
* U.S. English
 
* Domain-friendly
 
* Short
 
* Clear
 
* Unique
 
* Avoid non-universal abbreviations (e.g. URL would be ok)
 
* Be expressed as a noun
 
* Be consistent with other similar resources
 
-->
 
  
 
==Owning committee name==
 
==Owning committee name==
 
+
[[Patient Administration]]
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. -->
 
[[YourCommitteeName]]
 
  
 
==Contributing or Reviewing Work Groups==
 
==Contributing or Reviewing Work Groups==
 
+
* "None"
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the resource (optional) -->
 
* Work Group Name
 
* or link
 
* or "None"
 
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
 
 
<!-- Please specify the id of your work group’s PSS for doing FHIR work.  (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc -->
 
<!-- Please specify the id of your work group’s PSS for doing FHIR work.  (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc -->
 +
pending
  
 
==Scope of coverage==
 
==Scope of coverage==
 +
The slot is used to cover:
 +
* an interval of time whereby the referenced availability resource's may be booked
 +
* what type of appointment can be booked in the interval of time (may over-rule the availabilities restrictions)
 +
* The status of the slot (booked/available/overbooked)
  
<!-- Define the full scope of coverage for the resource.  The scope must be clearly delineated such that it does not overlap with any other existing or expected resource.  The scope will be used to govern "what is the set of potential applications to consider when evaluating what elements are 'core' – i.e. in the 80%"
+
The slot does not cover:
 
+
* Recurrences
Scope should consider numerous aspects of breadth of scope, including:
+
* the total window of time in the "planning horizon" (This is covered by the Availability resource)
* Subject: Human vs. non-human vs. non-patient (e.g. lab bench medicine)
 
* Disciplines: Environmental Health, Palliative, Respiratory, Psychology, Maternity, Clinical Research
 
* Delivery environment (Community, Geriatric, Home care, Emergency, Inpatient, Intensive, Neonatal, Pediatric, Primary)
 
* Locale: Country, region
 
 
 
As a rule, resources should encompass all of these aspects.
 
-->
 
  
 
==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. -->
  
Line 76: Line 54:
  
 
==Expected implementations==
 
==Expected implementations==
 
+
This resource is expected to be implemented by community clinics, general practice and specialist software solutions to publish their availability information to take appointments directly from users external to the organization providing the information.
<!--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.
<!-- 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==
 
==Example Scenarios==
 
+
A Physio-Therapy clinic wants to publish a 2 month planning horizon for where appointments can be booked. Each available period of time will have a slot resource created describing that time slot; what it can be used for, and the availability status of the slot.
<!-- 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.) -->
+
If the clinic had repeating intervals, these must be expanded into each slot and created on the fhir server. This removes the need for the slot's recurrence information to be concerned with handling time zones across time intervals.
  
 
==Resource Relationships==
 
==Resource Relationships==
 
+
This Slot Resource will reference the Availability that it "belongs" to, and will be referenced by any Appointment Resources that have been booked into this Slot.
<!-- What are the resources do you expect will reference this resource and in what context?
 
 
 
What resources do you expect this resource reference and in what context?
 
 
 
Note: These may be existing resources or "expected" resource
 
 
 
Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording)
 
-->
 
  
 
==Timelines==
 
==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.
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
 
  
 
==gForge Users==
 
==gForge Users==
 
+
brian_pos
<!-- Identify the userids who will require commit access to gForge to maintain the resource.  (Ensure all users have registered for gForge.) -->
+
ewoutkramer
 +
grahameg

Revision as of 14:07, 14 April 2014



Slot

Owning committee name

Patient Administration

Contributing or Reviewing Work Groups

  • "None"

FHIR Resource Development Project Insight ID

pending

Scope of coverage

The slot is used to cover:

  • an interval of time whereby the referenced availability resource's may be booked
  • what type of appointment can be booked in the interval of time (may over-rule the availabilities restrictions)
  • The status of the slot (booked/available/overbooked)

The slot does not cover:

  • Recurrences
  • the total window of time in the "planning horizon" (This is covered by the Availability resource)

RIM scope

Resource appropriateness

Expected implementations

This resource is expected to be implemented by community clinics, general practice and specialist software solutions to publish their availability information to take appointments directly from users external to the organization providing the information.

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.

Example Scenarios

A Physio-Therapy clinic wants to publish a 2 month planning horizon for where appointments can be booked. Each available period of time will have a slot resource created describing that time slot; what it can be used for, and the availability status of the slot. If the clinic had repeating intervals, these must be expanded into each slot and created on the fhir server. This removes the need for the slot's recurrence information to be concerned with handling time zones across time intervals.

Resource Relationships

This Slot Resource will reference the Availability that it "belongs" to, and will be referenced by any Appointment Resources that have been booked into this Slot.

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