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

Exemplo de requisição CURL listando 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: ???'

Exemplo de requisição CURL listando um paciente específico:

curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Patient?identifier=https://servicos.receita.fazenda.gov.br/servicos/cpf/|11122233344' \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???'

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

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",
      • "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-cohort",
          • "valueIdentifier": {

            • "system": "{host}/fhir/resources/NamingSystem/care-api--cohort",
            • "use": "usual",
            • "value": "3579"

            }

          }

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