health.fhir.r4.terminology
Module health.fhir.r4.terminology
API
Declarations
ballerinax/health.fhir.r4.terminology Ballerina library
Functions
addCodeSystem
function addCodeSystem(CodeSystem codeSystem, Terminology? terminology) returns FHIRError?
Add a new CodeSystem.
Parameters
- codeSystem CodeSystem - ValueSet to be added, data in the Ballerina record format
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- FHIRError? - Return FHIRError
addCodeSystems
function addCodeSystems(CodeSystem[] codeSystems, Terminology? terminology) returns FHIRError[]?
Add a list of new CodeSystems.
Parameters
- codeSystems CodeSystem[] - List CodeSystems
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addCodeSystemsAsJson
function addCodeSystemsAsJson(json[] codeSystemJsonArray, Terminology? terminology) returns FHIRError[]?
Add a list of new CodeSystems as a json or json array.
Parameters
- codeSystemJsonArray json[] - CodeSystem data in the JSON format
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addValueSet
function addValueSet(ValueSet valueSet, Terminology? terminology) returns FHIRError?
Add a new ValueSet.
Parameters
- valueSet ValueSet - ValueSet to be added, data in the Ballerina record format
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- FHIRError? - Return FHIRError
addValueSets
function addValueSets(ValueSet[] valueSets, Terminology? terminology) returns FHIRError[]?
Add a list of new ValueSets.
Parameters
- valueSets ValueSet[] - List ValueSets in the Ballerina record format
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addValueSetsAsJson
function addValueSetsAsJson(json[] valueSetJsonArray, Terminology? terminology) returns FHIRError[]?
Add a list of new ValueSet as a json or json array.
Parameters
- valueSetJsonArray json[] - Json ValueSet data in the JSON format
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
codeSystemLookUp
function codeSystemLookUp(code|Coding codeValue, CodeSystem? cs, uri? system, string? version, Terminology? terminology) returns CodeSystemConcept[]|CodeSystemConcept|FHIRError
Extract the respective concepts from a given CodeSystem based on the give code or Coding or CodeableConcept data. This method was implemented based on : http://hl7.org/fhir/R4/terminology-service.html#lookup.
Parameters
- cs CodeSystem? (default ()) - CodeSystem record to be processed. If system parameter is not supplied, this value shoud be mandatory,
else this is an optional field
- system uri? (default ()) - System URL of the CodeSystem to be processed, if system CodeSystem(cs) is not supplied,
this value shoud be mandatory
- version string? (default ()) - Version of the CodeSystem and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- CodeSystemConcept[]|CodeSystemConcept|FHIRError - Return list of Concepts if processing is successful, return FHIRError if fails
createCodeableConcept
function createCodeableConcept(uri system, code code, string? version, Terminology? terminology) returns CodeableConcept|FHIRError
Create CodeableConcept data type for given code in a given system.
Parameters
- system uri - system uri of the code system or value set
- code code - code interested
- version string? (default () ) - Version of the CodeSystem and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- CodeableConcept|FHIRError - Created CodeableConcept record or FHIRError if not found
createCoding
function createCoding(uri system, code code, string? version, Terminology? terminology) returns Coding|FHIRError
Create Coding data type for given code in a given system.
Parameters
- system uri - System uri of the CodeSystem or valueSet
- code code - code interested
- version string? (default () ) - Version of the CodeSystem and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
findConceptsInValueSetFromCodeValue
function findConceptsInValueSetFromCodeValue(code|Coding|CodeableConcept codeValue, ValueSet valueSet, Terminology? terminology) returns CodeSystemConcept[]|CodeSystemConcept|FHIRError
Parameters
- codeValue code|Coding|CodeableConcept -
- valueSet ValueSet -
- terminology Terminology? (default inMemoryTerminology) -
readCodeSystemById
function readCodeSystemById(string id, string? version, Terminology? terminology) returns CodeSystem|FHIRError
Find a Code System based on the provided Id and version.
Parameters
- id string - Id of the CodeSystem to be retrieved
- version string? (default ()) - Version of the CodeSystem to be retrieved and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- CodeSystem|FHIRError - Return CodeSystem data if the request is successful, return FHIR error if no data found for the provided Id
readCodeSystemByUrl
function readCodeSystemByUrl(uri url, string? version, Terminology? terminology) returns CodeSystem|FHIRError
Find a CodeSystem based on the provided URL and version.
Parameters
- url uri - URL of the CodeSystem to be retrieved
- version string? (default ()) - Version of the CodeSystem to be retrieved and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- CodeSystem|FHIRError - Return CodeSystem data if the request is successful, return FHIR error if no data found for the provided URL
readValueSetById
function readValueSetById(string id, string? version, Terminology? terminology) returns ValueSet|FHIRError
Find a ValueSet for a provided Id and version.
Parameters
- id string - Id of the Value Set to be retrieved
- version string? (default ()) - Version of the ValueSet to be retrieved and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
readValueSetByUrl
function readValueSetByUrl(uri url, string? version, Terminology? terminology) returns ValueSet|FHIRError
Find a ValueSet for a provided URL and version.
Parameters
- url uri - URL of the Value Set to be retrieved
- version string? (default ()) - Version of the ValueSet to be retrieved and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
searchCodeSystems
function searchCodeSystems(map<RequestSearchParameter[]> params, Terminology? terminology) returns CodeSystem[]|FHIRError
Search for Code systems based on the provided search parameters. Allowed search parameters are name, title, url, version, status and so on.
Parameters
- params map<RequestSearchParameter[]> - List of search parameters, should be passed as map of string arrays
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- CodeSystem[]|FHIRError - Return array of CodeSystem data if success, return FHIR error if the request contains unsupported search parameters and for any other processing errors
searchValueSets
function searchValueSets(map<RequestSearchParameter[]> params, Terminology? terminology) returns FHIRError|ValueSet[]
Search for Value Sets for the provided search parameters. Allowed search parameters: are name, title, url, version, status and son on.
Parameters
- params map<RequestSearchParameter[]> - List of search parameters, should be passed as map of string arrays
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
subsumes
function subsumes(code|Coding conceptA, code|Coding conceptB, CodeSystem? cs, uri? system, string? version, Terminology? terminology) returns Parameters|FHIRError
This method with compare concepts. This method was implemented based on: http://hl7.org/fhir/R4/terminology-service.html#subsumes.
Parameters
- cs CodeSystem? (default ()) - CodeSystem value
- system uri? (default ()) - System uri of the codeSystem
- version string? (default ()) - Version of the CodeSystem and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- Parameters|FHIRError - Return Values either equivalent or not-subsumed if processing is successful, FHIRError processing fails
valueSetExpansion
function valueSetExpansion(map<RequestSearchParameter[]>? searchParams, ValueSet? vs, uri? system, Terminology? terminology) returns ValueSet|FHIRError
Extract all the concepts from a given valueSet based on the given filter parameters. This method was implemented based on : http://hl7.org/fhir/R4/terminology-service.html#expand.
Parameters
- searchParams map<RequestSearchParameter[]>? - List of search parameters to filter concepts, should be passed as map of string arrays
- vs ValueSet? (default ()) - ValueSet record to be processed. If system parameter is not supplied, this value shoud be mandatory, else this is an optional field
- system uri? (default ()) - System URL of the ValueSet to be processed, if system ValueSet(vs) is not supplied then
this value shoud be mandatory
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
valueSetLookUp
function valueSetLookUp(code|Coding|CodeableConcept codeValue, ValueSet? vs, uri? system, string? version, Terminology? terminology) returns CodeSystemConcept[]|CodeSystemConcept|FHIRError
Extract the respective concepts from a given ValueSet based on the give code or Coding or CodeableConcept data. This method was implemented based on : http://hl7.org/fhir/R4/terminology-service.html#validation.
Parameters
- codeValue code|Coding|CodeableConcept - Code or Coding or CodeableConcept data type value to process with the ValueSet
- vs ValueSet? (default ()) - vs - ValueSet record to be processed. If system parameter is not supplied, this value shoud be mandatory,
else this is an optional field
- system uri? (default ()) - System URL of the ValueSet to be processed, if system ValueSet(vs) is not supplied then
this value shoud be mandatory
- version string? (default ()) - Version of the ValueSet and it should be provided with system parameter, if this version parameter is not supplied then the latest version of CodeSystem will picked up.
- terminology Terminology? (default inMemoryTerminology) - Terminology - optional parameter allowing you to pass a custom implementation of the Terminology and by default we use InMemoryTerminology.
Return Type
- CodeSystemConcept[]|CodeSystemConcept|FHIRError - Return list of Concepts if processing is successful, return FHIRError if fails
Constants
health.fhir.r4.terminology: CODESYSTEMS_SEARCH_PARAMS
This is a map of implemented search params for CodeSystems. These are defined as a map because to make the search process ease.
health.fhir.r4.terminology: DEFAULT_FHIR_CODE_SYSTEMS
health.fhir.r4.terminology: DEFAULT_FHIR_VALUE_SETS
health.fhir.r4.terminology: DEFAULT_VERSION
health.fhir.r4.terminology: DEFINITION
health.fhir.r4.terminology: DISPLAY
health.fhir.r4.terminology: EQUIVALENT
health.fhir.r4.terminology: EXTERNAL_FHIR_CODE_SYSTEMS
health.fhir.r4.terminology: EXTERNAL_FHIR_VALUE_SETS
health.fhir.r4.terminology: FILTER
health.fhir.r4.terminology: NOT_SUBSUMED
health.fhir.r4.terminology: OUTCOME
health.fhir.r4.terminology: SEARCH_COUNT_ATTRIBUTE
health.fhir.r4.terminology: SEARCH_OFFSET_ATTRIBUTE
health.fhir.r4.terminology: TERMINOLOGY_SEARCH_DEFAULT_COUNT
health.fhir.r4.terminology: TERMINOLOGY_SEARCH_MAXIMUM_COUNT
health.fhir.r4.terminology: VALUESETS_EXPANSION_PARAMS
This is a map of implemented search params for ValueSets. These define as a map because to make the search process ease
health.fhir.r4.terminology: VALUESETS_SEARCH_PARAMS
This is a map of implemented search params for ValueSets. These define as a map because to make the search process ease
Records
health.fhir.r4.terminology: CodeConceptDetails
Fields
- url uri -
Object types
health.fhir.r4.terminology: Terminology
Defines the interface for a Terminology
implementation.
This should be implemented and provided to the Terminology API. Default implementation is
an in-memory terminology implementation.
isCodeSystemExist
To check whether the CodeSystem exists.
Parameters
- system uri - CodeSystem URL to be checked.
- version string - Version of the CodeSystem to be checked.
Return Type
- boolean - Return true if the CodeSystem exists, else false.
addCodeSystem
function addCodeSystem(CodeSystem codeSystem) returns FHIRError?
Add a new code system. Terminology API makes sure that the CodeSystem is valid.
Parameters
- codeSystem CodeSystem - CodeSystem to be added.
Return Type
- FHIRError? - FHIRError if any.
findCodeSystem
function findCodeSystem(uri? system, string? id, string? version) returns CodeSystem|FHIRError
The function definition for Concept finder implementations.
Parameters
- system uri? (default ()) - CodeSystem URL to be searched.
- id string? (default ()) - Id of the CodeSystem to be searched.
- version string? (default ()) - Version of the CodeSystem to be searched.
Return Type
- CodeSystem|FHIRError - CodeSystem if found or else FHIRError.
searchCodeSystem
function searchCodeSystem(map<RequestSearchParameter[]> params, int? offset, int? count) returns CodeSystem[]|FHIRError
The function definition for Concept finder implementations.
Parameters
- params map<RequestSearchParameter[]> - Search parameters.
- offset int? (default ()) - Offset value for the search.
- count int? (default ()) - Count value for the search.
Return Type
- CodeSystem[]|FHIRError - CodeSystem array if found or else FHIRError.
findConcept
function findConcept(uri system, code code, string? version) returns CodeConceptDetails|FHIRError
The function definition for Concept finder implementations.
Parameters
- system uri - System URL of the CodeSystem to be searched.
- code code - Code of the Concept to be searched.
- version string? (default ()) - version of the CodeSystem to be searched.
Return Type
- CodeConceptDetails|FHIRError - CodeConceptDetails if found or else FHIRError.
isValueSetExist
To check whether the ValueSet exists.
Parameters
- system uri - ValueSet URL to be checked.
- version string - Version of the ValueSet to be checked.
Return Type
- boolean - Return true if the ValueSet exists, else false.
addValueSet
Add a new value set. Terminology API makes sure that the ValueSet is valid.
Parameters
- valueSet ValueSet - ValueSet to be added.
Return Type
- FHIRError? - FHIRError if any.
findValueSet
The function definition for ValueSet finder implementations.
Parameters
- system uri? (default ()) - System URL of the ValueSet to be searched.
- id string? (default ()) - Id of the ValueSet to be searched.
- version string? (default ()) - version of the ValueSet to be searched.
searchValueSet
function searchValueSet(map<RequestSearchParameter[]> params, int? offset, int? count) returns ValueSet[]|FHIRError
Search ValueSets.
Parameters
- params map<RequestSearchParameter[]> - Search parameters.
- offset int? (default ()) - Offset value for the search.
- count int? (default ()) - Count value for the search.
Import
import ballerinax/health.fhir.r4.terminology;
Metadata
Released date: about 2 months ago
Version: 4.2.0
Compatibility
Platform: any
Ballerina version: 2201.10.2
GraalVM compatible: Yes
Pull count
Total: 436
Current verison: 4
Weekly downloads
Keywords
Healthcare
FHIR
R4
Terminology
Contributors
Dependencies