Consultar

Endpoint	GET /fhir/resources/Procedure
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

Exemplo de requisição CURL

curl --request GET \
  --url https://landing-zone-api.nilo.services/fhir/resources/Procedure?identifier=https://sistemadocliente.com/procedure|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/procedure é 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.

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": "Procedure"
},
"resource": {"id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
"meta": {"lastUpdated": "2022-05-25T18:42:06.551129+00:00",
"versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"
},
"resourceType": "Procedure",
"asserter": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
},
"basedOn": [{"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
}
],
"bodySite": [{"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
}
],
"category": {"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
},
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
},
"complication": [{"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
}
],
"complicationDetail": [{"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
}
],
"encounter": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
},
"focalDevice": [{"action": {"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
},
"id": "string",
"manipulated": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
}
}
],
"followUp": [{"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
}
],
"identifier": [{"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
}
],
"location": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
},
"note": [{"authorReference": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
},
"text": "string",
"time": "2022-05-23T19:00:00+00:00"
}
],
"outcome": {"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
},
"partOf": [{"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
}
],
"performedDateTime": "string",
"performedPeriod": {"end": "2022-05-23T19:00:00+00:00",
"start": "2022-05-23T19:00:00+00:00"
},
"performer": [{"actor": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
},
"function": {"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
},
"id": "string",
"onBehalfOf": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
}
}
],
"reasonCode": [{"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
}
],
"reasonReference": [{"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
}
],
"recorder": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
},
"report": [{"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
}
],
"status": "preparation",
"statusReason": {"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
},
"subject": {"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
},
"usedCode": [{"coding": [{"code": "string",
"display": "string",
"system": "string"
}
],
"text": "string"
}
],
"usedReference": [{"display": "string",
"identifier": {"system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
"use": "usual",
"value": "12345"
},
"reference": "string",
"type": "string"
}
]
},
"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"
}

Modelagem da API - Request​

Modelagem da API - Response​

Modelagem da API - Request

Modelagem da API - Response