CodingApi
@icure/medical-device-sdk / CodingApi
SDK API: CodingApi
The CodingApi interface provides methods to manage codings and terminologies (like ATC, ICD-10, LOINC, SNOMED-CT,… ).
Table of contents
Methods
Methods
createOrModifyCoding
▸ createOrModifyCoding(coding): Promise<Coding>
When modifying a coding, you must ensure that the rev obtained when getting or creating the coding is present as the rev is used to guarantee that the coding has not been modified by a third party. Create or update a [Coding]
Parameters
| Name | Type |
|---|---|
coding | Coding |
Returns
Promise<Coding>
Defined in
createOrModifyCodings
▸ createOrModifyCodings(coding): Promise<Coding[]>
When modifying codings, you must ensure that the rev obtained when getting or creating the coding is present as the rev is used to guarantee that the coding has not been modified by a third party. Create or update a batch of [Coding]
Parameters
| Name | Type |
|---|---|
coding | Coding[] |
Returns
Promise<Coding[]>
Defined in
filterCoding
▸ filterCoding(filter, nextCodingId?, limit?): Promise<PaginatedListCoding>
Filters are complex selectors that are built by combining basic building blocks. Examples of filters available for [Coding] are AllCodingsFilter and CodingsByIdsFilter. This method returns a paginated list of coding (with a cursor that lets you query the following items). Load codings from the database by filtering them using the provided [filter].
Parameters
| Name | Type | Description |
|---|---|---|
filter | Filter<Coding> | The Filter object that describes which condition(s) the elements whose the ids should be returned must fulfill |
nextCodingId? | string | The id of the first coding in the next page |
limit? | number | The maximum number of codings that should contain the returned page. By default, a page contains 1000 codings |
Returns
Promise<PaginatedListCoding>
Defined in
getCoding
▸ getCoding(codingId): Promise<Coding>
Each coding is uniquely identified by a coding id. The coding id is a UUID. This [codingId] is the preferred method to retrieve one specific coding. Get a [Coding]
Parameters
| Name | Type |
|---|---|
codingId | string |
Returns
Promise<Coding>
Defined in
matchCoding
▸ matchCoding(filter): Promise<string[]>
Filters are complex selectors that are built by combining basic building blocks. Examples of filters available for [Coding] are AllCodingsFilter and CodingsByIdsFilter. This method returns a paginated list of coding (with a cursor that lets you query the following items). Load coding ids from the database by filtering them using the provided [filter].
Parameters
| Name | Type | Description |
|---|---|---|
filter | Filter<Coding> | The Filter object that describes which condition(s) the elements whose the ids should be returned must fulfill |
Returns
Promise<string[]>