Cadastrar/Atualizar
Endpoint | POST /fhir/resources/Encounter |
---|---|
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 |
required | object Classificação do encontro. |
required | Array of objects (Identifier) Identificador(es) pelo qual este recurso é distinguido. |
object Duração do atendimento. | |
required | Array of objects (Encounter_Participant) A lista de pessoas responsáveis pela prestação do serviço. |
required | object A hora de início e fim do encontro. |
resourceType required | string Default: "Encounter" Indica o tipo do recurso transacionado. |
status required | string Enum: "planned" "arrived" "triaged" "in-progress" "onleave" "finished" "cancelled" "entered-in-error" "unknown" Situação atual desse encontro. |
required | object O paciente presente no encontro. |
{- "class": {
- "code": "VR",
- "display": "virtual",
}, - "identifier": [
- {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}
], - "length": {
- "id": "string",
- "value": 0
}, - "participant": [
- {
- "individual": {
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/...unit",
- "use": "usual",
- "value": "12345"
}, - "type": "Practitioner"
}, - "type": [
- {
- "coding": [
- {
- "code": "ATND",
- "display": "attender",
}
], - "text": "attender"
}
]
}
], - "period": {
- "end": "2022-05-23T19:00:00+00:00",
- "start": "2022-05-23T19:00:00+00:00"
}, - "resourceType": "Encounter",
- "status": "finished",
- "subject": {
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/...unit",
- "use": "usual",
- "value": "12345"
}, - "type": "Patient"
}
}
curl --request POST \
--url https://landing-zone-api.nilo.services/fhir/resources/Encounter \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '
{
"class": {
"code": "IMP",
"display": "inpatient encounter",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode"
},
"diagnosis": [
{
"condition": {
"identifier": {
"system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--condition",
"value": "1683"
},
"type": "Condition"
}
}
],
"identifier": [
{
"system": "https://sistemadocliente.com/hospitalizacao",
"use": "usual",
"value": "1126"
}
],
"location": [
{
"location": {
"identifier": {
"system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/almanac-api--health-facility",
"value": "1729"
},
"type": "Location"
}
}
],
"participant": [
{
"individual": {
"identifier": {
"system": "https://sistemadocliente.com/profissional",
"value": "10162"
},
"type": "Practitioner"
}
}
],
"period": {
"end": "2015-01-17T16:30:00+00:00",
"start": "2015-01-17T16:00:00+00:00"
},
"resourceType": "Encounter",
"status": "finished",
"subject": {
"identifier": {
"system": "https://sistemadocliente.com/pacientes",
"use": "usual",
"value": "440623"
},
"type": "Patient"
}
}
'
Modelagem da API - Response
- ✔ 200
- ✘ 400
- ✘ 500
required | object Classificação do encontro. |
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. |
required | Array of objects (Identifier) Identificador(es) pelo qual este recurso é distinguido. |
Array of objects (Encounter_Location) Lista de locais onde o paciente esteve durante este encontro. | |
object (Meta) Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro. | |
required | Array of objects (Encounter_Participant) A lista de pessoas responsáveis pela prestação do serviço. |
object A hora de início e fim do encontro. | |
resourceType required | string Default: "Encounter" Indica o tipo do recurso transacionado. |
object A organização (instalação) responsável por este encontro | |
status | string Enum: "planned" "arrived" "triaged" "in-progress" "onleave" "finished" "cancelled" "entered-in-error" "unknown" Situação atual desse encontro. |
required | object O paciente presente no encontro. |
{- "class": {
- "code": "IMP",
- "display": "inpatient encounter",
}, - "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
- "identifier": [
- {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}
], - "location": [
- {
- "location": {
- "display": "Virtual Appointment"
}, - "period": {
- "end": "2022-05-23T19:00:00+00:00",
- "start": "2022-05-23T19:00:00+00:00"
}, - "status": "completed"
}
], - "meta": {
- "lastUpdated": "2022-05-25T18:42:06.551129+00:00",
- "versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"
}, - "participant": [
- {
- "individual": {
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/...unit",
- "use": "usual",
- "value": "12345"
}, - "type": "Practitioner"
}, - "type": [
- {
- "coding": [
- {
- "code": "ATND",
- "display": "attender",
}
], - "text": "attender"
}
]
}
], - "period": {
- "end": "2022-05-23T19:00:00+00:00",
- "start": "2022-05-23T19:00:00+00:00"
}, - "resourceType": "Encounter",
- "serviceProvider": {
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/sorting-hat-api--care-unit",
- "use": "usual",
- "value": "4"
}, - "type": "Organization"
}, - "status": "finished",
- "subject": {
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/...unit",
- "use": "usual",
- "value": "12345"
}, - "type": "Patient"
}
}
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"
}