Class default

constructor

• new default(fhirBaseUrl: string): default

  Validates the parameters and creates an instance.

  Parameters

  • fhirBaseUrl: string

  Returns default

ReadonlyfhirBaseUrl

fhirRequest

• fhirRequest<T = any>(uri: string | URL, options?: RequestOptions): Promise<T>

  The method responsible for making all http requests

  Type Parameters

  • T = any

  Parameters

  • uri: string | URL
  • options: RequestOptions = {}

  Returns Promise<T>

getFhirRelease

• getFhirRelease(): Promise<number>

  Returns a promise that will be resolved with the numeric fhir version

  • 2 for DSTU2
  • 3 for STU3
  • 4 for R4
  • 0 if the version is not known

  Returns Promise<number>

getFhirVersion

• getFhirVersion(): Promise<string>

  Returns a promise that will be resolved with the fhir version as defined in the CapabilityStatement.

  Returns Promise<string>

getReferences

• getReferences(
      resource: Resource,
      references: string[],
      requestOptions?: Omit<fhirclient.RequestOptions, "url">,
  ): Promise<Record<string, Resource>>

  Fetches all references in the given resource, ignoring duplicates

  Parameters

  • resource: Resource
  • references: string[]
  • requestOptions: Omit<fhirclient.RequestOptions, "url"> = {}

  Returns Promise<Record<string, Resource>>

getRequestDefaults

• getRequestDefaults(): Promise<Partial<RequestInit>>

  Default request options to be used for every request. This method can be overridden in subclasses to provide custom default options.

  Returns Promise<Partial<RequestInit>>

pages

• pages(
      bundleOrUrl: string | URL | Bundle<FhirResource>,
      requestOptions?: RequestOptions,
  ): AsyncGenerator<Bundle<FhirResource>, void, unknown>

  Given a FHIR Bundle or a URL pointing to a bundle, iterates over all pages. Note that this will automatically crawl through further pages (if any) but it will not detect previous pages. It is designed to be called on the first page and fetch any followup pages.

  Parameters

  • bundleOrUrl: string | URL | Bundle<FhirResource>
  • OptionalrequestOptions: RequestOptions

  Returns AsyncGenerator<Bundle<FhirResource>, void, unknown>

resolveReferences

• resolveReferences(
      resource: Resource,
      references: string[],
      requestOptions?: Omit<fhirclient.RequestOptions, "url">,
  ): Promise<void>

  Fetches all references in the given resource, ignoring duplicates, and then modifies the resource by "mounting" the resolved references in place

  Parameters

  • resource: Resource
  • references: string[]
  • requestOptions: Omit<fhirclient.RequestOptions, "url"> = {}

  Returns Promise<void>

resources

• resources(
      bundleOrUrl: string | URL | Bundle<FhirResource>,
      options?: RequestOptions,
  ): AsyncGenerator<FhirResource | undefined, void, unknown>

  Given a FHIR Bundle or a URL pointing to a bundle, iterates over all entry resources. Note that this will also automatically crawl through further pages (if any)

  Parameters

  • bundleOrUrl: string | URL | Bundle<FhirResource>
  • Optionaloptions: RequestOptions

  Returns AsyncGenerator<FhirResource | undefined, void, unknown>

create

• create<R = Resource, O extends FetchOptions = {}>(
      resource: Resource,
      requestOptions?: O,
  ): Promise<O["includeResponse"] extends true ? CombinedFetchResult<R> : R>

  Creates a new resource in a server-assigned location

  Type Parameters

  • R = Resource
  • O extends FetchOptions = {}

  Parameters

  • resource: Resource

    A FHIR resource to be created

  • OptionalrequestOptions: O

    Any options to be passed to the fetch call. Note that method and body will be ignored.

  Returns Promise<O["includeResponse"] extends true ? CombinedFetchResult<R> : R>

  See

  http://hl7.org/fhir/http.html#create

delete

• delete<R = unknown>(url: string, requestOptions?: FetchOptions): Promise<R>

  Removes an existing resource.

  Type Parameters

  • R = unknown

  Parameters

  • url: string

    Relative URI of the FHIR resource to be deleted (format: resourceType/id)

  • requestOptions: FetchOptions = {}

    Any options (except method which will be fixed to DELETE) to be passed to the fetch call.

  Returns Promise<R>

  See

  http://hl7.org/fhir/http.html#delete

patch

• patch<ResolveType = Resource>(
      url: string,
      patch: JsonPatch,
      requestOptions?: FetchOptions,
  ): Promise<ResolveType>

  Makes a JSON Patch to the given resource

  Type Parameters

  • ResolveType = Resource

    This method would typically resolve with the patched resource or reject with an OperationOutcome. However, this may depend on the server implementation or even on the request headers. For that reason, if the default resolve type (which is [[fhirclient.FHIR.Resource]]) does not work for you, you can pass in your own resolve type parameter.

  Parameters

  • url: string

    Relative URI of the FHIR resource to be patched (format: resourceType/id)

  • patch: JsonPatch

    A JSON Patch array to send to the server, For details see https://datatracker.ietf.org/doc/html/rfc6902

  • requestOptions: FetchOptions = {}

    Any options to be passed to the fetch call, except for method, url and body which cannot be overridden.

  Returns Promise<ResolveType>

  See

  http://hl7.org/fhir/http.html#patch

  Since

  2.4.0

update

• update<R = Resource, O extends FetchOptions = {}>(
      resource: Resource,
      requestOptions?: O,
  ): Promise<O["includeResponse"] extends true ? CombinedFetchResult<R> : R>

  Creates a new current version for an existing resource or creates an initial version if no resource already exists for the given id.

  Type Parameters

  • R = Resource
  • O extends FetchOptions = {}

  Parameters

  • resource: Resource

    A FHIR resource to be updated

  • OptionalrequestOptions: O

    Any options to be passed to the fetch call. Note that method and body will be ignored.

  Returns Promise<O["includeResponse"] extends true ? CombinedFetchResult<R> : R>

  See

  http://hl7.org/fhir/http.html#update