Buscar por parâmetros

GET

/fhir/resources/InsurancePlan

GET

/fhir/resources/InsurancePlan

curl -G https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan \
     -H "x-api-key: <apiKey>" \
     -d _count=50 \
     -d _lastUpdated=eq2013-01-14 \
     --data-urlencode identifier=https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2|2481 \
     -d name=Ambulatorial \
     -d status=active

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan/61a4c8d2-9e35-47bb-a0f1-2c7d5e8b3f90",
      "resource": {
        "resourceType": "InsurancePlan",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2",
            "value": "2481",
            "use": "usual"
          }
        ],
        "name": "Acme Saúde Ambulatorial",
        "id": "61a4c8d2-9e35-47bb-a0f1-2c7d5e8b3f90",
        "status": "active"
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan/0d7f3e51-8c26-4a90-bb14-7e5a1c9d2408",
      "resource": {
        "resourceType": "InsurancePlan",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2",
            "value": "1907",
            "use": "usual"
          }
        ],
        "name": "Acme Saúde Básico (encerrado)",
        "id": "0d7f3e51-8c26-4a90-bb14-7e5a1c9d2408",
        "status": "retired"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Devolve o catálogo de planos de saúde do seu ambiente. É por aqui que se descobre o id do plano a usar em Coverage.class[0].value.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

Identificador do plano, na sintaxe system|value. Os planos do catálogo trazem o identificador Nilo; uma chave sua só encontra o plano se você a tiver gravado nele.

namestringOptional

Parte do nome do plano.

statusenumOptional

Situação do plano: active num plano em uso, retired num plano desativado.

Allowed values:

_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 plano 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