Terminology

Firely Server provides limited support for these Terminology operations:

  • $validate-code
  • $expand
  • $lookup
  • $compose

These operations are currently implemented on the Administration API and therefore only available through the administration endpoint on <firely-server-endpoint>/administration.

Refer to Controlling the Conformance Resources on how to provide CodeSystem and ValueSet resources to the Administration API.

Note

This is a first attempt on supporting Terminology operations. We welcome feedback on how you would like to use them. Contact us at server@fire.ly.

Note

This implementation does not support complex terminologies like Snomed CT or LOINC. If you need that: Starting with Firely Server (Vonk) 3.5.0 we provide more elaborate terminology support by integrating with a full Terminology Server, see Terminology Integration docs.

ValueSet $validate-code

definition:

http://www.hl7.org/implement/standards/fhir/valueset-operations.html#validate-code
notes:
  • Available on the type level <firely-server-endpoint>/administration/ValueSet/$validate-code and the instance level <firely-server-endpoint>/administration/ValueSet/<id>/$validate-code.
  • Only the parameters url, valueSet, valueSetVersion, code, system, display, coding, codeableConcept, abstract are supported.
  • The url and valueSetVersion input parameters are only taken into consideration if no valueSet resource was provided in the body. So the valueSet in the body takes priority.
  • Both GET and POST interactions are available.

ValueSet $expand

definition:

http://www.hl7.org/implement/standards/fhir/valueset-operations.html#expand
notes:
  • Available on the type level <firely-server-endpoint>/administration/ValueSet/$expand and the instance level <firely-server-endpoint>/administration/ValueSet/<id>/$expand.
  • Only the parameters url, valueSet, valueSetVersion and includeDesignations are supported.
  • The url and valueSetVersion input parameters are only taken into consideration if no valueSet resource was provided in the body. So the valueSet in the body takes priority.
  • Both GET and POST interactions are available.

CodeSystem $lookup

definition:

http://www.hl7.org/implement/standards/fhir/codesystem-operations.html#lookup
notes:
  • Available on the type level <firely-server-endpoint>/administration/CodeSystem/$lookup.
  • Only the parameters code, system, version, coding and date are supported.
  • Code & system combination takes priority over the coding parameter.
  • Both GET and POST interactions are available.

CodeSystem $compose

definition:

http://www.hl7.org/implement/standards/fhir/codesystem-operations.html#compose
notes:
  • Available on the type level <firely-server-endpoint>/administration/CodeSystem/$compose and the instance level <firely-server-endpoint>/administration/CodeSystem/<id>/$compose.
  • Only the parameters system, exact, version, property.code and property.value are supported.
  • The url and valueSetVersion input parameters are only taken into consideration if no valueSet resource was provided in the body. So the valueSet in the body takes priority.
  • Both GET and POST interactions are available.