Pular para o conteúdo principal

Associar/atualizar

Endpoint

POST /fhir/resources/CarePlan

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 para inserir paciente em uma linha de cuidado:​


curl --request POST \
--url https://landing-zone-api.dev.nilo.services/fhir/resources/CarePlan \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '{
    "resourceType": "CarePlan",
    "identifier": [
        {
            "use": "usual",
            "system": "https://www.acmesaude.com.br/CarePlan/",
            "value": "349223"
        }
    ],
    "instantiatesCanonical": [
        "https://landing-zone-api.dev.nilo.services/fhir/resources/PlanDefinition/aba72582-f9fb-49ea-b316-73b8dba2a4d7",
    ]
    "status": "draft",
    "intent": "order",
    "subject": {
        "identifier": {
            "use": "official",
            "system": "https://servicos.receita.fazenda.gov.br/servicos/cpf/",
            "value": "43927194050"
        },
        "type": "Patient"
    }
}'

Modelagem da API - Response​

Operação bem sucedida.

Array of objects (Identifier)

Identificador(es) pelo qual este recurso é distinguido.

instantiatesCanonical
required
Array of strings

Lista de URLs completas referenciando os PlanDefinitions usados como base para plano de cuidado. (No momento é possível instanciar apenas um PlanDefinition)

intent
required
string^[^\s]+(\s[^\s]+)*$
Value: "order"

Indica o nível de autoridade/intencionalidade associada ao plano de cuidados. No momento só é suportado o intent order, que significa aplicação imediata.

resourceType
required
string
Default: "CarePlan"

Indica o tipo do recurso transacionado.

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

Indica a situação do plano de cuidado.
draft: plano está na fila para que o paciente seja alocado; (padrão para novas escritas)
active: o plano está sendo executado no momento;
revoked: plano suspenso, atividades futuras canceladas;
completed: a plano foi encerrado dentro do prazo previsto;
entered-in-error: houve erro na aplicação do plano (verificar na UI do Nilo Care).

required
object

Paciente para o qual esse plano de cuidado foi planejado.

{
  • "identifier": [
    ],
  • "instantiatesCanonical": [
    ],
  • "intent": "order",
  • "resourceType": "CarePlan",
  • "status": "active",
  • "subject": {
    }
}