Consultar

Endpoint	GET /fhir/resources/CarePlan/{id}
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
id	string	Não	Chave primária de identificação de um recurso.				ba200cfa-dae0-46cf-81a0-008e3f7414b4

Query

Nome	Tipo	Descrição				Expressão de caminho
_lastUpdated	date	Última vez que esse registro foi alterado.				meta.lastUpdated
_page_token	string	Link para navegar pela paginação de resultados.
identifier	token	Identificador do recurso.				identifier.system & identifier.value

Exemplo de requisição CURL

curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/CareTeam \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???'

Modelagem da API - Response

---

✔ 200 (Busca)

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": "CarePlan",
      • "activity": [

        • {

          • "detail": {

            • "description": "No segundo encontro pré-natal. Discutir quaisquer questões que surgiram desde o primeiro encontro pré-natal.",
            • "kind": "Appointment",
            • "scheduledPeriod": {

              • "end": "2022-05-23T19:00:00+00:00",
              • "start": "2022-05-23T19:00:00+00:00"

              },
            • "status": "completed"

            },
          • "reference": {

            • "identifier": {

              • "system": "{host}/fhir/resources/NamingSystem/...unit",
              • "use": "usual",
              • "value": "12345"

              },
            • "type": "Task"

            }

          }

        ],
      • "category": {

        • "text": "care_line"

        },
      • "created": "2022-05-23T19:00:00+00:00",
      • "period": {

        • "end": "2022-05-23T19:00:00+00:00",
        • "start": "2022-05-23T19:00:00+00:00"

        },
      • "title": "Baixo Risco",
      • "identifier": [

        • {

          • "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
          • "use": "usual",
          • "value": "12345"

          }

        ],
      • "instantiatesCanonical": [

        • "string"

        ],
      • "intent": "order",
      • "status": "active",
      • "subject": {

        • "identifier": {

          • "system": "{host}/fhir/resources/NamingSystem/...unit",
          • "use": "usual",
          • "value": "12345"

          },
        • "type": "Patient"

        }

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

}

✔ 200 (Entidade)

Operação bem sucedida.

	Array of objects (CarePlan_Activity) Identifica uma ação planejada para ocorrer como parte do plano. Por exemplo, um medicamento a ser usado, exames laboratoriais a realizar, automonitoramento, educação, etc.
	Array of objects (CodeableConcept) Identifica qual o tipo do plano de cuidado para apoiar a diferenciação entre vários planos coexistentes; Por exemplo "Linha de cuidado", "Protocolo", ...
created	string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... Data em que o plano foi criado.
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.
	object (Meta) Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.
	object O período onde esse plano esta em execução.
title	string^[ \r\n\t\S]+$ Nome amigável para o plano de cuidado.
	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.

{

• "activity": [

  • {

    • "detail": {

      • "description": "No segundo encontro pré-natal. Discutir quaisquer questões que surgiram desde o primeiro encontro pré-natal.",
      • "kind": "Appointment",
      • "scheduledPeriod": {

        • "end": "2022-05-23T19:00:00+00:00",
        • "start": "2022-05-23T19:00:00+00:00"

        },
      • "status": "completed"

      },
    • "reference": {

      • "identifier": {

        • "system": "{host}/fhir/resources/NamingSystem/...unit",
        • "use": "usual",
        • "value": "12345"

        },
      • "type": "Task"

      }

    }

  ],
• "category": {

  • "text": "care_line"

  },
• "created": "2022-05-23T19:00:00+00:00",
• "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
• "meta": {

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

  },
• "period": {

  • "end": "2022-05-23T19:00:00+00:00",
  • "start": "2022-05-23T19:00:00+00:00"

  },
• "title": "Baixo Risco",
• "identifier": [

  • {

    • "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
    • "use": "usual",
    • "value": "12345"

    }

  ],
• "instantiatesCanonical": [

  • "string"

  ],
• "intent": "order",
• "resourceType": "CarePlan",
• "status": "active",
• "subject": {

  • "identifier": {

    • "system": "{host}/fhir/resources/NamingSystem/...unit",
    • "use": "usual",
    • "value": "12345"

    },
  • "type": "Patient"

  }

}

✘ 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.