This wiki has undergone a migration to Confluence found Here

Difference between revisions of "DeviceDefinition FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
Line 13: Line 13:
  
  
=PutProposedResourceNameHere=
+
=DeviceDefinition=
  
 
<!-- Resource names should meet the following characteristics:
 
<!-- Resource names should meet the following characteristics:
Line 27: Line 27:
 
  -->
 
  -->
  
==Owning work group name==
+
==Owning Committee Name==
 
+
Orders & Observations
 
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. -->
 
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. -->
 
[[YourWorkGroupName]]
 
[[YourWorkGroupName]]
Line 34: Line 34:
 
==Committee Approval Date:==
 
==Committee Approval Date:==
 
<i>Please enter the date that the committee approved this Resource proposal</i>
 
<i>Please enter the date that the committee approved this Resource proposal</i>
 +
 +
June 12, 2018 - http://confluence.hl7.org/display/OO/OO+Conf+Call+Minutes+-+Device+-+20180612
  
 
==Contributing or Reviewing Work Groups==
 
==Contributing or Reviewing Work Groups==
 
+
Healthcare Devices
 
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the resource (optional) -->
 
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the resource (optional) -->
 
* Work Group Name
 
* Work Group Name
Line 43: Line 45:
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
 
+
PI 952
 
<!-- 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 -->
  
 
==Scope of coverage==
 
==Scope of coverage==
 +
The DeviceDefinition is an adminsitrative resource that includes all relevant attributes to define the kind of device that can be referenced by multiple Devices to provide information that does not change for an instance.
 +
 +
The DeviceDefinition can also be used for catalogs or other use cases where the reference to a device is generically to a type of device, not a specific instance of a device.  This may include procedures or observations where the specific device is not known or not relevant.
 +
 +
Example device definitions include specifications for an x-ray machine, implantable devices, lab analyzers, etc.
 +
 +
Note that with the acceptance of this proposal, the Device resource scope will be reduced to just the instance related attributes.
  
 
<!-- 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%"
 
<!-- 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%"
Line 60: Line 69:
  
 
==RIM scope==
 
==RIM scope==
 +
There does not appear to be a DeviceDefinition concept in the RIM, rather only the Device instance is referenced  The Common Product Model touches on elements, but not all.
  
 
<!-- 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. -->
  
 
==Resource appropriateness==
 
==Resource appropriateness==
 +
Separating the DeviceDefinition from Device enables more clear distinctions and use considering a number of use cases primarily focus on Device, while others focus on DeviceDefinition.  Furthermore, there will be many more Device instances than there will be DeviceDefinition instances.  The DeviceDefinition would be used in catalogs and go through independent updates from the Device instance.
  
 
<!-- Does the resource meet the following characteristics?
 
<!-- Does the resource meet the following characteristics?
Line 79: Line 90:
  
 
==Expected implementations==
 
==Expected implementations==
 +
Implementations of catalogs, e.g., LIVD as well as implementations needing to reference devices will all directly or indirectly use this device.
  
 
<!--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. -->
  
 
==Content sources==
 
==Content sources==
 +
* HL7 FHIR Device, DeviceComponent, and DeviceMetrics
 +
* HL7 V2 EQU and DEV segments
  
 
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
 
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
Line 93: Line 107:
  
 
==Resource Relationships==
 
==Resource Relationships==
 +
* Device
 +
* Composition
 +
* ObservationDefinition
 +
* Etc.
  
 
<!-- What are the resources do you expect will reference this resource and in what context?
 
<!-- What are the resources do you expect will reference this resource and in what context?
Line 104: Line 122:
  
 
==Timelines==
 
==Timelines==
 +
September 2018 inclusion in FHIR R4.
  
 
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
 
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
  
 
==gForge Users==
 
==gForge Users==
 +
Eric Haas, Jose Costa Teixeira
  
 
<!-- Identify the userids who will require commit access to gForge to maintain the resource.  (Ensure all users have registered for gForge.) -->
 
<!-- Identify the userids who will require commit access to gForge to maintain the resource.  (Ensure all users have registered for gForge.) -->

Revision as of 17:01, 26 June 2018



DeviceDefinition

Owning Committee Name

Orders & Observations YourWorkGroupName

Committee Approval Date:

Please enter the date that the committee approved this Resource proposal

June 12, 2018 - http://confluence.hl7.org/display/OO/OO+Conf+Call+Minutes+-+Device+-+20180612

Contributing or Reviewing Work Groups

Healthcare Devices

  • Work Group Name
  • or link
  • or "None"

FHIR Resource Development Project Insight ID

PI 952

Scope of coverage

The DeviceDefinition is an adminsitrative resource that includes all relevant attributes to define the kind of device that can be referenced by multiple Devices to provide information that does not change for an instance.

The DeviceDefinition can also be used for catalogs or other use cases where the reference to a device is generically to a type of device, not a specific instance of a device. This may include procedures or observations where the specific device is not known or not relevant.

Example device definitions include specifications for an x-ray machine, implantable devices, lab analyzers, etc.

Note that with the acceptance of this proposal, the Device resource scope will be reduced to just the instance related attributes.


RIM scope

There does not appear to be a DeviceDefinition concept in the RIM, rather only the Device instance is referenced The Common Product Model touches on elements, but not all.


Resource appropriateness

Separating the DeviceDefinition from Device enables more clear distinctions and use considering a number of use cases primarily focus on Device, while others focus on DeviceDefinition. Furthermore, there will be many more Device instances than there will be DeviceDefinition instances. The DeviceDefinition would be used in catalogs and go through independent updates from the Device instance.


Expected implementations

Implementations of catalogs, e.g., LIVD as well as implementations needing to reference devices will all directly or indirectly use this device.


Content sources

  • HL7 FHIR Device, DeviceComponent, and DeviceMetrics
  • HL7 V2 EQU and DEV segments


Example Scenarios

Resource Relationships

  • Device
  • Composition
  • ObservationDefinition
  • Etc.


Timelines

September 2018 inclusion in FHIR R4.


gForge Users

Eric Haas, Jose Costa Teixeira


When Resource Proposal Is Complete

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

FMG Notes