201605 Terminology Services Track Proposal

Return to May 2016 Proposals

FHIR 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.

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

• Health Intersections - server
• AEGIS - Touchstone tool and test scripts
• Apelon - server
• Lantana - FHIR services on Trifolia
• CSIRO - server
• NLM - FHIR services on VSAC
• IMO - FHIR services on IMO ProblemIT
• Multiple additional servers
• Multiple clients

Roles

FHIR Terminology Server

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

• $expand - Value Set Expansion
• $validate-code - Value Set Validation (note: there are a few typos on the terminology service page where this operation is referred to as "validate" but is actually "validate-code" - editorial oversight)
• $lookup - Concept Lookup
• $translate - Translations (note: there is a typo on the terminology service page for Batch Translation where the text states "validate" not "translate")
• $closure - Maintaining a Closure Table

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://fhir2.healthintersections.com.au). Other servers, including the Apelon server (http://fhir.ext.apelon.com:8081/DtsOnFhirDemo) and the others listed above will support several of these operations and capabilities.

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%2FMontrealMay2016%2FConnectathon12%2FTrack-16-Terminology%2F

TestScript Definitions

The TestScript resources in this folder represent an evolution** of the TestScript originally used at the 1st Terminology Services Connectathon held in Washington, February 2014 and then subsequently expanded upon at the FHIR Connectathon 10 in Atlanta, GA and 11 in Orlando, FL.

**This representation of the Terminology Services tests is not meant to be definitive and complete. This is one example of how these tests can be defined in the current DSTU2 format of the TestScript resource. Constructive feedback, suggestions and criticisms are welcome.

Expand Operation - $expand

Client Assigned (Resource) Id

* connectathon-12-track-16-ts-expand-client-id -- Terminology test suite 1 for $expand where the FHIR client assigns the ValueSet resource id in the setup.

* connectathon-12-track-16-ts-expand-filter-client-id -- Terminology test suite 1 for $expand with filter options where the FHIR client assigns the ValueSet resource id in the setup.

Client Assigned (Resource) Id

* connectathon-12-track-16-ts-expand-server-id -- Terminology test suite 1 for $expand where the FHIR server assigns the ValueSet resource id in the setup.

* connectathon-12-track-16-ts-expand-filter-server-id -- Terminology test suite 1 for $expand with filter options where the FHIR server assigns the ValueSet resource id in the setup.

Use Expected Existing ValueSet Resources

* connectathon-12-track-16-ts-expand-existing-id -- Terminology test suite 1 for $expand where the FHIR server is expected to have the existing ValueSet resource.

* connectathon-12-track-16-ts-expand-filter-existing-id -- Terminology test suite 1 for $expand with filter options where the FHIR server is expected to have the existing ValueSet resource.

Validate Code Operation - $validate-code

Client Assigned (Resource) Id

* connectathon-12-track-16-ts-validate-code-client-id -- Terminology test suite 3 for $validate-code where the FHIR client assigns the ValueSet resource id in the setup.

* connectathon-12-track-16-ts-validate-code-client-id -- Terminology test suite 4 for $validate-code with optional invocations where the FHIR client assigns the ValueSet resource id in the setup.

Client Assigned (Resource) Id

* connectathon-12-track-16-ts-validate-code-server-id -- Terminology test suite 3 for $validate-code where the FHIR server assigns the ValueSet resource id in the setup.

* connectathon-12-track-16-ts-validate-code-server-id -- Terminology test suite 4 for $validate-code with optional invocations where the FHIR server assigns the ValueSet resource id in the setup.

Use Expected Existing ValueSet Resources

* connectathon-12-track-16-ts-validate-code-existing-id -- Terminology test suite 3 for $validate-code where the FHIR server is expected to have the existing ValueSet resource.

* connectathon-12-track-16-ts-validate-code-existing-id -- Terminology test suite 4 for $validate-code with optional invocations where the FHIR server is expected to have the existing ValueSet resource.

Lookup Operation - $lookup

* connectathon-12-track-16-ts-loinc-lookup-xml -- Terminology test suite 5 for $lookup operations against the LOINC set of terminology codes.

* connectathon-12-track-16-ts-snomed-lookup-xml -- Terminology test suite 5 for $lookup operations against the SNOMED-CT set of terminology codes.

Translate Operation - $translate

* connectathon-12-track-16-ts-translate-xml -- Terminology test suite 6 for $translate operations against the ConceptMap for FHIR/v3 Address Use Mapping.

Conventions Used

The execution of the TestScript resources contained in this folder are constrained by the following conventions:

Fixtures - All resource reference values can be either url paths or local local file system paths. The convention for these TestScript resources use local file system paths where the execution engine is expected to resolve this path based on the following:

• Leading '/' character - this is resolved as an absolute path based on a known root path.
• No leading '/' character - this is resolved as a relative path based on the location of the TestScript resource file.