ValueSet (FHIR R4)

FHIR You're viewing the FHIR R4 reference.Only in R4

FHIR R4 ValueSet resource.

This reference is generated from the canonical Huli Public API OpenAPI specification and the server's FHIR R4 CapabilityStatement — do not edit it directly.

FHIR R4 Specification

Official spec: ValueSet — HL7 FHIR R4

Supported Interactions

  • $expand — operation

Scopes

Scopes are shared across FHIR releases — the same system/ValueSet.* scope grants ValueSet access on both /fhir/R4 and /fhir/R5.

Endpoints

Expand a ValueSet

Expand one of the Huli terminology ValueSets into its codes (FHIR $expand operation). The url parameter selects the catalog. Scope is enforced per-url:

  • .../ValueSet/cancellation-reason requires system/Appointment.rs
  • .../ValueSet/observation-loinc requires system/Observation.rs
  • .../ValueSet/mx-country, .../ValueSet/mx-municipality, .../ValueSet/mx-locality require system/Patient.rsmx-municipality requires a state parameter; mx-locality requires both state and municipality. The optional filter is a case/accent-insensitive name/code prefix where the backing catalog supports it.
GET/fhir/R4/ValueSet/$expand

Required scope: system/Appointment.rs

Query Parameters

nametyperequireddescription
urlstringrequiredCanonical URL of the ValueSet to expand.
filterstringoptionalCase/accent-insensitive name or code prefix (where supported).
stateintegeroptionalMexican state code (required for mx-municipality and mx-locality).
municipalityintegeroptionalMexican municipality code (required for mx-locality).
_countintegeroptionalNumber of results per page (default: 20, max: 100).
_offsetintegeroptionalNumber of results to skip (offset-based pagination).

Response — 200

{
  "resourceType": "ValueSet",
  "url": "https://fhir.huli.ai/r4/ValueSet/cancellation-reason",
  "status": "active",
  "expansion": {
    "total": 1,
    "contains": [
      {
        "system": "https://fhir.huli.ai/r4/CodeSystem/cancellation-reason",
        "code": "patient-no-show",
        "display": "El paciente no se presentó"
      }
    ]
  }
}

Code Samples

TOKEN=$(curl -s -X POST https://api.huli.ai/auth/token \
  -d "grant_type=client_credentials" \
  -d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" \
  -d "client_assertion=${CLIENT_ASSERTION}" \
  -d "scope=system/Appointment.rs" \
  | jq -r .access_token)

curl -X GET https://api.huli.ai/fhir/R4/ValueSet/$expand \
  -H "Authorization: Bearer ${TOKEN}"
const token = process.env.HULI_ACCESS_TOKEN ?? "";

const response = await fetch(
  `https://api.huli.ai/fhir/R4/ValueSet/$expand`,
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${token}`,
    },

  }
);

if (!response.ok) throw new Error(`HTTP ${String(response.status)}`);
const data: unknown = await response.json();
import os
import requests

token = os.environ["HULI_ACCESS_TOKEN"]
headers = {"Authorization": f"Bearer {token}"}

resp = requests.get(
    f"https://api.huli.ai/fhir/R4/ValueSet/$expand",
    headers=headers,
)
resp.raise_for_status()
print(resp.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class expandValueSetExample {
    public static void main(String[] args) throws Exception {
        String token = System.getenv("HULI_ACCESS_TOKEN");

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://api.huli.ai/fhir/R4/ValueSet/$expand"))
        .header("Authorization", "Bearer " + token)
        .header("Accept", "application/fhir+json")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();

        HttpResponse<String> response =
        client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println("status: " + response.statusCode());
        System.out.println(response.body());
    }
}
import (
    "fmt"
    "net/http"
    "os"
)

func expandValueSetExample() {
    token := os.Getenv("HULI_ACCESS_TOKEN")
    req, _ := http.NewRequest("GET", "https://api.huli.ai/fhir/R4/ValueSet/$expand", nil)
    req.Header.Set("Authorization", "Bearer "+token)

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        fmt.Println("error:", err)
        return
    }
    defer resp.Body.Close()
    fmt.Println("status:", resp.Status)
}

Errors

CodeStatusDescription
HPB-00101400Validation error
HPB-00106401Authentication failed
HPB-00104403Insufficient scope
HPB-00105429Rate limit exceeded