Skip to main content

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​

NameType
codingCoding

Returns​

Promise<Coding>

Defined in​

src/apis/CodingApi.ts:14

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​

NameType
codingCoding[]

Returns​

Promise<Coding[]>

Defined in​

src/apis/CodingApi.ts:20

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​

NameTypeDescription
filterFilter<Coding>The Filter object that describes which condition(s) the elements whose the ids should be returned must fulfill
nextCodingId?stringThe id of the first coding in the next page
limit?numberThe maximum number of codings that should contain the returned page. By default, a page contains 1000 codings

Returns​

Promise<PaginatedListCoding>

Defined in​

src/apis/CodingApi.ts:28

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​

NameType
codingIdstring

Returns​

Promise<Coding>

Defined in​

src/apis/CodingApi.ts:34

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​

NameTypeDescription
filterFilter<Coding>The Filter object that describes which condition(s) the elements whose the ids should be returned must fulfill

Returns​

Promise<string[]>

Defined in​

src/apis/CodingApi.ts:40