This wiki has undergone a migration to Confluence found Here
Difference between revisions of "201901 Terminology Services"
Jump to navigation
Jump to search
(Created page with "{{subst::Template for FHIR Connectathon Track Proposals}}") |
|||
| Line 1: | Line 1: | ||
| + | [http://wiki.hl7.org/index.php?title=FHIR_Connectathon_20 Return to Connectathon 20 page] | ||
| + | [http://wiki.hl7.org/index.php?title=Category:201901_FHIR_Connectathon_Track_Proposals Return to Jan 2019 Proposals] | ||
[[Category:201901_FHIR_Connectathon_Track_Proposals|Jan2019 Proposals]] | [[Category:201901_FHIR_Connectathon_Track_Proposals|Jan2019 Proposals]] | ||
__NOTOC__ | __NOTOC__ | ||
| − | = | + | =Terminology Services= |
==Submitting WG/Project/Implementer Group== | ==Submitting WG/Project/Implementer Group== | ||
<!-- Who is asking for this track? --> | <!-- Who is asking for this track? --> | ||
| + | Vocabulary WG/FMG | ||
==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. --> | ||
| + | The FHIR specification includes support for the provision of a [http://hl7.org/fhir/2018Sep/terminology-service.html 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 sets and underlying code systems and their related resources. 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] | ||
==Clinical input requested== | ==Clinical input requested== | ||
| Line 20: | Line 25: | ||
<!-- 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]] | ||
| + | [mailto:rrhausam@gmail.com Rob Hausam], [mailto:pkjordan@xtra.co.nz Peter Jordan] | ||
| + | |||
| + | ==Track Administration== | ||
| + | Connectathon Management Tool: [http://conman.fhir.org/connectathon.html?event=baltimore2018 ConMan: WGM Baltimore September 2018] | ||
| + | |||
| + | Messaging & Communications: [https://chat.fhir.org/#narrow/stream/connectathon.20mgmt/topic/Terminology.20Services.20Track Zulip Chat Stream] | ||
| + | |||
| + | Test Support: [mailto:richard.ettema@aegis.net Richard Ettema] | ||
| + | |||
| + | Orientation Slides: [https://drive.google.com/open?id=1E5bzAiLdRi4ZjA8ZrJv7N2duunW5vY-N Terminology Services Track Orientation Slides] | ||
| + | |||
| + | Orientation Recording: [https://youtu.be/ezv3bGZfLQk Click here to play recording] | ||
==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 --> | ||
| + | *[http://test.fhir.org/r4 Health Intersections - FHIR Server] | ||
| + | *[https://touchstone.aegis.net/touchstone AEGIS - Touchstone tool and test scripts] | ||
| + | *Apelon (Terminology Service): http://fhir.ext.apelon.com:7080/dts/fhir/ and Demo Page at http://fhir.ext.apelon.com:7080/DtsOnFhirDemo/logon/Logon.action | ||
| + | **Through a collaboration with the American Medical Association, the Current Procedural Terminology (CPT®) is now available for use in FHIR development efforts through the Apelon DTS on FHIR® service. Authentication is required. Please send an email to support@apelon.com (or on-site to cmacumber@apelon.com) for a user/pass. Please note that use of CPT® for production or commercial purposes through this service is prohibited.* | ||
| + | *Lantana - FHIR services on Trifolia | ||
| + | *[https://ontoserver.csiro.au/stu3-latest CSIRO Australia - Ontoserver] | ||
| + | *[[NLM - FHIR services on VSAC]] | ||
| + | *[https://fhirconnectathon.e-imo.com/ IMO - FHIR services on FHIR R4] | ||
| + | *[http://its.patientsfirst.org.nz/RestService.svc/Terminz Patients First NZ Terminology Server] | ||
| + | *[[Health Language FHIR terminology services]] | ||
| + | *[http://fhir.hausamconsulting.com/ Hausam Consulting test server] | ||
| + | *[http://jade.phast.fr/FHIR_CONNECTATHON/api/Fhir/ PHAST Standard Terminology Services] | ||
| + | |||
| + | *Additional servers and clients | ||
==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 --> | ||
| − | === | + | ===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/2018Sep/terminology-service.html: | ||
| + | * $expand - [http://hl7.org/fhir/2018Sep/valueset-operations.html#expand Value Set Expansion] | ||
| + | * $validate-code - [http://hl7.org/fhir/2018Sep/valueset-operations.html#validate-code Value Set Validation] | ||
| + | * $lookup - [http://hl7.org/fhir/2018Sep/codesystem-operations.html#lookup Concept Lookup] | ||
| + | * $validate-code - [http://hl7.org/fhir/2018Sep/codesystem-operations.html#validate-code Code System Validation] | ||
| + | * $subsumes - [http://hl7.org/fhir/2018Sep/codesystem-operations.html#subsumes Subsumption Testing] | ||
| + | * $translate - [http://hl7.org/fhir/2018Sep/conceptmap-operations.html#translate Concept Translation] | ||
| + | * $closure - [http://hl7.org/fhir/2018Sep/conceptmap-operations.html#closure Maintaining a Closure Table] | ||
| + | Support additional capabilities: | ||
| + | * Capability Statement [http://hl7.org/fhir/2018Sep/capabilitystatement-terminology-server.html Produce a Terminology Service Capability Statement] | ||
| + | * SNOMED CT and LOINC implicit value sets - [http://hl7.org/fhir/2018Sep/snomedct.html using SNOMED CT with FHIR] and [http://hl7.org/fhir/2018Sep/loinc.html using LOINC with FHIR] | ||
| + | * $find-matches - [http://hl7.org/fhir/2018Sep/codesystem-operations.html#find-matches Finding codes based on supplied properties (experimental)] | ||
| + | |||
| + | 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 --> | <!-- 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, LOINC or SNOMED CT | ||
| + | * Validate a code using the spec against a code system such as 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 | ||
| + | * References to SNOMED CT and LOINC implicit value sets | ||
| + | * Create (POST, PUT) ValueSet resources referencing in-line and/or external code systems | ||
| + | |||
| + | At least one server supports all of these operations and capabilities (http://test.fhir.org/r4). 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). | ||
| + | |||
| + | ==Pre-Requisites== | ||
| + | |||
| + | '''For all levels of testing the required pre-requisite is the fundamental requirement that all FHIR servers ''SHALL'' support the [http://hl7.org/fhir/2018May/http.html#capabilities capabilities] interaction.''' | ||
| + | |||
| + | The FHIR Terminology Servers under test are expected to have already downloaded and installed the required resources (Code Systems, Value Sets & Concept Maps). | ||
| + | |||
| + | ==Test Scripts== | ||
| + | |||
| + | This track includes formal testing and reporting of test results utilizing a defined set of test scripts. | ||
| + | |||
| + | The TestScript and terminology content resources will be committed to the FHIR documents Github repository at: | ||
| + | [https://github.com/FHIR/documents/tree/master/connectathons FHIR/documents/tree/master/connectathons] | ||
| + | Please contact [mailto:grahame@healthintersections.com.au Grahame Grieve] if you require commit privileges to this repository; otherwise, you may forward your TestScripts and related artifacts to [mailto:richard.ettema@aegis.net Richard Ettema] who will get them committed. | ||
| + | |||
| + | '''Additional Resources:''' | ||
| + | * [https://github.com/FHIR/documents/blob/master/connectathons/SanDiegoSep2017/Connectathon16/Terminology-Formal/FHIR%20Connectathon%2016%20Terminology%20Formal%20Tests.xlsx Terminology Test Definition Spreadsheet] - Example proposals for Terminology tests (positive and negative) from the Connectathon 16 event held in San Diego | ||
==Scenarios== | ==Scenarios== | ||
Revision as of 06:55, 6 November 2018
Return to Connectathon 20 page Return to Jan 2019 Proposals
Terminology Services
Submitting WG/Project/Implementer Group
Vocabulary WG/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 sets and underlying code systems and their related resources. 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
Clinical input requested
Related tracks
Proposed Track Lead
See Connectathon_Track_Lead_Responsibilities Rob Hausam, Peter Jordan
Track Administration
Connectathon Management Tool: ConMan: WGM Baltimore September 2018
Messaging & Communications: Zulip Chat Stream
Test Support: Richard Ettema
Orientation Slides: Terminology Services Track Orientation Slides
Orientation Recording: Click here to play recording
Expected participants
- Health Intersections - FHIR Server
- AEGIS - Touchstone tool and test scripts
- Apelon (Terminology Service): http://fhir.ext.apelon.com:7080/dts/fhir/ and Demo Page at http://fhir.ext.apelon.com:7080/DtsOnFhirDemo/logon/Logon.action
- Through a collaboration with the American Medical Association, the Current Procedural Terminology (CPT®) is now available for use in FHIR development efforts through the Apelon DTS on FHIR® service. Authentication is required. Please send an email to support@apelon.com (or on-site to cmacumber@apelon.com) for a user/pass. Please note that use of CPT® for production or commercial purposes through this service is prohibited.*
- Lantana - FHIR services on Trifolia
- CSIRO Australia - Ontoserver
- NLM - FHIR services on VSAC
- IMO - FHIR services on FHIR R4
- Patients First NZ Terminology Server
- Health Language FHIR terminology services
- Hausam Consulting test server
- PHAST Standard Terminology Services
- Additional servers and clients
Roles
Please include information here regarding how much advance preparation will be required if creating a client and/or server.
FHIR Terminology Server
For service providers, implement the following operations from http://hl7.org/fhir/2018Sep/terminology-service.html:
- $expand - Value Set Expansion
- $validate-code - Value Set Validation
- $lookup - Concept Lookup
- $validate-code - Code System Validation
- $subsumes - Subsumption Testing
- $translate - Concept Translation
- $closure - Maintaining a Closure Table
Support additional capabilities:
- Capability Statement Produce a Terminology Service Capability Statement
- SNOMED CT and LOINC implicit value sets - using SNOMED CT with FHIR and using LOINC with FHIR
- $find-matches - Finding codes based on supplied properties (experimental)
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, LOINC or SNOMED CT
- Validate a code using the spec against a code system such as 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
- References to SNOMED CT and LOINC implicit value sets
- Create (POST, PUT) ValueSet resources referencing in-line and/or external code systems
At least one server supports all of these operations and capabilities (http://test.fhir.org/r4). 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).
Pre-Requisites
For all levels of testing the required pre-requisite is the fundamental requirement that all FHIR servers SHALL support the capabilities interaction.
The FHIR Terminology Servers under test are expected to have already downloaded and installed the required resources (Code Systems, Value Sets & Concept Maps).
Test Scripts
This track includes formal testing and reporting of test results utilizing a defined set of test scripts.
The TestScript and terminology content resources will be committed to the FHIR documents Github repository at: FHIR/documents/tree/master/connectathons Please contact Grahame Grieve if you require commit privileges to this repository; otherwise, you may forward your TestScripts and related artifacts to Richard Ettema who will get them committed.
Additional Resources:
- Terminology Test Definition Spreadsheet - Example proposals for Terminology tests (positive and negative) from the Connectathon 16 event held in San Diego
Scenarios
Scenario Step 1 Name
- Action:
- Precondition:
- Success Criteria:
- Bonus point:
