Cadastrar/Atualizar
Endpoint | POST /fhir/resources/Procedure |
---|---|
Autenticação | 🔓 Chave de API |
Status | Implementado |
Modelagem da API - Request
- Headers
- Body
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 |
object (Reference) Uma referência de um recurso para outro. | |
Array of objects (Reference) | |
Array of objects (CodeableConcept) Lateralidade do procedimento. | |
object (CodeableConcept) Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde. | |
required | object (CodeableConcept) O procedimento que foi realizado. |
Array of objects (CodeableConcept) | |
Array of objects (Reference) | |
object (Reference) Uma referência de um recurso para outro. | |
Array of objects (Procedure_FocalDevice) | |
Array of objects (CodeableConcept) | |
id | string (id) ^[A-Za-z0-9\-\.]{{1,64}}$ Qualquer combinação de letras, números, "-" e ".", com um limite de 64 caracteres. (Pode ser um número inteiro, um OID não prefixado, UUID ou qualquer outro padrão de identificador que atenda a essas restrições.) Os IDs não diferenciam maiúsculas de minúsculas. |
Array of objects (Identifier) non-empty Identificador(es) pelo qual este recurso é distinguido.. | |
required | object (Reference) O local onde o procedimento realmente aconteceu. |
Array of objects (Annotation) Quaisquer outras notas e comentários sobre o procedimento. | |
object (CodeableConcept) Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde. | |
Array of objects (Reference) | |
performedDateTime | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... |
required | object (Period) Data de início e fim em que o procedimento foi realizado. |
required | Array of objects (Procedure_Performer) Profissional que realizou o procedimento. |
Array of objects (CodeableConcept) | |
Array of objects (Reference) | |
object (Reference) Uma referência de um recurso para outro. | |
Array of objects (Reference) | |
resourceType | string Default: "Procedure" |
status required | any Enum: "preparation" "in-progress" "not-done" "on-hold" "stopped" "completed" "entered-in-error" "unknown" |
object (CodeableConcept) Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde. | |
required | object (Reference) O paciente que foi o alvo do procedimento. |
Array of objects (CodeableConcept) | |
Array of objects (Reference) |
{- "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"
}
], - "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
- "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"
}
], - "resourceType": "Procedure",
- "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"
}
]
}
curl --request POST \
--url https://landing-zone-api.nilo.services/fhir/resources/Procedure \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '
{
"category": {
"coding": [
{
"code": "387713003",
"display": "Surgical procedure",
"system": "http://snomed.info/sct"
}
]
},
"code": {
"coding": [
{
"code": "20103182",
"display": "Desvios posturais da coluna vertebral",
"system": "https://fhir.ans.gov.br/CodeSystem/tuss-63"
}
]
},
"identifier": [
{
"use": "usual",
"system": "https://sistemadocliente.com/procedimentos",
"value": "55162"
}
],
"location": {
"identifier": {
"system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/almanac-api--health-facility",
"use": "usual",
"value": "1"
},
"type": "Location"
},
"note": [
{
"text": "isso é um anotação"
}
],
"performedPeriod": {
"end": "2024-12-01T10:00:00+00:00",
"start": "2024-11-30T17:00:00+00:00"
},
"performer": [
{
"actor": {
"identifier": {
"system": "https://sistemadocliente.com/profissionais",
"use": "usual",
"value": "10351"
},
"type": "Practitioner"
}
}
],
"resourceType": "Procedure",
"status": "completed",
"subject": {
"identifier": {
"system": "https://sistemadocliente.com/pacientes",
"use": "usual",
"value": "442890"
},
"type": "Patient"
}
}
'
Modelagem da API - Response
- ✔ 200
- ✘ 400
- ✘ 500
object (Reference) Uma referência de um recurso para outro. | |
Array of objects (Reference) | |
Array of objects (CodeableConcept) Lateralidade do procedimento. | |
object (CodeableConcept) Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde. | |
required | object (CodeableConcept) O procedimento que foi realizado. |
Array of objects (CodeableConcept) | |
Array of objects (Reference) | |
object (Reference) Uma referência de um recurso para outro. | |
Array of objects (Procedure_FocalDevice) | |
Array of objects (CodeableConcept) | |
id | string (id) ^[A-Za-z0-9\-\.]{{1,64}}$ Qualquer combinação de letras, números, "-" e ".", com um limite de 64 caracteres. (Pode ser um número inteiro, um OID não prefixado, UUID ou qualquer outro padrão de identificador que atenda a essas restrições.) Os IDs não diferenciam maiúsculas de minúsculas. |
Array of objects (Identifier) non-empty Identificador(es) pelo qual este recurso é distinguido.. | |
required | object (Reference) O local onde o procedimento realmente aconteceu. |
Array of objects (Annotation) Quaisquer outras notas e comentários sobre o procedimento. | |
object (CodeableConcept) Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde. | |
Array of objects (Reference) | |
performedDateTime | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... |
required | object (Period) Data de início e fim em que o procedimento foi realizado. |
required | Array of objects (Procedure_Performer) Profissional que realizou o procedimento. |
Array of objects (CodeableConcept) | |
Array of objects (Reference) | |
object (Reference) Uma referência de um recurso para outro. | |
Array of objects (Reference) | |
resourceType | string Default: "Procedure" |
status required | any Enum: "preparation" "in-progress" "not-done" "on-hold" "stopped" "completed" "entered-in-error" "unknown" |
object (CodeableConcept) Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde. | |
required | object (Reference) O paciente que foi o alvo do procedimento. |
Array of objects (CodeableConcept) | |
Array of objects (Reference) |
{- "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"
}
], - "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
- "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"
}
], - "resourceType": "Procedure",
- "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"
}
]
}
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"
}