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

Difference between revisions of "CatalogEntry FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(migrate to Confluence)
 
(18 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/CatalogEntry+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 33: Line 33:
 
==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>
 +
This proposal was initially approved as EntryDefinition on:
 +
 +
22 Jun 2017
 +
 +
It has then been renamed CatalogEntry in July 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) -->
−
* Pharmacy
+
*Pharmacy
−
* Devices
+
*Devices
−
* BR&R
+
*BR&R
−
* II
+
*II
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
Line 49: Line 54:
 
==Scope of coverage==
 
==Scope of coverage==
  
−
The catalogEntry resource provides additional data and metadata about a definitional resource such as '''medication''', '''specimenDefinition''', '''device''', so that these resources can be bundled in a catalog of items - the catalog itself being implemented by a '''list''' or '''collection''' resource, or potentially a profile on '''Composition'''.
+
The CatalogEntry resource allows to organize resources representing the definition of {products|services|knowledge artifacts|plans|observations|chemical or biological substances|professionals|roles|organizations|locations|physical objects} within catalogs or compendia assisting practitioners and|or patients in processes of healthcare delivery.
  
−
The catalogEntry is a wrapper for the definitional items, adding data relative to
+
An instance of CatalogEntry contextualizes the inclusion of an item into a Catalog (represented by a Composition resource). For instance CatalogEntry specifies whether this item is orderable or not in the context of this catalog, it provides additional catalog-based context information such as the schedule of the delivery, the billing.
−
* the status of the item ("active", "inactive", "legacy", "informative"...) to support that catalog includes products that can be ordered and products that cannot be ordered.
+
 
−
* the CatalogEntry purpose ("orderable", ...)
+
In addition, catalog entries may be related to one another, in order to indicate the replacement of an obsolete entry by a new one, or to include an entry within another.  
−
* the relation between the item and other items ("contains", "includes", "requires"), to provide information for downstream systems to create a structured hierarchy or any other information graph, such as devices containing products, products containing substances, products requiring devices).
 
  
 
The catalogEntry does not overlap with the definitional resources.
 
The catalogEntry does not overlap with the definitional resources.
−
The catalogEntry provides a part of the functionality provided by SPL. SPL is appropriate for full product definitions in a controlled regulated exchange. For local, cut-down product catalogs (as most clinical systems) - in catalog download or product discovery based on a limited, ad-hoc set of characteristics - a FHIR resouce is a more flexible vehicle.
 
  
 
A catalogEntry will be present in any list of resources that represents or belongs to a structured list of items.
 
A catalogEntry will be present in any list of resources that represents or belongs to a structured list of items.
Line 76: Line 79:
 
<!-- 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. -->
  
−
The closest scope is in Entity or Acts in the case of services, much of which maps to the resources that are referenced by catalog Entry. You would use a Grouper class to wrap Acts, Observations, Procedures, etc to create an Master Record item.
 
  
 
Master file concepts were not specifically modelled as a topic area in v3 Messaging.
 
Master file concepts were not specifically modelled as a topic area in v3 Messaging.
Line 104: Line 106:
 
(Same as specimenDefinition)
 
(Same as specimenDefinition)
  
 +
Catalogs of laboratory services, which have relied on the exchange of HL7 v2 master files messages, are now looking for a more interactive sharing process, like the one offered by the RESTful API of FHIR.
  
 
==Content sources==
 
==Content sources==
Line 110: Line 113:
  
 
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? -->
−
* Review v3 Common Product Model as source for product list requirements
+
None
  
 
==Example Scenarios==
 
==Example Scenarios==
Line 118: Line 121:
 
*Laboratory Directory of Service
 
*Laboratory Directory of Service
  
−
*Medication Formulary
+
*In-patient Hospital Medication Formulary
  
 
*Human Services Directory
 
*Human Services Directory
Line 135: Line 138:
 
  -->
 
  -->
  
−
The catalogEntry resource/pattern relates to the following definitional resources:
+
The CatalogEntry resource references these definitional resources: DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | MedicationKnowledge | Substance | Location
−
* '''medication'''
 
−
* '''device'''
 
−
* '''specimenDefinition'''
 
  
−
the catalogEntry can also be used to exchange catalogs of procedures or protocols, and as such can be used with other resources such as '''serviceDefinition''' and '''activityDefinition'''.
+
the CatalogEntry is referenced by the Composition resource under the Catalog profile.  
  
−
A Catalog will be represented by a profile of Composition, which will contain catalogEntries as individual items.
+
An instance of a CatalogEntry resource may reference other instances of this resource type as related catalog entries. These relationships have a semantic qualification: triggers | is-replaced-by | excludes | includes.
  
 
==Timelines==
 
==Timelines==
Line 148: Line 148:
 
<!-- 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 -->
 
The timelines for the catalogEntry depend mostly on alignment with other WGs.
 
The timelines for the catalogEntry depend mostly on alignment with other WGs.
−
The resource or pattern is aimed at STU4.
+
The resource is aimed at STU4.
−
 
 
  
 
==gForge Users==
 
==gForge Users==
Line 157: Line 156:
  
 
lconstab
 
lconstab
 +
 +
fmacary
  
 
==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 15:01, 31 October 2019

Current Version: https://confluence.hl7.org/display/FHIR/CatalogEntry+FHIR+Resource+Proposal
OpenHotTopic.GIF

This page documents a Pending FHIR Resource Proposal



catalogEntry

Owning committee name

Orders & Observations WG

Committee Approval Date:

Please enter the date that the committee approved this Resource proposal This proposal was initially approved as EntryDefinition on:

22 Jun 2017

It has then been renamed CatalogEntry in July 2018

Contributing or Reviewing Work Groups

  • Pharmacy
  • Devices
  • BR&R
  • II

FHIR Resource Development Project Insight ID

1010

Scope of coverage

The CatalogEntry resource allows to organize resources representing the definition of {products|services|knowledge artifacts|plans|observations|chemical or biological substances|professionals|roles|organizations|locations|physical objects} within catalogs or compendia assisting practitioners and|or patients in processes of healthcare delivery.

An instance of CatalogEntry contextualizes the inclusion of an item into a Catalog (represented by a Composition resource). For instance CatalogEntry specifies whether this item is orderable or not in the context of this catalog, it provides additional catalog-based context information such as the schedule of the delivery, the billing.

In addition, catalog entries may be related to one another, in order to indicate the replacement of an obsolete entry by a new one, or to include an entry within another.

The catalogEntry does not overlap with the definitional resources.

A catalogEntry will be present in any list of resources that represents or belongs to a structured list of items.


RIM scope

Master file concepts were not specifically modelled as a topic area in v3 Messaging.

Resource appropriateness

This represents the concept of exchanging Master Files of products, services, (e.g. medications and labs)

Catalogs and Master files have a need for explicit maintenance and exchange.

Expected implementations

The recent focus on terminology consistency on products (UDI, IDMP, openMedicine) has shown a good interest from vendors and agencies in providing product information in a standard format. FHIR is a vehicle for such information (Same as specimenDefinition)

Catalogs of laboratory services, which have relied on the exchange of HL7 v2 master files messages, are now looking for a more interactive sharing process, like the one offered by the RESTful API of FHIR.

Content sources

None

Example Scenarios

  • Laboratory Directory of Service
  • In-patient Hospital Medication Formulary
  • Human Services Directory
  • Medical Device Catalog

Resource Relationships

The CatalogEntry resource references these definitional resources: DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | MedicationKnowledge | Substance | Location

the CatalogEntry is referenced by the Composition resource under the Catalog profile.

An instance of a CatalogEntry resource may reference other instances of this resource type as related catalog entries. These relationships have a semantic qualification: triggers | is-replaced-by | excludes | includes.

Timelines

The timelines for the catalogEntry depend mostly on alignment with other WGs. The resource is aimed at STU4.

gForge Users

cnanjo

lconstab

fmacary

When Resource Proposal Is Complete

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

Retrieved from "https://wiki.hl7.org/w/index.php?title=CatalogEntry_FHIR_Resource_Proposal&oldid=166863"