Consultar

Endpoint	GET /fhir/resources/Location
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

Parameters

Opção	Tipo	Requerido	Descrição			Exemplo
identifier	string	Não	Chave primária de identificação de um recurso.			ba200cfa-dae0-46cf-81a0-008e3f7414b4

Query

Você poderá utilizar todos os parâmetros de pesquisa disponíveis do recurso canônico.

https://hl7.org/fhir/R4/location.html#search

Exemplo de requisição CURL

curl --request GET \
--url https://landing-zone-api.dev.nilo.services/fhir/resources/Location \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Parâmetros de Busca Suportados

---

Nome		Tipo		Descrição					Expressão FHIR
address		string		Um (parte do) endereço da localização					location.address
address-city		string		O país especificado no endereço					location.address.country
address-country		string		O código postal especificado no endereço					location.address.postalCode
address-state		string		Um estado especificado em um endereço					location.address.state
address-use		token		Um código de uso especificado em um endereço					location.address.use
endpoint		reference		Endpoints técnicos que fornecem acesso a serviços operados para a localização					location.endpoint
identifier		token		Um identificador para a localização					location.identifier
name		string		Uma parte do nome ou alias (apelido) da localização					location.name
near		special		Busca por localizações onde a location.position está próximo					location.position
near		special		Busca por localizações onde a location.position está próxima					location.position
operational-status		token		Busca por localizações (tipicamente leito/quarto) que têm um status operacional					location.operationalStatus
organization		reference		Busca por localizações que são gerenciadas pela organização fornecida					location.managingOrganization
partof		reference		Uma localização da qual esta localização faz parte					location.partOf
status		token		Busca por localizações com um tipo específico de status					location.status
type		token		Um código para o tipo de localização					location.type

Modelagem da API - Response

---

✔ 200

Operação bem sucedida.

	Array of objects Uma lista de recursos do pacote.
	Array of objects Um conjunto de links que fornecem contexto/navegação neste pacote.
resourceType required	string Default: "Bundle" Indica o tipo do recurso transacionado.
type required	string Enum: "document" "message" "transaction" "transaction-response" "batch" "batch-response" "history" "searchset" "collection" Indica a finalidade deste pacote, como ele deve ser usado.

{

• "entry": [

  • {

    • "fullUrl": "{host}/fhir/resources/.../7d154473-...-a5ce077ef77f",
    • "request": {

      • "method": "POST",
      • "url": "Patient"

      },
    • "resource": {

      • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
      • "meta": {

        • "lastUpdated": "2022-05-25T18:42:06.551129+00:00",
        • "versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"

        },
      • "resourceType": "Location",
      • "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"

        }

      },
    • "search": {

      • "mode": "match"

      }

    }

  ],
• "link": [

  • {

    • "relation": "next",
    • "url": "{host}/fhir/resources/Patient?_page_token=Cjj3YopYuf%2F%2F%2F%2F%2BABd%2BbgE0m...dSANQAFoLCUSM7w9VYUqaEANglLWUugQ%3D"

    }

  ],
• "resourceType": "Bundle",
• "type": "searchset"

}

✘ 400

Parâmetro enviado inválido.

required	Array of objects Uma coleção de mensagens de erro, aviso ou informação que resultado de uma ação do sistema.
resourceType required	string Default: "OperationOutcome" Indica o tipo do recurso transacionado.

{

• "issue": [

  • {

    • "code": "exception",
    • "details": {

      • "text": "Parâmetro enviado inválido"

      },
    • "severity": "error"

    }

  ],
• "resourceType": "OperationOutcome"

}

✘ 500

Erro inesperado.