Buscar por parâmetros

GET

/fhir/resources/Location

GET

/fhir/resources/Location

curl -G https://landing-zone-api.nilo.services/fhir/resources/Location \
     -H "x-api-key: <apiKey>" \
     -d _count=50 \
     -d _lastUpdated=eq2013-01-14 \
     -d address=Liberdade \
     --data-urlencode "address-city=São Paulo" \
     -d address-country=Brasil \
     -d address-postalcode=01503-001 \
     --data-urlencode "address-state=São Paulo" \
     --data-urlencode identifier=https://cnes.datasus.gov.br/|2077485 \
     -d name=Central

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Location/8b53f107-2d94-4c6e-a71f-9042e5b8c316",
      "resource": {
        "resourceType": "Location",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/almanac-api--health-facility",
            "value": "295",
            "use": "usual"
          },
          {
            "system": "https://cnes.datasus.gov.br/",
            "value": "2077485",
            "use": "official"
          },
          {
            "system": "https://www.acmesaude.com.br/integracao/local/",
            "value": "HC-01",
            "use": "usual"
          }
        ],
        "name": "Hospital Central Acme",
        "id": "8b53f107-2d94-4c6e-a71f-9042e5b8c316",
        "address": {
          "line": [
            "Rua Tamandaré",
            "321",
            "Casa 2"
          ],
          "postalCode": "01503-001",
          "district": "Liberdade",
          "city": "São Paulo",
          "state": "SP",
          "country": "Brasil",
          "text": "Rua Tamandaré, 321, Casa 2 - Liberdade, São Paulo/SP. 01503-001.",
          "use": "work",
          "type": "both"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Location/c1d09a4e-6b72-4f38-9de5-0a83b7f2c145",
      "resource": {
        "resourceType": "Location",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/almanac-api--health-facility",
            "value": "296",
            "use": "usual"
          }
        ],
        "name": "Ambulatório Zona Sul",
        "id": "c1d09a4e-6b72-4f38-9de5-0a83b7f2c145"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Devolve os locais de atendimento do seu ambiente, com nome, código CNES e endereço.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

Identificador do local, na sintaxe system|value. Aceita a sua chave, o identificador Nilo do local ou o código CNES, no system https://cnes.datasus.gov.br/.

namestringOptional

Parte do nome do estabelecimento.

addressstringOptional

Parte de qualquer campo do endereço.

address-citystringOptional

Cidade do endereço.

address-statestringOptional

Estado do endereço, como ele foi gravado.

address-postalcodestringOptional

CEP do endereço.

address-countrystringOptional

País do endereço.

_countintegerOptional

Quantidade de registros por página.

_lastUpdatedlist of stringsOptional

Data de última alteração dos registros que devem ser retornado.

Response

Operação bem sucedida.

resourceTypestringDefaults to Bundle

Indica o tipo do recurso transacionado.

typeenum

Constante searchset neste endpoint.

Allowed values:

entrylist of objectsOptional

Uma entrada por local 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