Buscar por parâmetros

GET

/fhir/resources/Group

GET

/fhir/resources/Group

curl -G https://landing-zone-api.nilo.services/fhir/resources/Group \
     -H "x-api-key: <apiKey>" \
     -d _count=50 \
     -d _lastUpdated=eq2013-01-14 \
     -d actual=true \
     --data-urlencode identifier=https://www.acmesaude.com.br/integracao/grupo/|GR-500 \
     -d type=person

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Group/6b41e097-2c58-4a3d-91f0-7e25c48b0a63",
      "resource": {
        "resourceType": "Group",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/sorting-hat-api--cohort",
            "value": "1042",
            "use": "usual"
          },
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--cohort",
            "value": "1042",
            "use": "usual"
          },
          {
            "system": "https://www.acmesaude.com.br/integracao/grupo/",
            "value": "GR-500",
            "use": "usual"
          }
        ],
        "name": "Gestantes de alto risco",
        "id": "6b41e097-2c58-4a3d-91f0-7e25c48b0a63",
        "meta": {
          "lastUpdated": "2026-02-19T13:44:07.615000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
        },
        "active": true,
        "actual": true,
        "type": "person"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Devolve os grupos de pacientes do seu ambiente. A participação dos pacientes não vem aqui — ela está no recurso de cada paciente.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

Identificador do grupo, na sintaxe system|value. Aceita a sua chave ou um dos dois identificadores Nilo.

typeenumOptional

Aceito, e inútil: todo grupo é person.

Allowed values:

actualstringOptional

Aceito, e inútil: todo grupo é true.

_countintegerOptional

Quantidade de registros por página.

_lastUpdatedlist of stringsOptional

Data de última alteração dos registros que devem ser retornado.

Response

Operação bem sucedida.

resourceTypestringDefaults to Bundle

Indica o tipo do recurso transacionado.

typeenum

Constante searchset neste endpoint.

Allowed values:

entrylist of objectsOptional

Uma entrada por grupo encontrado. Vazia quando não há resultados.

linklist of objectsOptionalRead-only

Navegação do resultado. Havendo próxima página, ela vem pronta em next.

Errors

400

Bad Request Error