This wiki has undergone a migration to Confluence found Here

Difference between revisions of "210901 Order Catalog"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template for FHIR Connectathon Track Proposals}}")
 
Line 2: Line 2:
 
[[Category:201901_FHIR_Connectathon_Track_Proposals|Jan2019 Proposals]]
 
[[Category:201901_FHIR_Connectathon_Track_Proposals|Jan2019 Proposals]]
 
__NOTOC__
 
__NOTOC__
=Track Name=
+
=Order Catalog=
  
 
==Submitting WG/Project/Implementer Group==
 
==Submitting WG/Project/Implementer Group==
 
<!-- Who is asking for this track? -->
 
<!-- Who is asking for this track? -->
 +
* Orders and Observations WG
  
 
==Justification==
 
==Justification==
 
<!--Why is this an important track to include in the connectathon - include implementer need, impact on ballot, FMM readiness of the resources, etc. -->
 
<!--Why is this an important track to include in the connectathon - include implementer need, impact on ballot, FMM readiness of the resources, etc. -->
 +
Resources and Resource profiles needed to support catalogs of various types (lab compendia, medication formularies, healthcare service directories, etc) are in an early draft stage.  These include a Catalog profile on Composition, a CatalogEntry resource, an ObservationDefinition resource, a SpecimenDefinition resource, and potentially a profile on ActivityDefinition. This connectathon track is intended to test the design approach and confirm the resource set meets the needs of the use case.
 +
<!-- The track is based on the September R4 ballot
  
 +
This will inform the development of the catalog resources, with a goal of reaching FMM 1 for FHIR Release. 
 +
 +
==FHIR version used==
 +
For this connectathon the catalog track will be based on the current build of FHIR.
 +
The reason for that is that a number of resources used by Catalogs (CatalogEntry, ObservationDefinition, SpecimenDefinition) have evolved after the publication of the September ballot. And these late evolutions are needed for this testing session.
 +
-->
  
 
==Clinical input requested==
 
==Clinical input requested==
Line 20: Line 29:
 
<!-- Name, email and Skype id of individual who will coordinate the track at the connectathon -->
 
<!-- Name, email and Skype id of individual who will coordinate the track at the connectathon -->
 
See [[Connectathon_Track_Lead_Responsibilities]]
 
See [[Connectathon_Track_Lead_Responsibilities]]
 +
:Fran&#231;ois Macary
 +
::Email: francois.macary@phast.fr
 +
::Zulip: Fran&#231;ois Macary
  
 
==Expected participants==
 
==Expected participants==
 
<!-- List of the individuals and/or organizations that have indicated a desire to attend the connectathon and implement this track -->
 
<!-- List of the individuals and/or organizations that have indicated a desire to attend the connectathon and implement this track -->
 +
The following organizations have indicated an interest in participating in this track:
 +
*Phast (France) - a FHIR server supporting a clinical lab compendium.
 +
*University of Utah will participate with a FHIR client able to query a lab compendium.
 +
*Quest Diagnostics (US laboratory) acting as a client administrating a lab compendium
 +
* Medlinx/Helix (Russian laboratory) acting as a client administrating and querying a lab compendium
  
 
==Roles==
 
==Roles==
 
Please include information here regarding how much advance preparation will be required if creating a client and/or server.
 
Please include information here regarding how much advance preparation will be required if creating a client and/or server.
 
<!-- Roles are sets of functionality (generally defined by a Conformance resource) that a single system can take on -->
 
<!-- Roles are sets of functionality (generally defined by a Conformance resource) that a single system can take on -->
===Role 1 Name===
+
===Catalog Server===
 
<!-- Provide a description of the capabilities this role will have within the connectathon -->
 
<!-- Provide a description of the capabilities this role will have within the connectathon -->
 +
A FHIR Server should support the following resources for this track:
 +
* Catalog Profile of Composition
 +
* CatalogEntry
 +
* Content resources appropriate to the type of catalog. For Lab:
 +
**ActivityDefinition
 +
**SpecimenDefinition
 +
**ObservationDefinition
 +
 +
A FHIR server is available for testing with sample data
 +
 +
<!-- http://jade.phast.fr/Baltimore-Catalog/api/FHIR/ -->
 +
 +
===Catalog Consumer===
 +
* University of Utah: Client browsing the content of a clinical laboratory compendium
 +
* Quest Diagnostics: Client administrating a clinical laboratory compendium
  
 
==Scenarios==
 
==Scenarios==
 
<!-- What will be the actions performed by participants? -->
 
<!-- What will be the actions performed by participants? -->
 +
This connectathon track will test the following interactions based on a clinical laboratory compendium:
 +
===Administration of the catalog by a clinical laboratory===
 +
* Creation of new catalog entries
 +
* Update of catalog entries
 +
* Retirement of a catalog entry and replacement by another one
 +
All these interactions use Bundle of type "transaction" and "transaction-response"
 +
 +
===Query and retrieval of catalog entries by a CPOE system===
 +
====Search Catalog by title====
 +
GET [base]/composition?title=[Catalog.title]
 +
 +
Example: http://jade.phast.fr/catalogs/api/fhir/composition?title=CIOlab
 +
 +
====Check Catalog by id====
 +
GET [base]/composition/[catalogId]
 +
 +
Example: http://jade.phast.fr/catalogs/api/fhir/composition/2
 +
 +
====Search catalog entry by name of specialty====
 +
Example: search for virology orderable tests and panels
 +
 +
====Search catalog entry by name of orderable service====
 +
Example: search all entries corresponding to orderable tests or panels containing the word "sodium"
  
===Scenario Step 1 Name===
+
====Retrieve details for an orderable diagnostic service====
:Action: <!--Who does what?  (Use the role names listed above when referring to the participants -->
 
:Precondition: <!-- What setup is required prior to executing this step? -->
 
:Success Criteria: <!-- How will the participants know if the test was successful? -->
 
:Bonus point: <!-- Any additional complexity to make the scenario more challenging -->
 
  
<!-- Provide a description of each task -->
+
GET [base]/CatalogEntry?_has:Composition:_id=2&_id=[CatalogEntry id]
  
 
==TestScript(s)==
 
==TestScript(s)==
Line 45: Line 96:
 
These should be committed to SVN under trunk/connectathons/[connectathon]
 
These should be committed to SVN under trunk/connectathons/[connectathon]
 
-->
 
-->
 +
None.
  
 
==Security and Privacy Considerations==
 
==Security and Privacy Considerations==

Revision as of 13:24, 9 November 2018


Order Catalog

Submitting WG/Project/Implementer Group

  • Orders and Observations WG

Justification

Resources and Resource profiles needed to support catalogs of various types (lab compendia, medication formularies, healthcare service directories, etc) are in an early draft stage. These include a Catalog profile on Composition, a CatalogEntry resource, an ObservationDefinition resource, a SpecimenDefinition resource, and potentially a profile on ActivityDefinition. This connectathon track is intended to test the design approach and confirm the resource set meets the needs of the use case.

Clinical input requested

Related tracks

Proposed Track Lead

See Connectathon_Track_Lead_Responsibilities

François Macary
Email: francois.macary@phast.fr
Zulip: François Macary

Expected participants

The following organizations have indicated an interest in participating in this track:

  • Phast (France) - a FHIR server supporting a clinical lab compendium.
  • University of Utah will participate with a FHIR client able to query a lab compendium.
  • Quest Diagnostics (US laboratory) acting as a client administrating a lab compendium
  • Medlinx/Helix (Russian laboratory) acting as a client administrating and querying a lab compendium

Roles

Please include information here regarding how much advance preparation will be required if creating a client and/or server.

Catalog Server

A FHIR Server should support the following resources for this track:

  • Catalog Profile of Composition
  • CatalogEntry
  • Content resources appropriate to the type of catalog. For Lab:
    • ActivityDefinition
    • SpecimenDefinition
    • ObservationDefinition

A FHIR server is available for testing with sample data


Catalog Consumer

  • University of Utah: Client browsing the content of a clinical laboratory compendium
  • Quest Diagnostics: Client administrating a clinical laboratory compendium

Scenarios

This connectathon track will test the following interactions based on a clinical laboratory compendium:

Administration of the catalog by a clinical laboratory

  • Creation of new catalog entries
  • Update of catalog entries
  • Retirement of a catalog entry and replacement by another one

All these interactions use Bundle of type "transaction" and "transaction-response"

Query and retrieval of catalog entries by a CPOE system

Search Catalog by title

GET [base]/composition?title=[Catalog.title]

Example: http://jade.phast.fr/catalogs/api/fhir/composition?title=CIOlab

Check Catalog by id

GET [base]/composition/[catalogId]

Example: http://jade.phast.fr/catalogs/api/fhir/composition/2

Search catalog entry by name of specialty

Example: search for virology orderable tests and panels

Search catalog entry by name of orderable service

Example: search all entries corresponding to orderable tests or panels containing the word "sodium"

Retrieve details for an orderable diagnostic service

GET [base]/CatalogEntry?_has:Composition:_id=2&_id=[CatalogEntry id]

TestScript(s)

None.

Security and Privacy Considerations