ValueSet Codes abrufen mit $expand - AWS HealthLake
VerwendungUnterstützte ParameterBeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

ValueSet Codes abrufen mit $expand

AWS HealthLake unterstützt jetzt den $expand Vorgang für diejenigen ValueSets , die von Ihnen als Kunde aufgenommen wurden, sodass Sie die vollständige Liste der in diesen ValueSet Ressourcen enthaltenen Codes abrufen können. Dieser Vorgang ist besonders nützlich, wenn Sie:

  • Rufen Sie zu Validierungszwecken alle möglichen Codes ab

  • Verfügbare Optionen in Benutzeroberflächen anzeigen

  • Führen Sie umfassende Codelookups innerhalb eines bestimmten Terminologiekontextes durch

Verwendung

Der $expand Vorgang kann mit den Methoden GET und POST für ValueSet Ressourcen aufgerufen werden:

Unterstützte Vorgänge

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

Unterstützte Parameter

HealthLake unterstützt eine Teilmenge von FHIR R4-Parametern: $expand

Parameter Typ Erforderlich Beschreibung
url uri Nein Kanonische URL des zu erweiterenden ValueSet
id id Nein ValueSet zu erweiterende Ressourcen-ID (für GET- oder POST-Operationen)
filter Zeichenfolge Nein Filtert das Ergebnis der Codeerweiterung
count Ganzzahl Nein Anzahl der zurückzugebenden Codes
offset Ganzzahl Nein Anzahl der übereinstimmenden Codes, die vor der Rückkehr übersprungen werden müssen. Gilt nach dem Filtern und nur für die passenden Codes, nicht für den vollständigen, ungefilterten Inhalt des Originals ValueSet

Beispiele

GET-Anfrage nach ID

GET [base]/ValueSet/example-valueset/$expand
GET-Anfrage per URL mit Filter

GET [base]/ValueSet/$expand?url=http://example.com/ValueSet/my-valueset&filter=male&count=5
POST-Anfrage mit Parametern (nach ID)

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

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "count",
      "valueInteger": 10
    },
    {
      "name": "filter",
      "valueString": "admin"
    }
  ]
}
POST-Anfrage mit Parametern (per 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
    }
  ]
}
Beispielantwort

Die Operation gibt eine ValueSet Ressource mit einem expansion Element zurück, das die erweiterten Codes enthält:

{
  "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"
      }
    ]
  }
}

Die Antwort enthält:

  • expansion.total: Gesamtzahl der Codes im erweiterten Bereich ValueSet

  • expansion.contains: Array erweiterter Codes mit ihren System-, Code- und Anzeigewerten

  • expansion.parameter: In der Erweiterungsanforderung verwendete Parameter

Weitere Informationen zur $expand Operationsspezifikation finden Sie in der FHIR R4-Dokumentation. ValueSet $expand