Consultar

Endpoint	GET /fhir/resources/CarePlan
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/careplan.html#search

Parâmetros de busca suportados

Nome	Tipo	Descrição	Expressão FHIR
identifier	token	Identificador externo do plano de cuidado	CarePlan.identifier
subject	reference	Paciente para quem o plano de cuidado se destina	CarePlan.subject
subject:Patient.identifier	token	Identificador do paciente para quem o plano de cuidado se destina	CarePlan.subject.where(resolve() is Patient)
category	token	Tipo do plano de cuidado (ex: care_line, protocol)	CarePlan.category
status	token	Status do plano de cuidado (draft | active | on-hold | revoked | completed | entered-in-error | unknown)	CarePlan.status
instantiates-canonical	reference	Referência canônica ao protocolo, guideline ou definição que este plano instancia (PlanDefinition)	CarePlan.instantiatesCanonical
date	date	Período de tempo coberto pelo plano de cuidado	CarePlan.period
_lastUpdated	date	Data da última atualização do registro	CarePlan.meta.lastUpdated

Exemplos de Requisições

Buscar por identificador customizado

Buscar CarePlan por identificador do sistema integrado

curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/CarePlan?identifier=https://www.acmesaude.com.br/integracao/careplan|12345 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Buscar por paciente

Buscar CarePlan por identificador do paciente

curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/CarePlan?subject:Patient.identifier=https://www.acmesaude.com.br/integracao/paciente|440623 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Buscar por categoria

Buscar CarePlan por categoria (ex: linha de cuidado)

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

Buscar por status

Buscar CarePlan por status (active, completed, etc.)

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

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": "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"

}

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