Difference between revisions of "ObservationDefinition2 FHIR Resource Proposal"
(Created page with "{{subst::Template:FHIR Resource Proposal}}") |
(migrate to Confluence) |
||
| (32 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<div class="messagebox cleanup metadata"> | <div class="messagebox cleanup metadata"> | ||
| − | <div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div> | + | Current version: https://confluence.hl7.org/display/FHIR/ObservationDefinition2+FHIR+Resource+Proposal<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:Pending FHIR Resource Proposal|Pending]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]] | ||
| Line 13: | Line 13: | ||
| − | = | + | =ObservationDefinition= |
<!-- Resource names should meet the following characteristics: | <!-- Resource names should meet the following characteristics: | ||
| Line 30: | Line 30: | ||
<!-- 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. --> | ||
| − | [[ | + | [[Orders_%26_Observations_WG]] |
==Committee Approval Date:== | ==Committee Approval Date:== | ||
| − | + | June 28, 2018 | |
==Contributing or Reviewing Work Groups== | ==Contributing or Reviewing Work Groups== | ||
<!-- 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) --> | ||
| − | + | 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 --> | ||
| + | [http://www.hl7.org/special/Committees/projman/searchableProjectIndex.cfm?action=edit&ProjectNumber=1010 Ordering Service Interface Specification Project (1010)] | ||
==Scope of coverage== | ==Scope of coverage== | ||
| Line 58: | Line 57: | ||
As a rule, resources should encompass all of these aspects. | As a rule, resources should encompass all of these aspects. | ||
--> | --> | ||
| + | An instance of ObservationDefinition represents the definitional aspects of a kind of observation. This resource is used in a catalog of products or services for healthcare. It provides the definition of observations, which are used as input or produced as outcome of these products and services. The focus of the definitional aspects of ObservationDefinition is not on the action of performing observations of that kind. Rather, it is on the outcome of the observations. An instance of ObservationDefinition represents a set of constraints applicable to the value produced by observations of this kind. This set of constraints may have two utilities: 1) It guides the entry of the result of an observation of the kind defined. 2) It helps the consumer of the results of observations of that kind, to interpret properly these results. | ||
| + | |||
| + | For instance, in a catalog of laboratory in vitro diagnostic services, the ObservationDefinition resources describe the observations that should be provided by the orderer alongside an ordered service (questions asked at order entry or at specimen collection, prior results) as well as the observations that will be reported once the service has been performed. | ||
| + | |||
| + | In a catalog of medications, ObservationDefinition resources can be used to describe observations the result thereof need to be checked against the prescription of a particular medicinal product (therapeutic range, units ...) | ||
| + | |||
| + | In the catalog of tests of an in vitro diagnostic device, ObservationDefinition resources can be used to characterize (absolute range, unit, decimal precision, critical values ...) the observations that will be produced by the IVD tests performed by the device. | ||
| + | |||
| + | ObservationDefinition may be used to characterize observations from any discipline. | ||
==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. --> | ||
| + | [http://www.hl7.org/v3ballotarchive_temp_CD61C484-1C23-BA17-0CFFB7C113ECF268/v3ballot/html/welcome/environment/index.html Observation class with moodCode="DEF"] | ||
==Resource appropriateness== | ==Resource appropriateness== | ||
| Line 77: | Line 86: | ||
* 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 | ||
--> | --> | ||
| + | ObservationDefinition is a definitional resource conformant to the [http://build.fhir.org/definition.html Definition pattern]. | ||
| + | |||
| + | Like an instance of Observation, an instance of ObservationDefinition has a code, which identifies the kind of observation that is expected. Unlike an instance of Observation, though, an instance of ObservationDefinition does not have a value, since it is in definitional mood. The instance of ObservationDefinition has the properties that characterize the values expected from observations complying with this definition, such as: data types usable for value, multiple values allowed or not, various qualified ranges for numeric or ordinal results, various qualified value sets for coded values, units, decimal precision ... | ||
| + | |||
| + | In other words, an instance of ObservationDefinition acts as a set of constraints applicable to any instance of Observation claiming conformance to this definition. | ||
| + | |||
| + | ObservationDefinition instances lay in catalogs of products or services for healthcare, mostly as supportive resources to the entries of these catalogs. An example is: The definition of a "body temperature" observation to be provided at entry of an arterial blood gas service order. | ||
==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. --> | ||
| + | *Cognitive Medical Systems, Inc | ||
| + | *Intermountain Healthcare | ||
| + | *Phast | ||
| + | *Medlinx | ||
| + | *Quest Diagnostics | ||
==Content sources== | ==Content sources== | ||
<!-- 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 | ||
| − | |||
Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? --> | Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? --> | ||
| + | One major source of specifications is represented by the electronic Directory of Services (eDOS) implementation guide of HL7 v2.x messages of chapter 8 "Master files". Although this implementation guide is built for the US realm, most of its technical content (definitions of services, specimens, observations) is recognized to cover the universal realm. | ||
==Example Scenarios== | ==Example Scenarios== | ||
<!-- 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.) --> | <!-- 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.) --> | ||
| + | *A physician finds out which service to order to a diagnostic service facility, by querying the catalog of services of this facility and checking the output observations that are produced by each service. | ||
| + | *A CPOE application placing an order for a diagnostic service to a laboratory, discovers in the catalog entry describing this service what are the observations to provide at order entry and how to enter the results of those observations. | ||
| + | *A physician prescribing a medicinal product, checks from the catalog, which observation is to be included into the electronic prescription. | ||
==Resource Relationships== | ==Resource Relationships== | ||
| Line 102: | Line 126: | ||
Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording) | Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording) | ||
--> | --> | ||
| + | *Resource ObservationDefinition is referenced by resource ActivityDefinition. This enables items of catalogs, representing healthcare services or products, to declare the observations, which are consumed or produced by these items. | ||
| + | *It should also be considered that Observation.basedOn be able to reference ObservationDefinition resource. | ||
| + | *Resources Observation can be instantiated from the definition provided by ObservationDefinition (no operation defined yet for this purpose). | ||
==Timelines== | ==Timelines== | ||
<!-- 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 --> | ||
| + | This new resource is expected to be part or R4, like all the other pieces of catalogs of healthcare products/services. | ||
| + | |||
| + | It will be part of the Catalog tracks of FHIR connectathons, starting with January 2018. | ||
==gForge Users== | ==gForge Users== | ||
<!-- 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.) --> | ||
| + | N/A: Identified contributors already have a gForge account. | ||
| + | |||
| + | François Macary, Rob Hausam | ||
==When Resource Proposal Is Complete== | ==When Resource Proposal Is Complete== | ||
Latest revision as of 15:15, 31 October 2019
This page documents a Pending FHIR Resource Proposal
Contents
- 1 ObservationDefinition
- 1.1 Owning work group name
- 1.2 Committee Approval Date:
- 1.3 Contributing or Reviewing Work Groups
- 1.4 FHIR Resource Development Project Insight ID
- 1.5 Scope of coverage
- 1.6 RIM scope
- 1.7 Resource appropriateness
- 1.8 Expected implementations
- 1.9 Content sources
- 1.10 Example Scenarios
- 1.11 Resource Relationships
- 1.12 Timelines
- 1.13 gForge Users
- 1.14 When Resource Proposal Is Complete
- 1.15 FMG Notes
ObservationDefinition
Owning work group name
Committee Approval Date:
June 28, 2018
Contributing or Reviewing Work Groups
None
FHIR Resource Development Project Insight ID
Ordering Service Interface Specification Project (1010)
Scope of coverage
An instance of ObservationDefinition represents the definitional aspects of a kind of observation. This resource is used in a catalog of products or services for healthcare. It provides the definition of observations, which are used as input or produced as outcome of these products and services. The focus of the definitional aspects of ObservationDefinition is not on the action of performing observations of that kind. Rather, it is on the outcome of the observations. An instance of ObservationDefinition represents a set of constraints applicable to the value produced by observations of this kind. This set of constraints may have two utilities: 1) It guides the entry of the result of an observation of the kind defined. 2) It helps the consumer of the results of observations of that kind, to interpret properly these results.
For instance, in a catalog of laboratory in vitro diagnostic services, the ObservationDefinition resources describe the observations that should be provided by the orderer alongside an ordered service (questions asked at order entry or at specimen collection, prior results) as well as the observations that will be reported once the service has been performed.
In a catalog of medications, ObservationDefinition resources can be used to describe observations the result thereof need to be checked against the prescription of a particular medicinal product (therapeutic range, units ...)
In the catalog of tests of an in vitro diagnostic device, ObservationDefinition resources can be used to characterize (absolute range, unit, decimal precision, critical values ...) the observations that will be produced by the IVD tests performed by the device.
ObservationDefinition may be used to characterize observations from any discipline.
RIM scope
Observation class with moodCode="DEF"
Resource appropriateness
ObservationDefinition is a definitional resource conformant to the Definition pattern.
Like an instance of Observation, an instance of ObservationDefinition has a code, which identifies the kind of observation that is expected. Unlike an instance of Observation, though, an instance of ObservationDefinition does not have a value, since it is in definitional mood. The instance of ObservationDefinition has the properties that characterize the values expected from observations complying with this definition, such as: data types usable for value, multiple values allowed or not, various qualified ranges for numeric or ordinal results, various qualified value sets for coded values, units, decimal precision ...
In other words, an instance of ObservationDefinition acts as a set of constraints applicable to any instance of Observation claiming conformance to this definition.
ObservationDefinition instances lay in catalogs of products or services for healthcare, mostly as supportive resources to the entries of these catalogs. An example is: The definition of a "body temperature" observation to be provided at entry of an arterial blood gas service order.
Expected implementations
- Cognitive Medical Systems, Inc
- Intermountain Healthcare
- Phast
- Medlinx
- Quest Diagnostics
Content sources
One major source of specifications is represented by the electronic Directory of Services (eDOS) implementation guide of HL7 v2.x messages of chapter 8 "Master files". Although this implementation guide is built for the US realm, most of its technical content (definitions of services, specimens, observations) is recognized to cover the universal realm.
Example Scenarios
- A physician finds out which service to order to a diagnostic service facility, by querying the catalog of services of this facility and checking the output observations that are produced by each service.
- A CPOE application placing an order for a diagnostic service to a laboratory, discovers in the catalog entry describing this service what are the observations to provide at order entry and how to enter the results of those observations.
- A physician prescribing a medicinal product, checks from the catalog, which observation is to be included into the electronic prescription.
Resource Relationships
- Resource ObservationDefinition is referenced by resource ActivityDefinition. This enables items of catalogs, representing healthcare services or products, to declare the observations, which are consumed or produced by these items.
- It should also be considered that Observation.basedOn be able to reference ObservationDefinition resource.
- Resources Observation can be instantiated from the definition provided by ObservationDefinition (no operation defined yet for this purpose).
Timelines
This new resource is expected to be part or R4, like all the other pieces of catalogs of healthcare products/services.
It will be part of the Catalog tracks of FHIR connectathons, starting with January 2018.
gForge Users
N/A: Identified contributors already have a gForge account.
François Macary, Rob Hausam
When Resource Proposal Is Complete
When you have completed your proposal, please send an email to FMGcontact@HL7.org
