Difference between revisions of "CatalogEntry FHIR Resource Proposal"
(migrate to Confluence) |
|||
| (32 intermediate revisions by 3 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 | ||
==FHIR Resource Development Project Insight ID== | ==FHIR Resource Development Project Insight ID== | ||
| Line 48: | Line 54: | ||
==Scope of coverage== | ==Scope of coverage== | ||
| − | The | + | 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. | 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. | A catalogEntry will be present in any list of resources that represents or belongs to a structured list of items. | ||
| Line 73: | Line 78: | ||
<!-- 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. --> | ||
| + | |||
| + | |||
| + | Master file concepts were not specifically modelled as a topic area in v3 Messaging. | ||
==Resource appropriateness== | ==Resource appropriateness== | ||
| Line 88: | Line 96: | ||
* 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 | ||
--> | --> | ||
| + | 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== | ==Expected implementations== | ||
| Line 95: | 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 101: | 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? --> | ||
| + | None | ||
==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.) --> | ||
| + | |||
| + | *Laboratory Directory of Service | ||
| + | |||
| + | *In-patient Hospital Medication Formulary | ||
| + | |||
| + | *Human Services Directory | ||
| + | |||
| + | *Medical Device Catalog | ||
==Resource Relationships== | ==Resource Relationships== | ||
| Line 117: | Line 138: | ||
--> | --> | ||
| − | The | + | The CatalogEntry resource references these definitional resources: DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | MedicationKnowledge | Substance | Location |
| − | |||
| − | |||
| − | |||
| − | the | + | 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== | ==Timelines== | ||
| Line 129: | 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 | + | The resource is aimed at STU4. |
| − | |||
==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.) --> | ||
| + | cnanjo | ||
| + | |||
| + | 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
This page documents a Pending FHIR Resource Proposal
Contents
- 1 catalogEntry
- 1.1 Owning committee 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
catalogEntry
Owning committee name
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
