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

Difference between revisions of "Endpoint FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
 
(18 intermediate revisions by one other user not shown)
Line 3: Line 3:
 
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div>
 
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div>
 
<div style="background:#F0F0F0">
 
<div style="background:#F0F0F0">
This page documents a [[:category:Pending FHIR Resource Proposal|Pending]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]]
+
This page documents a [[:category:Approved FHIR Resource Proposal|Approved]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]]
 
</div>
 
</div>
 
</div>
 
</div>
 
[[Category:FHIR Resource Proposal]]
 
[[Category:FHIR Resource Proposal]]
[[Category:Pending FHIR Resource Proposal]]
+
[[Category:Approved FHIR Resource Proposal]]
  
  
Line 13: Line 13:
  
  
=PutProposedResourceNameHere=
+
=Endpoint=
 
 
<!-- 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]]
 
 
==Committee Approval Date:==
 
==Committee Approval Date:==
<i>Please enter the date that the committee approved this Resource proposal</i>
+
31 May 2016
  
 
==Contributing or Reviewing Work Groups==
 
==Contributing or Reviewing Work Groups==
 
+
FHIR-Infrastructure
<!-- 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==
 
+
pending
<!-- 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 -->
 
  
 
==Scope of coverage==
 
==Scope of coverage==
 +
An endpoint describes the technical details of a location that can be connected to for the delivery/retrieval of information. Sufficient information is required to ensure that a connection can be made securely, and appropriate data transmitted as defined by the endpoint owner in an agreed format (such as IHE or HL7 Profiles).
  
<!-- 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%"
+
This is not a description of details of the current system, as found in conformance, but of another (potentially external) system.
 
+
These may be locally hosted services, regional services, or national service.
Scope should consider numerous aspects of breadth of scope, including:
 
* 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==
 
+
(none)
<!-- 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. -->
 
  
 
==Resource appropriateness==
 
==Resource appropriateness==
 
+
All systems that integrate with other systems have a need to track the details of the connectivity.
<!-- Does the resource meet the following characteristics?
+
This resource permits recording of this information, and will be able to be included in Registries where they can be discovered, or internally to manage external dependencies.
 
 
Must
 
* Represents a well understood, "important" concept in the business of healthcare
 
* Represents a concept expected to be tracked with distinct, reliable, unique ids
 
* Reasonable for the resource to be independently created, queried and maintained
 
 
 
Should
 
* Declared interest in need for standardization of data exchange</span>
 
* Resource is expected to contain an appropriate number of "core" (non-extension) data elements (in most cases, somewhere in the range of 20-50)
 
* Have the characteristics of high cohesion & low coupling – need to explore whether coupling is good some places, not elsewhere – layers from Bo’s document
 
-->
 
  
 
==Expected implementations==
 
==Expected implementations==
  
 
<!--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. -->
 
<!--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. -->
 +
*Public Services/Provider Directories which assist in electronic data transfers
 +
*Systems that maintain connections to external systems
  
 
==Content sources==
 
==Content sources==
 
+
*Australian Standards Endpoint Location Service
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
+
*IHE HPD+
 
+
*Argonaut Provider Directory Workgroup
Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? -->
+
*Carequality UDDI
  
 
==Example Scenarios==
 
==Example Scenarios==
 
+
These resources are typically used to identify where to locate endpoint details for:
<!-- 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.) -->
+
*Questionnaires: Where to send information (currently an SDC extension with just the address)
 +
*ValueSet: Where related Terminology Services can be found (where not local)
 +
*Subscription: The destination to send the subscribed data (or to pull)
 +
*Messaging: (currently defined in the Message Header, but only as the address) eg CCDA distribution
 +
*Referrals: Where to send referral requests (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
 +
*Referrals - Templates: Where to locate referral templates (Questionnaires - linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
 +
*CarePlans: Where a shared CarePlan can be found
 +
*Scheduling: Where to lookup to discover schedules/availability information (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
 +
*Scheduling: Where to lookup to send appointment requests (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
 +
*Patient/Person: Location of Master Patient/Person Indexes
 +
*Service Provider Directories: Location of related directories (parent/child/federated)
 +
*Imaging: Locating DICOM servers that will contain the HIRES images
  
 
==Resource Relationships==
 
==Resource Relationships==
 +
The endpoint is distinct from a conformance statement in that the Conformance statement describes the entire capability of a server (and in the metadata case, just this server)
  
<!-- What are the resources do you expect will reference this resource and in what context?
+
The endpoint resource describes the technical details for how to connect, and for what purposes (which could be a small sub-set of the server's capabilities, and may not be a FHIR endpoint).
 
 
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)
+
The endpoint may be referenced by
-->
+
*Organization
 +
*Location
 +
*HealthcareService
  
 
==Timelines==
 
==Timelines==
 
+
In time for the STU3 ballot cycle (draft is available now, and has been publicized and have a group willing to iterate on it quickly.
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
 
  
 
==gForge Users==
 
==gForge Users==
 
+
brianpos
<!-- Identify the userids who will require commit access to gForge to maintain the resource.  (Ensure all users have registered for gForge.) -->
 
  
 
==When Resource Proposal Is Complete==
 
==When Resource Proposal Is Complete==
 
'''When you have completed your proposal, please send an email to [mailto:FMGcontact@HL7.org FMGcontact@HL7.org]'''
 
'''When you have completed your proposal, please send an email to [mailto:FMGcontact@HL7.org FMGcontact@HL7.org]'''

Latest revision as of 20:23, 20 July 2016



Endpoint

Owning committee name

Patient Administration

Committee Approval Date:

31 May 2016

Contributing or Reviewing Work Groups

FHIR-Infrastructure

FHIR Resource Development Project Insight ID

pending

Scope of coverage

An endpoint describes the technical details of a location that can be connected to for the delivery/retrieval of information. Sufficient information is required to ensure that a connection can be made securely, and appropriate data transmitted as defined by the endpoint owner in an agreed format (such as IHE or HL7 Profiles).

This is not a description of details of the current system, as found in conformance, but of another (potentially external) system. These may be locally hosted services, regional services, or national service.

RIM scope

(none)

Resource appropriateness

All systems that integrate with other systems have a need to track the details of the connectivity. This resource permits recording of this information, and will be able to be included in Registries where they can be discovered, or internally to manage external dependencies.

Expected implementations

  • Public Services/Provider Directories which assist in electronic data transfers
  • Systems that maintain connections to external systems

Content sources

  • Australian Standards Endpoint Location Service
  • IHE HPD+
  • Argonaut Provider Directory Workgroup
  • Carequality UDDI

Example Scenarios

These resources are typically used to identify where to locate endpoint details for:

  • Questionnaires: Where to send information (currently an SDC extension with just the address)
  • ValueSet: Where related Terminology Services can be found (where not local)
  • Subscription: The destination to send the subscribed data (or to pull)
  • Messaging: (currently defined in the Message Header, but only as the address) eg CCDA distribution
  • Referrals: Where to send referral requests (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
  • Referrals - Templates: Where to locate referral templates (Questionnaires - linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
  • CarePlans: Where a shared CarePlan can be found
  • Scheduling: Where to lookup to discover schedules/availability information (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
  • Scheduling: Where to lookup to send appointment requests (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
  • Patient/Person: Location of Master Patient/Person Indexes
  • Service Provider Directories: Location of related directories (parent/child/federated)
  • Imaging: Locating DICOM servers that will contain the HIRES images

Resource Relationships

The endpoint is distinct from a conformance statement in that the Conformance statement describes the entire capability of a server (and in the metadata case, just this server)

The endpoint resource describes the technical details for how to connect, and for what purposes (which could be a small sub-set of the server's capabilities, and may not be a FHIR endpoint).

The endpoint may be referenced by

  • Organization
  • Location
  • HealthcareService

Timelines

In time for the STU3 ballot cycle (draft is available now, and has been publicized and have a group willing to iterate on it quickly.

gForge Users

brianpos

When Resource Proposal Is Complete

When you have completed your proposal, please send an email to FMGcontact@HL7.org