Consultar
Endpoint | GET /fhir/resources/Condition |
---|---|
Autenticação | 🔓 Chave de API |
Status | Implementado |
Modelagem da API - Request
- Headers
- Parameters
- Query
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 |
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 |
Você poderá utilizar todos os parâmetros de pesquisa disponíveis do recurso canônico.
https://hl7.org/fhir/R4/condition.html#searchExemplo de requisição CURL
curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Condition?identifier=https://sistemadocliente.com/condition|external-id-123 \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???'
nota
- O valor de
x-api-key
é fornecido durante a configuração do ambiente. - O valor de
https://sistemadocliente.com/condition
é fictício e deve ser substituído pelo definido no cliente. - Substitua o valor de
external-id-123
pelo identificador do recurso enviado na requisição que o criou.
Exemplos de filtros
Filtro por paciente
Filtro por CPF do paciente
curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Condition?subject.identifier=https://servicos.receita.fazenda.gov.br/servicos/cpf/|1234567800 \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???'
Observação
- O valor
1234567800
é um CPF fictício. Um valor real deve ser utilizado.
Filtro por atendimento
Filtro por identificador do atendimento
curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Condition?subject.identifier=https://sistemadocliente.com/appointment|external-id-123 \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???'
Observação
- O system
https://sistemadocliente.com/appointment
é um valor fictício. Deve-se utilizar um valor real, o mesmo utilizado na criação do atendimento. - O valor
external-id-123
é um valor de identifier fictício. Um valor real deve ser utilizado.
Modelagem da API - Response
- ✔ 200
- ✘ 400
- ✘ 500
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": "Condition",
- "encounter": {
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/...unit",
- "use": "usual",
- "value": "12345"
}, - "type": "Encounter"
}, - "identifier": [
- {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}
], - "note": {
- "text": "Sintomas de dor e cansaço."
}, - "subject": {
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/...unit",
- "use": "usual",
- "value": "12345"
}, - "type": "Patient"
}, - "verificationStatus": "provisional"
}, - "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"
}
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"
}
Erro inesperado.