health.fhir.r4.terminology
Module health.fhir.r4.terminology
API
Declarations
ballerinax/health.fhir.r4.terminology Ballerina library
Functions
addCodeSystem
function addCodeSystem(CodeSystem codeSystem) returns FHIRError?
Add a new CodeSystem.
Parameters
- codeSystem CodeSystem - ValueSet to be added, data in the Ballerina record format
Return Type
- FHIRError? - Return FHIRError
addCodeSystems
function addCodeSystems(CodeSystem[] codeSystems) returns FHIRError[]?
Add a list of new CodeSystems.
Parameters
- codeSystems CodeSystem[] - List CodeSystems
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addCodeSystemsAsJson
function addCodeSystemsAsJson(json[] codeSystemJsonArray) returns FHIRError[]?
Add a list of new CodeSystems as a json or json array.
Parameters
- codeSystemJsonArray json[] - CodeSystem data in the JSON format
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addValueSet
Add a new ValueSet.
Parameters
- valueSet ValueSet - ValueSet to be added, data in the Ballerina record format
Return Type
- FHIRError? - Return FHIRError
addValueSets
Add a list of new ValueSets.
Parameters
- valueSets ValueSet[] - List ValueSets in the Ballerina record format
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addValueSetsAsJson
function addValueSetsAsJson(json[] valueSetJsonArray) returns FHIRError[]?
Add a list of new ValueSet as a json or json array.
Parameters
- valueSetJsonArray json[] - Json ValueSet data in the JSON format
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
codeSystemLookUp
function codeSystemLookUp(code|Coding|CodeableConcept codeValue, CodeSystem? cs, uri? system, string? version) 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
- codeValue code|Coding|CodeableConcept - Code or Coding or CodeableConcept data type value to process with the CodeSystem
- 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.
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) 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.
Return Type
- CodeableConcept|FHIRError - Created CodeableConcept record or FHIRError if not found
createCoding
Create Coding data type for given code in a given system.
getCodeSystemMap
function getCodeSystemMap() returns map<CodeSystem>
Get all the CodeSystem records.
Return Type
- map<CodeSystem> - Map of CodeSystem records
getValueSetMap
Get all the ValueSet records.
readCodeSystemById
function readCodeSystemById(string id, string? version) 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.
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) 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.
Return Type
- CodeSystem|FHIRError - Return CodeSystem data if the request is successful, return FHIR error if no data found for the provided URL
readValueSetById
Find a ValueSet for a provided Id and version.
readValueSetByUrl
Find a ValueSet for a provided URL and version.
searchCodeSystems
function searchCodeSystems(map<RequestSearchParameter[]> searchParameters) 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
- searchParameters map<RequestSearchParameter[]> - List of search parameters, should be passed as map of string arrays
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[]> searchParameters) 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
- searchParameters map<RequestSearchParameter[]> - List of search parameters, should be passed as map of string arrays
setFinder
function setFinder(Finder finder)
Set the external terminology retriever function.
Parameters
- finder Finder - Implementation of the external terminology retriever class
subsumes
function subsumes(code|Coding conceptA, code|Coding conceptB, CodeSystem? cs, uri? system, string? version) 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.
Return Type
- Parameters|FHIRError - Return Values either equivalent or not-subsumed if processing is successful, FHIRError processing fails
valueSetExpansion
function valueSetExpansion(map<RequestSearchParameter[]> searchParameters, ValueSet? vs, uri? system) 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
- searchParameters 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
valueSetLookUp
function valueSetLookUp(code|Coding|CodeableConcept codeValue, ValueSet? vs, uri? system, string? version) 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.
Return Type
- CodeSystemConcept[]|CodeSystemConcept|FHIRError - Return list of Concepts if processing is successful, return FHIRError if fails
Classes
health.fhir.r4.terminology: TerminologyProcessor
A processor to process terminology data and create relevant data elements.
initTerminology
function initTerminology(map<CodeSystem> codeSystems, map<ValueSet> valueSets)
It will initialize the Terminology map. It will delete the existing records if it is re-initialized. It will be used during the package initialization.
setFinder
function setFinder(Finder finder)
Parameters
- finder Finder -
addCodeSystems
function addCodeSystems(CodeSystem[] codeSystems) returns FHIRError[]?
Add list of new CodeSystems.
Parameters
- codeSystems CodeSystem[] - List CodeSystems
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addCodeSystemsAsJson
function addCodeSystemsAsJson(json[] codeSystemJsonArray) returns FHIRError[]?
Add list of new CodeSystems as a json or json array.
Parameters
- codeSystemJsonArray json[] - CodeSystem data in the JSON format
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addValueSets
Add list of new ValueSets.
Parameters
- valueSets ValueSet[] - List ValueSets in the Ballerina record format
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addValueSetsAsJson
function addValueSetsAsJson(json[] valueSetJsonArray) returns FHIRError[]?
Add list of new ValueSet as a json or json array.
Parameters
- valueSetJsonArray json[] - Json ValueSet data in the JSON format
Return Type
- FHIRError[]? - Return List of FHIRErrors if any
addCodeSystem
function addCodeSystem(CodeSystem codeSystem) returns FHIRError?
Add a new CodeSystem.
Parameters
- codeSystem CodeSystem - ValueSet to be added, data in the Ballerina record format
Return Type
- FHIRError? - Return FHIRError
addValueSet
Add a new ValueSet.
Parameters
- valueSet ValueSet - ValueSet to be added, data in the Ballerina record format
Return Type
- FHIRError? - Return FHIRError
readCodeSystemById
function readCodeSystemById(string id, string? version) 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.
Return Type
- CodeSystem|FHIRError - Return CodeSystem data if the request is successful, return FHIR error if no data found for the provided Id
readValueSetById
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.
Return Type
searchCodeSystems
function searchCodeSystems(map<RequestSearchParameter[]> params) 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
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) 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
Return Type
codeSystemLookUp
function codeSystemLookUp(code|Coding|CodeableConcept codeValue, CodeSystem? cs, uri? system, string? version) 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
- codeValue code|Coding|CodeableConcept - Code or Coding or CodeableConcept data type value to process with the CodeSystem
- 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.
Return Type
- CodeSystemConcept[]|CodeSystemConcept|FHIRError - Return list of Concepts if processing is successful, return FHIRError if fails
valueSetLookUp
function valueSetLookUp(code|Coding|CodeableConcept codeValue, ValueSet? vs, uri? system, string? version) 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.
Return Type
- CodeSystemConcept[]|CodeSystemConcept|FHIRError - Return list of Concepts if processing is successful, return FHIRError if fails
valueSetExpansion
function valueSetExpansion(map<RequestSearchParameter[]> searchParams, ValueSet? vs, uri? system) 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
subsumes
function subsumes(code|Coding conceptA, code|Coding conceptB, CodeSystem? cs, uri? system, string? version) 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.
Return Type
- Parameters|FHIRError - Return Values either equivalent or not-subsumed if processing is successful, FHIRError processing fails
readCodeSystemByUrl
function readCodeSystemByUrl(uri url, string? version) 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.
Return Type
- CodeSystem|FHIRError - Return CodeSystem data if the request is successful, return FHIR error if no data found for the provided URL
readValueSetByUrl
createCodeableConcept
function createCodeableConcept(uri system, code code, string? version, Finder? finder) 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.
- finder Finder? (default ()) - (optional) custom code system function (utility will used this function to find code
system in a external source system)
Return Type
- CodeableConcept|FHIRError - Created CodeableConcept record or FHIRError if not found
createCoding
function createCoding(uri system, code code, string? version, Finder? finder) 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.
- finder Finder? (default ()) - (optional) custom code system function (utility will used this function to find code
system in a external source system)
getCodeSystemMap
function getCodeSystemMap() returns map<CodeSystem>
Get all the CodeSystem records.
Return Type
- map<CodeSystem> - Map of CodeSystem records
getValueSetMap
Get all the ValueSet records.
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_VERSION
health.fhir.r4.terminology: DEFINITION
health.fhir.r4.terminology: DISPLAY
health.fhir.r4.terminology: EQUIVALENT
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