Cadastrar/atualizar
Endpoint | POST /fhir/resources/CareTeam |
---|---|
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 |
Array of objects (CodeableConcept) Identifica o tipo de equipe. Isso é para apoiar a diferenciação entre várias equipes coexistentes, como equipe de plano de cuidados, episódio de equipe assistencial, equipe assistencial longitudinal. | |
object (Reference) O Encontro durante o qual este CareTeam foi criado ou para o qual o a criação deste registro está fortemente associada. | |
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 Um conjunto de códigos de identificação para este time de cuidado (IDs, códigos, ...). Ao menos um identificador externo é obrigatório e deve ser único, as regras de namespace para leitura e escrita são definidas durante a implantação. | |
Array of objects (Reference) A organização responsável pela equipe de cuidados. | |
object (Meta) Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro. | |
name | string (string) ^[ \r\n\t\S]+$ Um rótulo para uso humano destinado a distinguir equipes semelhantes. Por exemplo: A equipes de "Trauma vermelho" ou "Trauma Verde". |
Array of objects (Annotation) Comentários feitos sobre o CareTeam. | |
Array of objects (CareTeam_Participant) Identifica as pessoas que estão envolvidas na equipe de cuidado. | |
object (Period) Indica quando a equipe entrou / entrará em vigência e o fim da vigência dessa equipe. | |
Array of objects (CodeableConcept) Descreve por que a equipe de atendimento existe. | |
Array of objects (Reference) Condição(ões) abordada(s) por esta equipe de cuidados. | |
resourceType required | string Default: "CareTeam" Indica o tipo do recurso transacionado. |
status | any Enum: "proposed" "active" "suspended" "inactive" "entered-in-error" Indica o estado atual da equipe de atendimento. |
object (Reference) Identifica o paciente cujo cuidado pretendido é responsabilidade da equipe. | |
Array of objects (ContactPoint) Um detalhe de contato central para a equipe de atendimento (que se aplica a todos membros). |
{- "category": [
- {
- "coding": [
- {
- "code": "string",
- "display": "string",
- "system": "string"
}
], - "text": "string"
}
], - "encounter": {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}, - "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
- "identifier": [
- {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}
], - "managingOrganization": [
- {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}
], - "meta": {
- "lastUpdated": "2022-05-25T18:42:06.551129+00:00",
- "versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"
}, - "name": "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"
}
], - "participant": [
- {
- "id": "string",
- "member": {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}, - "onBehalfOf": {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}, - "period": {
- "end": "2022-05-23T19:00:00+00:00",
- "start": "2022-05-23T19:00:00+00:00"
}, - "role": [
- {
- "coding": [
- {
- "code": "string",
- "display": "string",
- "system": "string"
}
], - "text": "string"
}
]
}
], - "period": {
- "end": "2022-05-23T19:00:00+00:00",
- "start": "2022-05-23T19:00:00+00:00"
}, - "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"
}
], - "resourceType": "CareTeam",
- "status": "proposed",
- "subject": {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}, - "telecom": [
- {
- "system": "phone",
- "use": "mobile",
- "value": "+551155556473"
}
]
}
curl --request POST \
--url https://landing-zone-api.nilo.services/fhir/resources/CareTeam \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '
{
"resourceType": "CareTeam",
"identifier": [
{
"use": "usual",
"system": "https://sistema.cliente.com.br/TimeDeCuidado/",
"value": "11"
}
],
"status": "active",
"period": {
"start": "2022-08-29",
"end": "2023-12-29"
},
"name": "Time de cuidado 11",
"subject": {
"identifier": {
"use": "official",
"system": "https://servicos.receita.fazenda.gov.br/servicos/cpf/",
"value": "43927194050"
}
},
"participant": [
{
"role": [
{
"coding": [
{
"system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
"code": "2251-30",
"display": "Médico de Família e Comunidade"
}
]
}
],
"member": {
"identifier": {
"use": "usual",
"system": "https://sistema.cliente.com.br/Practitioner/",
"value": "9999"
}
}
}
],
"managingOrganization": [
{
"type": "Organization",
"identifier": {
"use": "usual",
"system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/sorting-hat-api--care-unit",
"value": "9999"
}
}
]
}
'
Modelagem da API - Response
- ✔ 200
- ✘ 400
- ✘ 500
Operação bem sucedida.
Array of objects (CodeableConcept) Identifica o tipo de equipe. Isso é para apoiar a diferenciação entre várias equipes coexistentes, como equipe de plano de cuidados, episódio de equipe assistencial, equipe assistencial longitudinal. | |
object (Reference) O Encontro durante o qual este CareTeam foi criado ou para o qual o a criação deste registro está fortemente associada. | |
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 Um conjunto de códigos de identificação para este time de cuidado (IDs, códigos, ...). Ao menos um identificador externo é obrigatório e deve ser único, as regras de namespace para leitura e escrita são definidas durante a implantação. | |
Array of objects (Reference) A organização responsável pela equipe de cuidados. | |
object (Meta) Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro. | |
name | string (string) ^[ \r\n\t\S]+$ Um rótulo para uso humano destinado a distinguir equipes semelhantes. Por exemplo: A equipes de "Trauma vermelho" ou "Trauma Verde". |
Array of objects (Annotation) Comentários feitos sobre o CareTeam. | |
Array of objects (CareTeam_Participant) Identifica as pessoas que estão envolvidas na equipe de cuidado. | |
object (Period) Indica quando a equipe entrou / entrará em vigência e o fim da vigência dessa equipe. | |
Array of objects (CodeableConcept) Descreve por que a equipe de atendimento existe. | |
Array of objects (Reference) Condição(ões) abordada(s) por esta equipe de cuidados. | |
resourceType required | string Default: "CareTeam" Indica o tipo do recurso transacionado. |
status | any Enum: "proposed" "active" "suspended" "inactive" "entered-in-error" Indica o estado atual da equipe de atendimento. |
object (Reference) Identifica o paciente cujo cuidado pretendido é responsabilidade da equipe. | |
Array of objects (ContactPoint) Um detalhe de contato central para a equipe de atendimento (que se aplica a todos membros). |
{- "category": [
- {
- "coding": [
- {
- "code": "string",
- "display": "string",
- "system": "string"
}
], - "text": "string"
}
], - "encounter": {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}, - "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
- "identifier": [
- {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}
], - "managingOrganization": [
- {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}
], - "meta": {
- "lastUpdated": "2022-05-25T18:42:06.551129+00:00",
- "versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"
}, - "name": "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"
}
], - "participant": [
- {
- "id": "string",
- "member": {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}, - "onBehalfOf": {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}, - "period": {
- "end": "2022-05-23T19:00:00+00:00",
- "start": "2022-05-23T19:00:00+00:00"
}, - "role": [
- {
- "coding": [
- {
- "code": "string",
- "display": "string",
- "system": "string"
}
], - "text": "string"
}
]
}
], - "period": {
- "end": "2022-05-23T19:00:00+00:00",
- "start": "2022-05-23T19:00:00+00:00"
}, - "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"
}
], - "resourceType": "CareTeam",
- "status": "proposed",
- "subject": {
- "display": "string",
- "identifier": {
- "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
- "use": "usual",
- "value": "12345"
}, - "reference": "string",
- "type": "string"
}, - "telecom": [
- {
- "system": "phone",
- "use": "mobile",
- "value": "+551155556473"
}
]
}
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.