Mengambil ValueSet Kode dengan $expand - AWS HealthLake
PenggunaanParameter yang DidukungContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Mengambil ValueSet Kode dengan $expand

AWS HealthLake sekarang mendukung $expand operasi untuk ValueSets yang dicerna oleh Anda sebagai pelanggan, memungkinkan Anda untuk mengambil daftar lengkap kode yang terkandung dalam ValueSet sumber daya tersebut. Operasi ini sangat berguna ketika Anda perlu:

  • Ambil semua kode yang mungkin untuk tujuan validasi

  • Tampilkan opsi yang tersedia di antarmuka pengguna

  • Lakukan pencarian kode komprehensif dalam konteks terminologi tertentu

Penggunaan

$expandOperasi dapat dipanggil pada ValueSet sumber daya menggunakan metode GET dan POST:

Operasi yang Didukung

GET/POST [base]/ValueSet/[id]/$expand
GET [base]/ValueSet/$expand?url=http://example.com
POST [base]/ValueSet/$expand

Parameter yang Didukung

HealthLake mendukung subset parameter FHIR $expand R4:

Parameter Jenis Diperlukan Deskripsi
url uri Tidak URL kanonik untuk memperluas ValueSet
id id Tidak ValueSet id sumber daya untuk diperluas (untuk operasi GET atau POST)
filter string Tidak Filter hasil ekspansi kode
count integer Tidak Jumlah kode yang akan dikembalikan
offset integer Tidak Jumlah kode yang cocok untuk dilewati sebelum kembali. Berlaku setelah pemfilteran dan hanya untuk kode yang cocok, bukan untuk konten asli yang lengkap dan tanpa filter ValueSet

Contoh

DAPATKAN Permintaan dengan ID

GET [base]/ValueSet/example-valueset/$expand
DAPATKAN Permintaan berdasarkan URL dengan Filter

GET [base]/ValueSet/$expand?url=http://example.com/ValueSet/my-valueset&filter=male&count=5
Permintaan POST dengan Parameter (berdasarkan ID)

POST [base]/ValueSet/example-valueset/$expand
Content-Type: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "count",
      "valueInteger": 10
    },
    {
      "name": "filter",
      "valueString": "admin"
    }
  ]
}
Permintaan POST dengan Parameter (berdasarkan URL)

POST [base]/ValueSet/$expand
Content-Type: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "url",
      "valueUri": "http://hl7.org/fhir/ValueSet/administrative-gender"
    },
    {
      "name": "count",
      "valueInteger": 10
    }
  ]
}
Contoh Respons

Operasi mengembalikan ValueSet sumber daya dengan expansion elemen yang berisi kode diperluas:

{
  "resourceType": "ValueSet",
  "id": "administrative-gender",
  "status": "active",
  "expansion": {
    "identifier": "urn:uuid:12345678-1234-1234-1234-123456789abc",
    "timestamp": "2024-01-15T10:30:00Z",
    "total": 4,
    "parameter": [
      {
        "name": "count",
        "valueInteger": 10
      }
    ],
    "contains": [
      {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "male",
        "display": "Male"
      },
      {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "female",
        "display": "Female"
      },
      {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "other",
        "display": "Other"
      },
      {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "unknown",
        "display": "Unknown"
      }
    ]
  }
}

Respons meliputi:

  • expansion.total: Jumlah total kode yang diperluas ValueSet

  • expansion.contains: Array kode yang diperluas dengan sistem, kode, dan nilai tampilannya

  • expansion.parameter: Parameter yang digunakan dalam permintaan ekspansi

Untuk informasi lebih lanjut tentang spesifikasi $expand operasi, lihat dokumentasi FHIR R4 ValueSet $expand.