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 \
>      --data-urlencode _page_token=Cjj3YopYuf%2F%2F%2F%2F%2BABd%2BbgE0m...dSANQAFoLCUSM7w9VYUqaEANglLWUugQ%3D \
>      -d actual=true \
>      --data-urlencode identifier=https://www.acmesaude.com.br/integracao/grupo/|GR-500 \
>      -d type=person

1 {
2   "resourceType": "Bundle",
3   "type": "searchset",
4   "entry": [
5     {
6       "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Group/6b41e097-2c58-4a3d-91f0-7e25c48b0a63",
7       "resource": {
8         "resourceType": "Group",
9         "identifier": [
10           {
11             "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/sorting-hat-api--cohort",
12             "value": "1042",
13             "use": "usual"
14           },
15           {
16             "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--cohort",
17             "value": "1042",
18             "use": "usual"
19           },
20           {
21             "system": "https://www.acmesaude.com.br/integracao/grupo/",
22             "value": "GR-500",
23             "use": "usual"
24           }
25         ],
26         "name": "Gestantes de alto risco",
27         "id": "6b41e097-2c58-4a3d-91f0-7e25c48b0a63",
28         "meta": {
29           "lastUpdated": "2026-02-19T13:44:07.615000Z",
30           "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
31         },
32         "active": true,
33         "actual": true,
34         "type": "person"
35       },
36       "search": {
37         "mode": "match"
38       }
39     }
40   ],
41   "link": []
42 }

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.

_page_tokenstringOptional

Seleciona a página de um resultado paginado.

Response

Operação bem sucedida.

resourceTypestringDefaults to Bundle

Indica o tipo do recurso transacionado.

typeenum

Constante searchset neste endpoint.

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