Cadastrar ou atualizar

POST

/fhir/resources/Organization

POST

/fhir/resources/Organization

$ curl -X POST https://landing-zone-api.nilo.services/fhir/resources/Organization \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "resourceType": "Organization",
>   "identifier": [
>     {
>       "system": "https://www.acmesaude.com.br/integracao/unidade/",
>       "value": "UC-01",
>       "use": "usual"
>     }
>   ],
>   "name": "Unidade Centro"
> }'

1 {
2   "resourceType": "Organization",
3   "identifier": [
4     {
5       "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/sorting-hat-api--care-unit",
6       "value": "812",
7       "use": "usual"
8     },
9     {
10       "system": "https://www.acmesaude.com.br/integracao/unidade/",
11       "value": "UC-01",
12       "use": "usual"
13     }
14   ],
15   "name": "Unidade Centro",
16   "id": "3f2b91d7-64c8-4a15-8e77-51a0b9c3d204",
17   "meta": {
18     "lastUpdated": "2026-08-24T11:20:41.207000Z",
19     "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
20   },
21   "active": true,
22   "alias": [
23     "Unidade Centro"
24   ],
25   "telecom": [
26     {
27       "system": "phone",
28       "value": "+551155556473"
29     }
30   ]
31 }

Cria uma unidade de cuidado ou renomeia uma existente. O identifier é o que decide entre as duas coisas, e o name é o único dado gravado: todo o resto do payload é descartado.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

resourceTypestringRequiredDefaults to Organization

Indica o tipo do recurso transacionado.

identifierlist of objectsRequired

Suas chaves da unidade. Obrigatório na escrita: é por elas que a API decide entre criar uma unidade nova e renomear uma existente. A leitura devolve o seu identificador ao lado do identificador Nilo da unidade, no system .../NamingSystem/sorting-hat-api--care-unit.

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

Nome da unidade. É o único dado que a plataforma grava — todo o resto do payload é descartado. No máximo 200 caracteres.

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

Só resposta: identificador Nilo FHIR da unidade.

metaobjectOptional

Só resposta: metadados da gravação.

activebooleanOptional

Só resposta: constante true. A plataforma não guarda situação de unidade, e não há como desativar uma unidade por esta API.

Response

Unidade criada ou renomeada. O corpo é o recurso como ficou gravado, sem envelope.

resourceTypestringDefaults to Organization

Indica o tipo do recurso transacionado.

identifierlist of objects

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

Nome da unidade. É o único dado que a plataforma grava — todo o resto do payload é descartado. No máximo 200 caracteres.

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

Só resposta: identificador Nilo FHIR da unidade.

metaobjectOptional

Só resposta: metadados da gravação.

activebooleanOptional

Só resposta: constante true. A plataforma não guarda situação de unidade, e não há como desativar uma unidade por esta API.

aliaslist of stringsOptionalRead-only

Só resposta: repete o name, sem acrescentar informação. Existe por compatibilidade com quem lê o alias do Organization canônico.

telecomlist of objectsOptionalRead-only

Só resposta: o telefone cadastrado para a sua operação, não para esta unidade. Todas as unidades do ambiente devolvem o mesmo número, e ele é omitido quando não há telefone cadastrado.

Errors

400

Bad Request Error