Como pesquisar recursos FHIR

Nesta página, mostramos como pesquisar recursos em um armazenamento de FHIR. É possível pesquisar recursos do FHIR usando o seguinte:

• O visualizador de FHIR no Console do Cloud.
• Método projects.locations.datasets.fhirStores.fhir.search. O método fornece as seguintes maneiras de pesquisar recursos do FHIR:
  • Solicitações GET
  • Solicitações POST

Esta página resume muitos dos recursos mais usados, mas não é uma lista completa dos componentes da especificação de pesquisa compatíveis com a API Cloud Healthcare.

Como usar o visualizador de FHIR

Visualização

Esta seção descreve os recursos de visualização que estão sujeitos a alterações e podem ter compatibilidade limitada. As alterações em produtos e recursos pré-GA podem não ser compatíveis com outras versões anteriores ao GA. Para mais informações, consulte os Termos de oferta antes da disponibilização geral para a API Cloud Healthcare e as descrições do estágio de lançamento.

O visualizador de FHIR é uma página no Console do Cloud que permite pesquisar e visualizar o conteúdo dos recursos do FHIR.

Para pesquisar recursos em um armazenamento de FHIR, siga estas etapas:

1. No Console do Cloud, acesse a página do visualizador do FHIR.

   Acessar o visualizador de FHIR

2. Na lista suspensa FHIR Store, selecione um conjunto de dados e, em seguida, selecione um armazenamento de FHIR no conjunto de dados.

3. Para filtrar a lista de tipos de recursos, pesquise os tipos que você quer exibir:

   1. Clique no campo Tipo de recurso.

   2. Na lista suspensa Propriedades exibida, selecione Tipo de recurso.

   3. Digite um tipo de recurso.

   4. Para procurar outro tipo de recurso, selecione OR na lista suspensa Operadores exibida e insira outro tipo de recurso.

4. Na lista de tipos de recursos, selecione o que você quer pesquisar.

5. Na caixa de pesquisa para a tabela de recursos exibida, insira o valor que você quer pesquisar.

O visualizador de FHIR exibe os resultados da pesquisa em uma tabela. Depois que você seleciona um recurso, o visualizador de FHIR exibe o conteúdo do recurso.

Ao visualizar o conteúdo de um recurso, é possível pesquisar dados nele.

Para pesquisar dados dentro de um recurso, siga estas etapas:

1. Selecione um recurso.

2. No painel Visualizador do FHIR, clique na guia Elementos.

3. Na caixa de pesquisa, digite o valor que você quer pesquisar.

Como usar o método search

Para pesquisar recursos FHIR com a API REST, use o método projects.locations.datasets.fhirStores.fhir.search. É possível chamar o método usando solicitações GET ou POST.

Como usar o método search com GET

Os exemplos a seguir mostram como pesquisar recursos em um determinado armazenamento FHIR usando o método projects.locations.datasets.fhirStores.fhir.search com GET.

curl

Para pesquisar recursos em um armazenamento FHIR, faça uma solicitação GET e especifique as seguintes informações:

• O nome do conjunto de dados
• O nome do armazenamento FHIR
• O tipo de recurso a ser pesquisado
• Uma string de consulta contendo as informações que você está pesquisando, conforme descrito na seção Como criar uma consulta de pesquisa
• Um token de acesso

O exemplo a seguir mostra uma solicitação GET usando curl para pesquisar todos os pacientes com o sobrenome "Smith".

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient?family:exact=Smith"

Se a solicitação for bem-sucedida, o servidor retornará a resposta como um Bundle do FHIR no formato JSON. O Bundle.type é searchset, e os resultados da pesquisa são entradas na matriz Bundle.entry. Neste exemplo, a solicitação retorna um único recurso Paciente, incluindo os dados dentro do recurso:

{
  "entry": [
    {
      "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_ID",
      "resource": {
        "birthDate": "1970-01-01",
        "gender": "female",
        "id": "PATIENT_ID",
        "meta": {
          "lastUpdated": "LAST_UPDATED",
          "versionId": "VERSION_ID"
        },
        "name": [
          {
            "family": "Smith",
            "given": [
              "Darcy"
            ],
            "use": "official"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/?family%3Aexact=Smith"
    }
  ],
  "resourceType": "Bundle",
  "total": 1,
  "type": "searchset"
}

PowerShell

Para pesquisar recursos em um armazenamento FHIR, faça uma solicitação GET e especifique as seguintes informações:

• O nome do conjunto de dados
• O nome do armazenamento FHIR
• O tipo de recurso a ser pesquisado
• Uma string de consulta contendo as informações que você está pesquisando, conforme descrito na seção Como criar uma consulta de pesquisa
• Um token de acesso

O exemplo a seguir mostra uma solicitação GET usando o Windows PowerShell para pesquisar todos os pacientes com o sobrenome "Smith".

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-RestMethod `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/RESOURCE_TYPE?family:exact=Smith" | ConvertTo-Json

Se a solicitação for bem-sucedida, o servidor retornará a resposta como um Bundle do FHIR no formato JSON. O Bundle.type é searchset, e os resultados da pesquisa são entradas na matriz Bundle.entry. Neste exemplo, a solicitação retorna um único recurso Paciente, incluindo os dados dentro do recurso:

{
  "entry": [
    {
      "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_ID",
      "resource": {
        "birthDate": "1970-01-01",
        "gender": "female",
        "id": "PATIENT_ID",
        "meta": {
          "lastUpdated": "LAST_UPDATED",
          "versionId": "VERSION_ID"
        },
        "name": [
          {
            "family": "Smith",
            "given": [
              "Darcy"
            ],
            "use": "official"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/?family%3Aexact=Smith"
    }
  ],
  "resourceType": "Bundle",
  "total": 1,
  "type": "searchset"
}

Java

Ver no GitHub Feedback

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.healthcare.v1.CloudHealthcare;
import com.google.api.services.healthcare.v1.CloudHealthcareScopes;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Collections;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;

public class FhirResourceSearchGet {
  private static final String FHIR_NAME =
      "projects/%s/locations/%s/datasets/%s/fhirStores/%s/fhir/%s";
  private static final JsonFactory JSON_FACTORY = new JacksonFactory();
  private static final NetHttpTransport HTTP_TRANSPORT = new NetHttpTransport();

  public static void fhirResourceSearchGet(String resourceName)
      throws IOException, URISyntaxException {
    // String resourceName =
    //    String.format(
    //        FHIR_NAME, "project-id", "region-id", "dataset-id", "store-id", "resource-type");

    // Initialize the client, which will be used to interact with the service.
    CloudHealthcare client = createClient();

    HttpClient httpClient = HttpClients.createDefault();
    String uri = String.format("%sv1/%s", client.getRootUrl(), resourceName);
    URIBuilder uriBuilder = new URIBuilder(uri).setParameter("access_token", getAccessToken());

    HttpUriRequest request =
        RequestBuilder.get()
            .setUri(uriBuilder.build())
            .addHeader("Content-Type", "application/fhir+json")
            .addHeader("Accept-Charset", "utf-8")
            .addHeader("Accept", "application/fhir+json; charset=utf-8")
            .build();

    // Execute the request and process the results.
    HttpResponse response = httpClient.execute(request);
    HttpEntity responseEntity = response.getEntity();
    if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
      System.err.print(
          String.format(
              "Exception searching GET FHIR resources: %s\n", response.getStatusLine().toString()));
      responseEntity.writeTo(System.err);
      throw new RuntimeException();
    }
    System.out.println("FHIR resource search results: ");
    responseEntity.writeTo(System.out);
  }

  private static CloudHealthcare createClient() throws IOException {
    // Use Application Default Credentials (ADC) to authenticate the requests
    // For more information see https://cloud.google.com/docs/authentication/production
    GoogleCredentials credential =
        GoogleCredentials.getApplicationDefault()
            .createScoped(Collections.singleton(CloudHealthcareScopes.CLOUD_PLATFORM));

    // Create a HttpRequestInitializer, which will provide a baseline configuration to all requests.
    HttpRequestInitializer requestInitializer =
        request -> {
          new HttpCredentialsAdapter(credential).initialize(request);
          request.setConnectTimeout(60000); // 1 minute connect timeout
          request.setReadTimeout(60000); // 1 minute read timeout
        };

    // Build the client for interacting with the service.
    return new CloudHealthcare.Builder(HTTP_TRANSPORT, JSON_FACTORY, requestInitializer)
        .setApplicationName("your-application-name")
        .build();
  }

  private static String getAccessToken() throws IOException {
    GoogleCredentials credential =
        GoogleCredentials.getApplicationDefault()
            .createScoped(Collections.singleton(CloudHealthcareScopes.CLOUD_PLATFORM));

    return credential.refreshAccessToken().getTokenValue();
  }
}

Node.js

Ver no GitHub Feedback

const {google} = require('googleapis');
const healthcare = google.healthcare('v1');

const searchFhirResourcesGet = async () => {
  const auth = await google.auth.getClient({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  });
  google.options({auth});

  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const fhirStoreId = 'my-fhir-store';
  // const resourceType = 'Patient';
  const parent = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}/fhirStores/${fhirStoreId}/fhir`;
  const request = {parent, resourceType};

  const response = await healthcare.projects.locations.datasets.fhirStores.fhir.search(
    request
  );
  const resources = response.data.entry;
  console.log(`Resources found: ${resources.length}`);
  console.log(JSON.stringify(resources, null, 2));
};

searchFhirResourcesGet();

Python

Ver no GitHub Feedback

def search_resources_get(
    base_url, project_id, cloud_region, dataset_id, fhir_store_id, resource_type,
):
    """
    Searches resources in the given FHIR store.

    It uses the searchResources GET method.
    """
    url = "{}/projects/{}/locations/{}".format(base_url, project_id, cloud_region)

    resource_path = "{}/datasets/{}/fhirStores/{}/fhir/{}".format(
        url, dataset_id, fhir_store_id, resource_type
    )

    # Make an authenticated API request
    session = get_session()

    response = session.get(resource_path)
    response.raise_for_status()

    resources = response.json()

    print(
        "Using GET request, found a total of {} {} resources:".format(
            resources["total"], resource_type
        )
    )
    print(json.dumps(resources, indent=2))

    return resources

Como usar o método search com POST

Os exemplos a seguir mostram como pesquisar recursos em um determinado armazenamento FHIR usando o método projects.locations.datasets.fhirStores.fhir.search com POST.

curl

Para pesquisar recursos em um armazenamento FHIR, faça uma solicitação POST e especifique as seguintes informações:

• O nome do conjunto de dados
• O nome do armazenamento FHIR
• O tipo de recurso a ser pesquisado
• Uma string de consulta contendo as informações que você está pesquisando, conforme descrito na seção Como criar uma consulta de pesquisa
• Um token de acesso

O exemplo a seguir mostra uma solicitação POST usando curl para pesquisar todos os pacientes com o sobrenome "Smith".

curl -X POST \
    --data "" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/fhir+json; charset=utf-8" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/_search?family:exact=Smith"

Se a solicitação for bem-sucedida, o servidor retornará a resposta como um Bundle do FHIR no formato JSON. O Bundle.type é searchset, e os resultados da pesquisa são entradas na matriz Bundle.entry. Neste exemplo, a solicitação retorna um único recurso Paciente, incluindo os dados dentro do recurso:

{
  "entry": [
    {
      "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_ID",
      "resource": {
        "birthDate": "1970-01-01",
        "gender": "female",
        "id": "PATIENT_ID",
        "meta": {
          "lastUpdated": "LAST_UPDATED",
          "versionId": "VERSION_ID"
        },
        "name": [
          {
            "family": "Smith",
            "given": [
              "Darcy"
            ],
            "use": "official"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/?family%3Aexact=Smith"
    }
  ],
  "resourceType": "Bundle",
  "total": 1,
  "type": "searchset"
}

PowerShell

Para pesquisar recursos em um armazenamento FHIR, faça uma solicitação POST e especifique as seguintes informações:

• O nome do conjunto de dados
• O nome do armazenamento FHIR
• O tipo de recurso a ser pesquisado
• Uma string de consulta contendo as informações que você está pesquisando, conforme descrito na seção Como criar uma consulta de pesquisa
• Um token de acesso

O exemplo a seguir mostra uma solicitação POST usando o Windows PowerShell para pesquisar todos os pacientes com o sobrenome "Smith".

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-RestMethod `
  -Method Post `
  -Headers $headers `
  -ContentType: "application/fhir+json; charset=utf-8" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/_search?family:exact=Smith" | ConvertTo-Json

Se a solicitação for bem-sucedida, o servidor retornará a resposta como um Bundle do FHIR no formato JSON. O Bundle.type é searchset, e os resultados da pesquisa são entradas na matriz Bundle.entry. Neste exemplo, a solicitação retorna um único recurso Paciente, incluindo os dados dentro do recurso:

{
  "entry": [
    {
      "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_ID",
      "resource": {
        "birthDate": "1970-01-01",
        "gender": "female",
        "id": "PATIENT_ID",
        "meta": {
          "lastUpdated": "LAST_UPDATED",
          "versionId": "VERSION_ID"
        },
        "name": [
          {
            "family": "Smith",
            "given": [
              "Darcy"
            ],
            "use": "official"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/?family%3Aexact=Smith"
    }
  ],
  "resourceType": "Bundle",
  "total": 1,
  "type": "searchset"
}

Java

Ver no GitHub Feedback

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.healthcare.v1.CloudHealthcare;
import com.google.api.services.healthcare.v1.CloudHealthcareScopes;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Collections;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.HttpClients;

public class FhirResourceSearchPost {
  private static final String FHIR_NAME =
      "projects/%s/locations/%s/datasets/%s/fhirStores/%s/fhir/%s";
  private static final JsonFactory JSON_FACTORY = new JacksonFactory();
  private static final NetHttpTransport HTTP_TRANSPORT = new NetHttpTransport();

  public static void fhirResourceSearchPost(String resourceName)
      throws IOException, URISyntaxException {
    // String resourceName =
    //    String.format(
    //        FHIR_NAME, "project-id", "region-id", "dataset-id", "store-id", "resource-type");

    // Initialize the client, which will be used to interact with the service.
    CloudHealthcare client = createClient();

    HttpClient httpClient = HttpClients.createDefault();
    String uri = String.format("%sv1/%s/_search", client.getRootUrl(), resourceName);
    URIBuilder uriBuilder = new URIBuilder(uri).setParameter("access_token", getAccessToken());
    StringEntity requestEntity = new StringEntity("");

    HttpUriRequest request =
        RequestBuilder.post()
            .setUri(uriBuilder.build())
            .setEntity(requestEntity)
            .addHeader("Content-Type", "application/fhir+json")
            .addHeader("Accept-Charset", "utf-8")
            .addHeader("Accept", "application/fhir+json; charset=utf-8")
            .build();

    // Execute the request and process the results.
    HttpResponse response = httpClient.execute(request);
    HttpEntity responseEntity = response.getEntity();
    if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
      System.err.print(
          String.format(
              "Exception searching POST FHIR resources: %s\n",
              response.getStatusLine().toString()));
      responseEntity.writeTo(System.err);
      throw new RuntimeException();
    }
    System.out.println("FHIR resource search results: ");
    responseEntity.writeTo(System.out);
  }

  private static CloudHealthcare createClient() throws IOException {
    // Use Application Default Credentials (ADC) to authenticate the requests
    // For more information see https://cloud.google.com/docs/authentication/production
    GoogleCredentials credential =
        GoogleCredentials.getApplicationDefault()
            .createScoped(Collections.singleton(CloudHealthcareScopes.CLOUD_PLATFORM));

    // Create a HttpRequestInitializer, which will provide a baseline configuration to all requests.
    HttpRequestInitializer requestInitializer =
        request -> {
          new HttpCredentialsAdapter(credential).initialize(request);
          request.setConnectTimeout(60000); // 1 minute connect timeout
          request.setReadTimeout(60000); // 1 minute read timeout
        };

    // Build the client for interacting with the service.
    return new CloudHealthcare.Builder(HTTP_TRANSPORT, JSON_FACTORY, requestInitializer)
        .setApplicationName("your-application-name")
        .build();
  }

  private static String getAccessToken() throws IOException {
    GoogleCredentials credential =
        GoogleCredentials.getApplicationDefault()
            .createScoped(Collections.singleton(CloudHealthcareScopes.CLOUD_PLATFORM));

    return credential.refreshAccessToken().getTokenValue();
  }
}

Node.js

Ver no GitHub Feedback

const {google} = require('googleapis');
const healthcare = google.healthcare('v1');

const searchFhirResourcesPost = async () => {
  const auth = await google.auth.getClient({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  });
  google.options({auth, method: 'POST'});

  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const fhirStoreId = 'my-fhir-store';
  // const resourceType = 'Patient';
  const parent = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}/fhirStores/${fhirStoreId}/fhir`;
  const request = {parent, resourceType};

  const response = await healthcare.projects.locations.datasets.fhirStores.fhir.search(
    request
  );
  const resources = response.data.entry;
  console.log(`Resources found: ${resources.length}`);
  console.log(JSON.stringify(resources, null, 2));
};

searchFhirResourcesPost();

Python

Ver no GitHub Feedback

def search_resources_post(
    base_url, project_id, cloud_region, dataset_id, fhir_store_id
):
    """
    Searches resources in the given FHIR store.

    It uses the
    _search POST method and a query string containing the
    information to search for. In this sample, the search criteria is
    'family:exact=Smith' on a Patient resource.
    """
    url = "{}/projects/{}/locations/{}".format(base_url, project_id, cloud_region)

    fhir_store_path = "{}/datasets/{}/fhirStores/{}/fhir".format(
        url, dataset_id, fhir_store_id
    )

    resource_path = "{}/Patient/_search?family:exact=Smith".format(fhir_store_path)

    # Make an authenticated API request
    session = get_session()

    headers = {"Content-Type": "application/fhir+json;charset=utf-8"}

    response = session.post(resource_path, headers=headers)
    response.raise_for_status()

    resources = response.json()
    print(
        "Using POST request, found a total of {} Patient resources:".format(
            resources["total"]
        )
    )

    print(json.dumps(resources, indent=2))

    return resources

Como criar uma consulta de pesquisa

A string de consulta é uma série de pares name=value codificados no formato de URL. Uma pesquisa combina todos os pares com um AND lógico. Cada valor pode ser uma lista de valores separados por vírgulas, que são tratados como um OR lógico desses valores. Exemplo:

Patient?key1=value1&key2=value2,value3

é uma pesquisa por recursos Patient pelos critérios:

(key1 = value1) AND (key2 = value2 OR key2 = value3)

Não há sintaxe para executar um OR de dois pares nome=valor.

Cada tipo de recurso do FHIR define os próprios parâmetros de pesquisa em cada versão do FHIR. Os parâmetros disponíveis são documentados na especificação FHIR para cada recurso, por exemplo, Paciente R4 FHIR, e podem ser recuperados programaticamente por meio da instrução de capacidade. A API Cloud Healthcare é compatível com a maioria dos parâmetros de pesquisa. As exclusões podem ser encontradas por meio da instrução de capacidade ou da instrução de conformidade com FHIR.

Paginação e classificação

O número máximo de recursos retornados do método de pesquisa é controlado pelo parâmetro _count. Por exemplo, _count=10 retornará no máximo dez recursos correspondentes à consulta. O padrão é 100 e o valor máximo permitido é 1.000.

Se a pesquisa encontrou mais recursos do que cabem em uma página, a resposta incluirá um URL de paginação no campo Bundle.link. Pode haver vários valores retornados nesse campo. O valor com Bundle.link.relation = next indica que o Bundle.link.url correspondente pode ser usado para recuperar a próxima página. O valor de Bundle.total indica o número total de recursos correspondentes. Esse valor será exato se os resultados se encaixarem totalmente em uma página, mas uma estimativa aproximada, pois o número de resultados se torna muito maior do que uma página. Um total exato de uma pesquisa que corresponde a um grande número de resultados só pode ser obtido seguindo os links de paginação repetidamente até que os resultados se esgotem.

Os resultados podem ser classificados usando o parâmetro _sort, que aceita uma lista separada por vírgulas de nomes de parâmetros de pesquisa em ordem de prioridade, opcionalmente com um prefixo - para indicar a ordem decrescente. Exemplo:

_sort=status,-date,category

classificará por status crescente, desempatando por data decrescente e desempatando o restante por categoria crescente.

Observação: Um armazenamento FHIR configurado para usar a versão DSTU2 usará uma sintaxe _sort diferente, que estava presente nessa versão da especificação, em que cada instância de _sort usa um parâmetro de pesquisa e um modificador opcional de :asc ou :desc. Por exemplo, para realizar a mesma classificação do exemplo anterior no DSTU2, use: _sort=status&_sort:desc=date&_sort=category.

Atraso na indexação

Os recursos do FHIR são indexados de forma assíncrona. Portanto, pode haver um pequeno atraso entre o momento em que um recurso é criado ou alterado e quando a alteração é refletida nos resultados da pesquisa.

Como pesquisar em todos os tipos de recursos

Alguns parâmetros de pesquisa, diferenciados por um sublinhado à esquerda, como _id, aplicam-se a todos os tipos de recursos. Esses parâmetros de todos os recursos estão listados na especificação FHIR para o tipo Resource.

Ao usar esses parâmetros de pesquisa, você pode realizar uma pesquisa em vários tipos de recursos omitindo o tipo de recurso do caminho da solicitação. Por exemplo, GET .../fhir?_id=1234 em vez de GET .../fhir/Patient?_id=1234 pesquisa em todos os recursos, não apenas em pacientes. O parâmetro especial _type pode ser usado com esse tipo de solicitação para limitar os resultados a uma lista separada por vírgulas de tipos de recursos, por exemplo:

GET .../fhir?_tag=active&_type=Observation,Condition

retornará apenas resultados correspondentes aos recursos Observation e Condition.

Tipos de dados

Cada parâmetro de pesquisa definido pelo FHIR tem um tipo de dados, que inclui tipos primitivos, como string, número e data, e também tipos complexos, como token, referência e quantidade. Cada tipo de dados tem sua própria sintaxe para especificar valores e suporta modificadores que alteram como a pesquisa é realizada.

Veja alguns exemplos simples de como os tipos de dados são usados:

• Número pesquisa valores inteiros ou de ponto flutuante. O valor pode ser prefixado com um modificador como ne, lt, le, gt, ge para alterar o comparador, por exemplo, [parameter]=100 para igualdade, [parameter]=ge100 para maior ou igual a 100.
• Data pesquisa qualquer tipo de data, hora ou período. O formato do parâmetro de data é yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm], e os mesmos modificadores de prefixo usados para número também se aplicam aqui.
• String assume como padrão uma pesquisa de prefixo que não diferencia maiúsculas de minúsculas e acentos ou outros sinais diacríticos.
• Token pesquisa uma correspondência exata de string de um "código", opcionalmente com escopo no URI de um "sistema" indicando o conjunto de valores do qual o código é extraído usando o formato [parameter]=[system]|[code]. Por exemplo, code=http://hl7.org/fhir/ValueSet/observation-codes|10738-3 corresponde a um código 10738-3, mas somente quando qualificado como um valor de um sistema de codificação com o URI especificado.
• Quantidade pesquisa um valor numérico usando os mesmos modificadores de prefixo que o número, opcionalmente qualificado com um sistema e código específicos que indicam as unidades do valor no formato [parameter]=[prefix][number]|[system]|[code]. Por exemplo, value-quantity=lt9.1|http://unitsofmeasure.org|mg pesquisa valores de quantidade menores que 9.1 com o sistema de unidades e o código especificados.
• Referência pesquisa referências entre recursos, que podem ser especificados por [parameter]=[id] ou [parameter]=[type]/[id] para referências a recursos dentro do armazenamento FHIR ou [parameter]=[url] para referências por URL que podem estar fora do armazenamento FHIR.

Mais detalhes sobre outros tipos de dados, sintaxes de valor e modificadores podem ser encontrados em Recursos de pesquisa avançada do FHIR.

Manipulação dos parâmetros de pesquisa

Por padrão, o método de pesquisa aplica uma manipulação "flexível", que ignora os parâmetros que não reconhece e realiza a pesquisa usando os parâmetros restantes na solicitação, o que pode retornar mais recursos do que o esperado.

A resposta incluirá um valor em Bundle.link com um valor de Bundle.link.relation = self e um Bundle.link.url de um URL contendo apenas os parâmetros que foram aplicados à pesquisa. Esse valor pode ser inspecionado para determinar se algum parâmetro foi ignorado.

Como alternativa, definir o cabeçalho HTTP Prefer: handling=strict em uma solicitação de pesquisa fará com que o armazenamento FHIR retorne um erro em caso de qualquer parâmetro não reconhecido.

Observação: definir a opção de armazenamento FHIR defaultSearchHandlingStrict altera esse padrão para strictem todas as solicitações de pesquisa, a menos que uma solicitação individual use o cabeçalho HTTP Prefer: handling=lenient para escolher uma opção flexível.