Pular para o conteúdo principal

Cadastrar

Endpoint

POST /fhir/resources/Coverage

Autenticação🔓 Chave de API
StatusImplementado

Modelagem da API - Request​

OpçãoTipoRequeridoDescriçãoExemplo
x-api-keystringSim

Chave de autenticação do cliente, fornecida durante a configuração do ambiente.

Content-TypestringSimapplication/json


Exemplo de requisição CURL

curl --request POST \
--url https://landing-zone-api.nilo.services/fhir/resources/Coverage \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '{
  "resourceType": "Coverage",
  "identifier": [
    {
      "use": "usual",
      "system": "https://sistemadocliente.com/beneficios",
      "value": "12345"
    }
  ],
  "status": "active",
  "policyHolder": {
    "display": "Petrobras"
  },
  "subscriber": {
    "identifier": {
      "use": "usual",
      "system": "https://sistemadocliente.com/paciente",
      "value": "12345"
    }
  },
  "subscriberId": 1352743,
  "beneficiary": {
    "identifier": {
      "use": "usual",
      "system": "https://sistemadocliente.com/paciente",
      "value": "12346"
    }
  },
  "dependent": 1352744,
  "relationship": {
    "coding": [
      {
        "code": "spouse"
      }
    ]
  },
  "period": {
    "start": "2022-05-23T19:00:00+00:00",
    "end": "2022-05-23T19:00:00+00:00"
  },
  "payor": [
    {
      "display": "Unimed"
    }
  ],
  "class": [
    {
      "type": {
        "coding": [
          {
            "code": "plan"
          }
        ]
      },
      "value": "UC423",
      "name": "Unimed com coparticipação SP/SP"
    }
  ]
}'


Modelagem da API - Response​

Operação bem sucedida.

required
object

Beneficiário no NiloCare.

Array of objects (Coverage_Class)

Classificações do benefício.

Array of objects (Reference)

Contrato do Benefício.

Array of objects (Coverage_CostToBeneficiary)

Co-participação financeira de responsabilidade do beneficiário.

dependent
string^[ \r\n\t\S]+$

Número (carteirinha) do beneficiário, quando for um dependente de um titular.

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)

Identificador(es) pelo qual este recurso é distinguido.

object (Meta)

Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.

network
string^[ \r\n\t\S]+$

Descrições sobre a rede de atendimento.

order
number^[1-9][0-9]*$

Ordem de prioridade de uso entre benefícios.

required
Array of objects (Reference)

Entidade pagadora dos custos de saúde (Seguradora, Operadora, ...)

object

Período de validade do benefício.

object

Contratante (Estipulante), dono da apólice do benefício.

object

Relação entre titular e beneficiário.

resourceType
required
string
Default: "Coverage"

Indica o tipo do recurso transacionado.

status
required
string^[^\s]+(\s[^\s]+)*$
Enum: "active" "cancelled" "draft" "entered-in-error"

Situação atual do benefício.

subrogation
boolean^true|false$

Indica se o benefício conta com reembolso.

object

Titular do benefício no NiloCare.

subscriberId
string^[ \r\n\t\S]+$

Número (carteirinha) do titular do benefício.

object

O tipo de benefício disponibilizado, por exemplo, Plano de Saúde.

{
  • "beneficiary": {
    },
  • "class": {
    },
  • "contract": [
    ],
  • "costToBeneficiary": [
    ],
  • "dependent": 1352744,
  • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
  • "identifier": [
    ],
  • "meta": {
    },
  • "network": "Rede de atendimento preferêncial C465 de São Paulo capital",
  • "order": 0,
  • "payor": {
    },
  • "period": {
    },
  • "policyHolder": {
    },
  • "relationship": {
    },
  • "resourceType": "Coverage",
  • "status": "active",
  • "subrogation": true,
  • "subscriber": {
    },
  • "subscriberId": 1352743,
  • "type": {
    }
}