Cadastrar, renomear ou apagar

POST

/fhir/resources/Group

POST

/fhir/resources/Group

$ curl -X POST https://landing-zone-api.nilo.services/fhir/resources/Group \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "resourceType": "Group",
>   "identifier": [
>     {
>       "system": "https://www.acmesaude.com.br/integracao/grupo/",
>       "value": "GR-500",
>       "use": "usual"
>     }
>   ],
>   "name": "Gestantes de alto risco"
> }'

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

Cria um grupo, renomeia um existente ou o apaga — este último enviando active: false. Só o name é gravado, e ele é único no ambiente.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

resourceTypestringRequiredDefaults to Group

Indica o tipo do recurso transacionado.

identifierlist of objectsRequired

Suas chaves do grupo. Obrigatório na escrita: é por elas que a API decide entre criar e atualizar. A leitura devolve dois identificadores Nilo, nos system .../NamingSystem/sorting-hat-api--cohort e .../NamingSystem/care-api--cohort.

namestringRequiredformat: "^[ \r\n\t\S]+$"

Nome do grupo. É o único dado gravável, e é único no ambiente — repetir um nome existente responde 409.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"

Só resposta: identificador Nilo FHIR do grupo.

metaobjectOptional

Só resposta: metadados da gravação.

activebooleanOptional

Na leitura, constante true. Na escrita, false apaga o grupo — e só funciona num grupo sem pacientes. Um grupo novo não pode ser criado com false.

actualbooleanOptional

Só resposta: constante true.

typestringOptionalformat: "^[^\s]+(\s[^\s]+)*$"

Só resposta: constante person.

Response

Grupo criado ou renomeado. O corpo é o recurso como ficou gravado, sem envelope.

resourceTypestringDefaults to Group