org.cqframework.fhir.api.r4.FhirTerminologyService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cqf-fhir Show documentation

The cqf-fhir library for the Clinical Quality Language Java reference implementation

There is a newer version: 3.18.0

package org.cqframework.fhir.api.r4;

import org.hl7.fhir.r4.model.CodeableConcept;
import org.hl7.fhir.r4.model.Coding;
import org.hl7.fhir.r4.model.Parameters;
import org.hl7.fhir.r4.model.ValueSet;
import org.hl7.fhir.r4.model.codesystems.ConceptSubsumptionOutcome;

public interface FhirTerminologyService extends FhirService {
    // https://hl7.org/fhir/valueset-operation-expand.html
    // TODO: Consider activeOnly, as well as includeDraft and expansion parameters (see Measure Terminology Service in
    // the QM IG)
    ValueSet expand(String url);

    ValueSet expand(String url, Iterable systemVersion);

    // https://hl7.org/fhir/codesystem-operation-lookup.html
    // TODO: Define LookupResult class
    Parameters lookup(String code, String systemUrl);

    Parameters lookup(Coding coding);

    // https://hl7.org/fhir/valueset-operation-validate-code.html
    // TODO: Define ValidateResult class
    Parameters validateCodeInValueSet(String url, String code, String systemUrl, String display);

    Parameters validateCodingInValueSet(String url, Coding code);

    Parameters validateCodeableConceptInValueSet(String url, CodeableConcept concept);

    // https://hl7.org/fhir/codesystem-operation-validate-code.html
    Parameters validateCodeInCodeSystem(String url, String code, String systemUrl, String display);

    Parameters validateCodingInCodeSystem(String url, Coding code);

    Parameters validateCodeableConceptInCodeSystem(String url, CodeableConcept concept);

    // https://hl7.org/fhir/codesystem-operation-subsumes.html
    ConceptSubsumptionOutcome subsumes(String codeA, String codeB, String systemUrl);

    ConceptSubsumptionOutcome subsumes(Coding codeA, Coding codeB);

    // https://hl7.org/fhir/conceptmap-operation-translate.html
    // TODO: Translation support
}