Consultar

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

Exemplos de uso

Listar todos os pacientes:

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

Listar um paciente específico usando o identifier

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

Consulte aqui mais exemplos de uso dos identificadores para um entendimento mais completo sobre o tema.

Parâmetros de busca suportados

Nome	Tipo	Descrição	Expressão
active	boolean	Se o registro do paciente está ativo	Patient.active
address	string	Uma busca definida pelo servidor que pode corresponder a qualquer um dos campos de string no Endereço, incluindo linha, cidade, distrito, estado, país, código postal e/ou texto	Patient.address
address-city	string	Uma cidade especificada no endereço	Patient.address.city
address-country	string	Um país especificado no endereço	Patient.address.country
address-postalcode	string	Um código postal especificado no endereço	Patient.address.postalCode
address-state	string	Um estado especificado no endereço	Patient.address.state
address-use	token	Um código de uso especificado no endereço	Patient.address.use
birthdate	date	A data de nascimento do paciente	Patient.birthDate
email	token	Um valor em um contato de email	Patient.telecom.where(system='email')
family	string	Uma parte do sobrenome do paciente	Patient.name.family
gender	token	Gênero do paciente	Patient.gender
given	string	Uma parte do primeiro nome do paciente	Patient.name.given
identifier	token	Um identificador do paciente	Patient.identifier
name	string	Uma busca definida pelo servidor que pode corresponder a qualquer um dos campos de string no Nome Humano, incluindo sobrenome, nome, prefixo, sufixo e/ou texto	Patient.name
organization	reference	Unidade de cuidado do paciente	Patient.managingOrganization
phone	token	Um valor em um contato telefônico	Patient.telecom.where(system='phone')
phonetic	string	Uma parte do sobrenome ou nome usando algum tipo de algoritmo de correspondência fonética	Patient.name
telecom	token	O valor em qualquer tipo de detalhe de telecomunicação do paciente	Patient.telecom

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": "Patient",
      • "active": true,
      • "address": [

        • {

          • "city": "São Paulo",
          • "country": "Brazil",
          • "line": [

            • "534 Erewhon St"

            ],
          • "postalCode": "39993-333",
          • "state": "SP",
          • "text": "534 Erewhon St PeasantVille, Rainbow, Vic 3999",
          • "type": "both",
          • "use": "home"

          }

        ],
      • "birthDate": "1974-12-25",
      • "contained": [

        • {

          • "resourceType": "Group",
          • "identifier": [

            • {

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

              }

            ],
          • "type": "person",
          • "actual": true,
          • "name": "Pacientes com diabetes"

          }

        ],
      • "communication": {

        • "language": {

          • "coding": [

            • {

              • "code": "pt-BR",
              • "display": "Portuguese (Brazil)",
              • "system": "urn:ietf:bcp:47"

              }

            ]

          },
        • "preferred": true

        },
      • "deceasedBoolean": true,
      • "deceasedDateTime": "2015-02-07T13:28:17",
      • "extension": [

        • {

          • "url": "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor",
          • "valueBoolean": false

          }

        ],
      • "gender": "male",
      • "identifier": [

        • {

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

          }

        ],
      • "managingOrganization": {

        • "identifier": {

          • "system": "{host}/fhir/resources/NamingSystem/sorting-hat-api--care-unit",
          • "use": "usual",
          • "value": "4"

          },
        • "type": "Organization"

        },
      • "maritalStatus": {

        • "coding": [

          • {

            • "code": "UNK",
            • "display": "unknown",
            • "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor"

            }

          ],
        • "text": "unknown"

        },
      • "name": [

        • {

          • "family": "Donald",
          • "given": [

            • "Duck"

            ],
          • "text": "Duck Donald",
          • "use": "official"

          }

        ],
      • "telecom": [

        • {

          • "system": "phone",
          • "use": "mobile",
          • "value": "+551155556473"

          }

        ]

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