This wiki has undergone a migration to Confluence found Here

Difference between revisions of "201709 Terminology Services Track"

From HL7Wiki
Jump to navigation Jump to search
Line 2: Line 2:
 
[[Category:201709_FHIR_Connectathon_Track_Proposals|Sept 2017 Proposals]]
 
[[Category:201709_FHIR_Connectathon_Track_Proposals|Sept 2017 Proposals]]
 
__NOTOC__
 
__NOTOC__
 +
 +
[http://wiki.hl7.org/index.php?title=Category:201705_FHIR_Connectathon_Track_Proposals Return to May 2017 Proposals]
 +
[[Category:201705_FHIR_Connectathon_Track_Proposals|May 2017 Proposals]]
 +
__NOTOC__
 +
=Terminology Services=
 +
 +
==Submitting WG/Project/Implementer Group==
 +
<!-- Who is asking for this track? -->
 +
FHIR Management Group (FMG)
 +
 +
==Justification==
 +
<!--Why is this an important track to include in the connectathon - include implementer need, impact on ballot, FMM readiness of the resources, etc. -->
 +
The FHIR specification includes support for the provision of a terminology service - that is, a service that lets healthcare applications make use of codes and value sets without having to become experts in the fine details of the value set resource, and the underlying code systems.  The management and proper use of terminology is fundamental to effective, interoperable data exchange, so this is an important capability to provide and test in the Connectathons.
 +
 +
[https://fhirblog.com/2016/09/16/terminology-services/ David Hay's blog post on Terminology Services]
 +
 +
==Proposed Track Lead==
 +
<!-- Name, email and Skype id of individual who will coordinate the track at the connectathon -->
 +
Coordinator: [mailto:rrhausam@gmail.com Rob Hausam]  (There is a dedicated Zulip topic on the implementers stream for Terminology Services - https://chat.fhir.org/#narrow/stream/implementers/subject/Connectathon.20Terminology.20Services.20Track
 +
 +
==Expected participants==
 +
<!-- List of the individuals and/or organizations that have indicated a desire to attend the connectathon and implement this track -->
 +
*[http://fhir3.healthintersections.com.au/open Health Intersections - server]
 +
*[https://touchstone.aegis.net/touchstone AEGIS - Touchstone tool and test scripts]
 +
*Apelon - Terminology Server (uid/pwd dtsadminuser/dtsadmin): http://fhir.ext.apelon.com/dtsserverws/fhir
 +
*Lantana - FHIR services on Trifolia
 +
*[http://ontoserver.csiro.au/baltimore CSIRO - server]
 +
*[[NLM - FHIR services on VSAC]]
 +
*[http://implementation.e-imo.com/fhir/Lexical IMO - FHIR services on IMO ProblemIT/ProcedureIT]
 +
*[http://its.patientsfirst.org.nz/RestService.svc/Terminz/ Terminz]
 +
*[[Health Language FHIR terminology  services (new)]]
 +
*[http://test.hausamconsulting.com/fhir/ Hausam Consulting test server]
 +
*Additional servers and clients
 +
 +
==Roles==
 +
<!-- Roles are sets of functionality (generally defined by a Conformance resource) that a single system can take on -->
 +
===FHIR Terminology Server===
 +
<!-- Provide a description of the capabilities this role will have within the connectathon -->
 +
For service providers, implement the following operations from http://hl7.org/fhir/terminology-service.html:
 +
* $expand - [http://hl7.org/fhir/2016May/terminology-service.html#2.5.1.3 Value Set Expansion]
 +
* $validate-code - [http://hl7.org/fhir/2016May/terminology-service.html#2.5.1.5 Value Set Validation]
 +
* $lookup - [http://hl7.org/fhir/2016May/terminology-service.html#2.5.1.4 Concept Lookup]
 +
* $translate - [http://hl7.org/fhir/2016May/terminology-service.html#2.5.1.8 Translations] (note: there is a typo on the terminology service page for Batch Translation where the text states "validate" not "translate")
 +
* $closure - [http://hl7.org/fhir/2016May/terminology-service.html#closure Maintaining a Closure Table]
 +
Support additional capabilities:
 +
* Expansion Profile (experimental) - [http://wiki.hl7.org/index.php?title=ExpansionProfile_FHIR_Resource_Proposal Expansion Profile FHIR Resource Proposal]
 +
* SNOMED CT and LOINC implicit value sets - [http://hl7-fhir.github.io/snomedct.html#implicit]  [http://hl7-fhir.github.io/loinc.html#1.25.1.3.7]
 +
* Support ConceptMap, ValueSet resources and operations ($expand, $validate-code, $lookup) referencing code systems using the new CodeSystem resource (instead of ValueSet.codeSystem)''' - NEW'''
 +
 +
Service providers are not required to implement all of this functionality - it's a lot to do. For new implementers, start at the top and work down (generally).
 +
 +
===FHIR Terminology Client Consumer===
 +
<!-- Provide a description of the capabilities this role will have within the connectathon -->
 +
Implement any one or more of:
 +
* Do a value set expansion of one of the value sets in the spec
 +
* Validate a code using the spec against a FHIR value set, a v2 value set, or LOINC or snomed CT
 +
* Look up a display for a code (most appropriate for v2/FHIR conversion)
 +
* Translate a code from one value set to another, based on the existing value set and ConceptMap resources, and/or other additional knowledge available to the server
 +
* Maintain a client-side closure table based on server-side terminological logic
 +
* Experiment with the capabilities of the expansion profile (see description above of the expected capabilities and scenarios)
 +
* References to SNOMED CT and LOINC implicit value sets
 +
* Create (POST, PUT) ValueSet resources referencing in-line and/or external code systems
 +
* Create and perform operations ($expand, $validate-code, $lookup) on ValueSet resources referencing code systems using the new CodeSystem resource (instead of ValueSet.codeSystem)''' - NEW'''
 +
 +
At least one server supports all of these operations and capabilities (http://fhir3.healthintersections.com.au). Other servers, including the Apelon server (http://fhir.ext.apelon.com/dtsserverws/fhir) and the others listed above will support several of these operations and capabilities. For a list of functions supported by the Apelon Server, see the demo web app (http://fhir.ext.apelon.com/DtsOnFhirDemo, uid/pwd dtsadminuser/dtsadmin).
 +
 +
==Scenarios==
 +
<!-- What will be the actions performed by participants? -->
 +
 +
===Scenarios - See server and client roles as listed above===
 +
 +
<!-- Provide a description of each task -->
 +
 +
==TestScripts==
 +
<!-- Optional (for initial proposal): Provide links to the TestScript instance(s) that define the behavior to be tested. 
 +
These should be committed to SVN under trunk/connectathons/[connectathon]
 +
-->
 +
The supporting TestScripts and corresponding fixtures have been committed to the FHIR SVN repository at:
 +
http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2Ftrunk%2Fconnectathons%2FMadridMay2017%2FConnectathon15%2FTerminology%2F
 +
 +
<!--
 
=Track Name=
 
=Track Name=
  
Line 37: Line 118:
 
<!-- Optional (for initial proposal): Provide links to the TestScript instance(s) that define the behavior to be tested.   
 
<!-- Optional (for initial proposal): Provide links to the TestScript instance(s) that define the behavior to be tested.   
 
These should be committed to SVN under trunk/connectathons/[connectathon]
 
These should be committed to SVN under trunk/connectathons/[connectathon]
 +
-->
 
-->
 
-->

Revision as of 08:37, 8 June 2017

Return to Sept 2017 Proposals


Return to May 2017 Proposals

Terminology Services

Submitting WG/Project/Implementer Group

FHIR Management Group (FMG)

Justification

The FHIR specification includes support for the provision of a terminology service - that is, a service that lets healthcare applications make use of codes and value sets without having to become experts in the fine details of the value set resource, and the underlying code systems. The management and proper use of terminology is fundamental to effective, interoperable data exchange, so this is an important capability to provide and test in the Connectathons.

David Hay's blog post on Terminology Services

Proposed Track Lead

Coordinator: Rob Hausam (There is a dedicated Zulip topic on the implementers stream for Terminology Services - https://chat.fhir.org/#narrow/stream/implementers/subject/Connectathon.20Terminology.20Services.20Track

Expected participants

Roles

FHIR Terminology Server

For service providers, implement the following operations from http://hl7.org/fhir/terminology-service.html:

Support additional capabilities:

  • Expansion Profile (experimental) - Expansion Profile FHIR Resource Proposal
  • SNOMED CT and LOINC implicit value sets - [1] [2]
  • Support ConceptMap, ValueSet resources and operations ($expand, $validate-code, $lookup) referencing code systems using the new CodeSystem resource (instead of ValueSet.codeSystem) - NEW

Service providers are not required to implement all of this functionality - it's a lot to do. For new implementers, start at the top and work down (generally).

FHIR Terminology Client Consumer

Implement any one or more of:

  • Do a value set expansion of one of the value sets in the spec
  • Validate a code using the spec against a FHIR value set, a v2 value set, or LOINC or snomed CT
  • Look up a display for a code (most appropriate for v2/FHIR conversion)
  • Translate a code from one value set to another, based on the existing value set and ConceptMap resources, and/or other additional knowledge available to the server
  • Maintain a client-side closure table based on server-side terminological logic
  • Experiment with the capabilities of the expansion profile (see description above of the expected capabilities and scenarios)
  • References to SNOMED CT and LOINC implicit value sets
  • Create (POST, PUT) ValueSet resources referencing in-line and/or external code systems
  • Create and perform operations ($expand, $validate-code, $lookup) on ValueSet resources referencing code systems using the new CodeSystem resource (instead of ValueSet.codeSystem) - NEW

At least one server supports all of these operations and capabilities (http://fhir3.healthintersections.com.au). Other servers, including the Apelon server (http://fhir.ext.apelon.com/dtsserverws/fhir) and the others listed above will support several of these operations and capabilities. For a list of functions supported by the Apelon Server, see the demo web app (http://fhir.ext.apelon.com/DtsOnFhirDemo, uid/pwd dtsadminuser/dtsadmin).

Scenarios

Scenarios - See server and client roles as listed above

TestScripts

The supporting TestScripts and corresponding fixtures have been committed to the FHIR SVN repository at: http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2Ftrunk%2Fconnectathons%2FMadridMay2017%2FConnectathon15%2FTerminology%2F


Justification

Proposed Track Lead

See Connectathon_Track_Lead_Responsibilities

Expected participants

Roles

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

Role 1 Name

Scenarios

Scenario Step 1 Name

Action:
Precondition:
Success Criteria:
Bonus point:


TestScript(s)

-->