Cadastrar/Atualizar

Endpoint	POST /fhir/resources/Flag
Autenticação	🔓 Chave de API
Status	Implementado

Modelagem da API - Request

---

Headers

Opção	Tipo	Requerido	Descrição				Exemplo
x-api-key	string	Sim	Chave de autenticação do cliente, fornecida durante a configuração do ambiente.
Content-Type	string	Sim					application/json

Body

resourceType required	any Value: "Location"
id	string (id) ^[A-Za-z0-9\-\.]{{1,64}}$ Qualquer combinação de letras, números, "-" e ".", com um limite de 64 caracteres. (Pode ser um número inteiro, um OID não prefixado, UUID ou qualquer outro padrão de identificador que atenda a essas restrições.) Os IDs não diferenciam maiúsculas de minúsculas.
	Array of objects (Identifier)
status	any Enum: "active" "suspended" "inactive"
	object (Address) Um endereço expresso usando convenções postais.

{

• "resourceType": "Location",
• "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
• "identifier": [

  • {

    • "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
    • "use": "usual",
    • "value": "12345"

    }

  ],
• "status": "active",
• "address": {

  • "city": "São Paulo",
  • "country": "Brazil",
  • "line": [

    • "534 Erewhon St"

    ],
  • "postalCode": "39993-333",
  • "state": "SP",
  • "text": "534 Erewhon St PeasantVille, Rainbow, Vic 3999",
  • "type": "both",
  • "use": "home"

  }

}

Modelo de Dados

---

Ao criar um novo local, você enviará um payload contendo os campos: name, address e identifier. Iremos processar a requisição e retornar o recurso completo.

Exemplo de Payload para criação de um Local:

{
  "address": {
    "city": "São Paulo",
    "country": "Brazil",
    "district": "Liberdade",
    "line": [
      "Rua Tamandaré",
      "321",
      "casa2"
    ],
  },
  "identifier": [
    {
      "system": "https://sistemaficticio.acmesaude.com.br/fhir/resources/NamingSystem/health-facility",
      "use": "usual",
      "value": "295"
    }
  ],
  "name": "Hospital Central",
  "resourceType": "Location"
}

atenção

O system neste exemplo é um valor genérico. Para que o identificador seja válido, por favor, substitua-o pelo system oficial do NamingSystem que foi provisionado para a sua instância.

O campo name é a string que representa o nome do local, enquanto o identifier é uma lista de seus identificadores únicos (cada um contendo system, use e value).

Já o address é um objeto que detalha o endereço, incluindo city, country, district e line. Embora este campo não seja obrigatório, seu preenchimento é recomendado para garantir a correta localização. Caso o address seja incluído, certifique-se de que seus subcampos estejam preenchidos corretamente.