Recuperando ValueSet códigos com $expand - AWS HealthLake
UsoParâmetros compatíveisExemplos

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Recuperando ValueSet códigos com $expand

AWS HealthLake agora suporta a $expand operação ValueSets que foi ingerida por você como cliente, permitindo que você recupere a lista completa de códigos contidos nesses ValueSet recursos. Essa operação é particularmente útil quando você precisa:

  • Recupere todos os códigos possíveis para fins de validação

  • Exibir as opções disponíveis nas interfaces de usuário

  • Realize pesquisas abrangentes de código dentro de um contexto terminológico específico

Uso

A $expand operação pode ser invocada em ValueSet recursos usando os métodos GET e POST:

Operações com Suporte

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

Parâmetros compatíveis

HealthLake suporta um subconjunto de parâmetros FHIR R4: $expand

Parameter Type Obrigatório Descrição
url uri Não URL canônico do para expandir ValueSet
id id Não ValueSet ID do recurso a ser expandido (para operações GET ou POST)
filter string Não Filtrar o resultado da expansão do código
count integer Não Número de códigos a serem devolvidos
offset integer Não Número de códigos correspondentes a serem ignorados antes de devolver. Aplica-se após a filtragem e somente aos códigos correspondentes, não ao conteúdo completo e não filtrado do original ValueSet

Exemplos

Solicitação GET por ID

GET [base]/ValueSet/example-valueset/$expand
Solicitação GET por URL com filtro

GET [base]/ValueSet/$expand?url=http://example.com/ValueSet/my-valueset&filter=male&count=5
Solicitação POST com parâmetros (por ID)

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

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "count",
      "valueInteger": 10
    },
    {
      "name": "filter",
      "valueString": "admin"
    }
  ]
}
Solicitação POST com parâmetros (por 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
    }
  ]
}
Resposta da amostra

A operação retorna um ValueSet recurso com um expansion elemento contendo os códigos expandidos:

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

A resposta inclui:

  • expansion.total: número total de códigos no expandido ValueSet

  • expansion.contains: matriz de códigos expandidos com seus valores de sistema, código e exibição

  • expansion.parameter: parâmetros usados na solicitação de expansão

Para obter mais informações sobre a especificação da $expand operação, consulte a documentação do FHIR ValueSet $expand R4.