Cadastrar ou atualizar

POST

/fhir/resources/Location

POST

/fhir/resources/Location

$ curl -X POST https://landing-zone-api.nilo.services/fhir/resources/Location \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "resourceType": "Location",
>   "identifier": [
>     {
>       "system": "https://www.acmesaude.com.br/integracao/local/",
>       "value": "HC-01",
>       "use": "usual"
>     }
>   ],
>   "name": "Hospital Central Acme",
>   "address": {
>     "line": [
>       "Rua Tamandaré",
>       "321",
>       "Casa 2"
>     ],
>     "postalCode": "01503-001",
>     "district": "Liberdade",
>     "city": "São Paulo",
>     "state": "SP",
>     "country": "Brasil"
>   }
> }'

1 {
2   "resourceType": "Location",
3   "identifier": [
4     {
5       "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/almanac-api--health-facility",
6       "value": "295",
7       "use": "usual"
8     },
9     {
10       "system": "https://cnes.datasus.gov.br/",
11       "value": "2077485",
12       "use": "official"
13     },
14     {
15       "system": "https://www.acmesaude.com.br/integracao/local/",
16       "value": "HC-01",
17       "use": "usual"
18     }
19   ],
20   "name": "Hospital Central Acme",
21   "id": "8b53f107-2d94-4c6e-a71f-9042e5b8c316",
22   "meta": {
23     "lastUpdated": "2026-08-24T13:42:07.554000Z",
24     "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
25   },
26   "address": {
27     "line": [
28       "Rua Tamandaré",
29       "321",
30       "Casa 2"
31     ],
32     "postalCode": "01503-001",
33     "district": "Liberdade",
34     "city": "São Paulo",
35     "state": "SP",
36     "country": "Brasil",
37     "text": "Rua Tamandaré, 321, Casa 2 - Liberdade, São Paulo/SP. 01503-001.",
38     "use": "work",
39     "type": "both"
40   }
41 }

Cria um local de atendimento ou atualiza um existente, reconhecido pelo identifier. Grava nome, código CNES e endereço. Omitir address numa atualização apaga o endereço já cadastrado.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

resourceTypestringRequiredDefaults to Location

Indica o tipo do recurso transacionado.

identifierlist of objectsRequired

Suas chaves do local. Obrigatório na escrita: é por elas que a API decide entre criar um local novo e atualizar um existente. Um identificador no system https://cnes.datasus.gov.br/ é tratado à parte — o value dele vira o código CNES do estabelecimento, que é único no ambiente.

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

Nome do estabelecimento. No máximo 200 caracteres.

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

Só resposta: identificador Nilo FHIR do local.

metaobjectOptional

Só resposta: metadados da gravação.

addressobjectOptional

Endereço do estabelecimento. Omitir este campo numa atualização apaga o endereço já cadastrado.

Response

Local criado ou atualizado. O corpo é o recurso como ficou gravado, sem envelope.

resourceTypestringDefaults to Location

Indica o tipo do recurso transacionado.

identifierlist of objects

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