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"
}
]
}

Exemplos de uso

Criação de time de cuidado

Criação de um time de cuidado com os profissionais e suas respectivas funções dentro desse time.

dica

Os papéis dos profissionais nas equipes são especificados de acordo com a CBO e a listagem completa e os respectivos códigos podem ser encontrados neste endereço do governo: Classificação Brasileira de Ocupações - CBO

Cadastro de time de cuidado com os profissionais e seus papéis

curl --request POST \
  --url https://landing-zone-api.nilo.services/fhir/resources/CareTeam \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <inserir API Key aqui>' \
  --data '
  {
    "resourceType": "CareTeam",
    "identifier": [
      {
        "use": "usual",
        "system": "https://www.acmesaude.com.br/integracao/time-de-cuidado/",
        "value": "123"
      }
    ],
    "status": "active",
    "name": "Time de cuidado 1",
    "participant": [
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
                "code": "223565",
                "display": "Enfermeiro da Estratégia de Saúde da Família"
              }
            ]
          }
        ],
        "member": {
          "identifier": {
            "use": "usual",
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "1111"
          }
        }
      },
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
                "code": "225130",
                "display": "Médico de Família e Comunidade"
              }
            ]
          }
        ],
        "member": {
          "identifier": {
            "use": "usual",
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "2222"
          }
        }
      }
    ]
}
'
  

Atualização de time de cuidado

Atualizando o time de cuidado criado no exemplo anterior para efetuar a troca do profissional que faz o papel de enfermeiro.

cuidado

É importante notar que mesmo que os outros profissionais da equipe não tenham mudado é preciso enviar a formação completa da equipe. Qualquer profissional não enviado o sistema entenderá que é para fazer a remoção do mesmo da equipe.

Atualização de time de cuidado efetuando a troca de profissional

curl --request POST \
  --url https://landing-zone-api.nilo.services/fhir/resources/CareTeam \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <inserir API Key aqui>' \
  --data '
  {
    "resourceType": "CareTeam",
    "identifier": [
      {
        "system": "https://www.acmesaude.com.br/integracao/time-de-cuidado/",
        "value": "123"
      }
    ],
    "participant": [
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
                "code": "223565",
                "display": "Enfermeiro da Estratégia de Saúde da Família"
              }
            ]
          }
        ],
        "member": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "3333"
          },
          "type": "Practitioner"
        }
      },
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
                "code": "225130",
                "display": "Médico de Família e Comunidade"
              }
            ]
          }
        ],
        "member": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "2222"
          },
          "type": "Practitioner"
        }
      }
    ]
}
'
  

Atualizando o time de cuidado para adicionar um novo profissional com um novo papel ao time.

Atualizando time de cuidado adicionando um novo profissional e seu papel

curl --request POST \
  --url https://landing-zone-api.nilo.services/fhir/resources/CareTeam \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <inserir API Key aqui>' \
  --data '
  {
    "resourceType": "CareTeam",
    "identifier": [
      {
        "system": "https://www.acmesaude.com.br/integracao/time-de-cuidado/",
        "value": "123"
      }
    ],
    "participant": [
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
                "code": "223565",
                "display": "Enfermeiro da Estratégia de Saúde da Família"
              }
            ]
          }
        ],
        "member": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "3333"
          },
          "type": "Practitioner"
        }
      },
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
                "code": "225130",
                "display": "Médico de Família e Comunidade"
              }
            ]
          }
        ],
        "member": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "2222"
          },
          "type": "Practitioner"
        }
      },
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
                "code": "223545",
                "display": "Enfermeiro Obstetricio"
              }
            ]
          }
        ],
        "member": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "4444"
          },
          "type": "Practitioner"
        }
      }
    ]
}
'
  

Atualizando o time de cuidado para remover profissionais. Nesse caso, o time criado no primeiro exemplo teve o médico removido.

Atualizando time de cuidado removendo profissional

curl --request POST \
  --url https://landing-zone-api.nilo.services/fhir/resources/CareTeam \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <inserir API Key aqui>' \
  --data '
  {
    "resourceType": "CareTeam",
    "identifier": [
      {
        "system": "https://www.acmesaude.com.br/integracao/time-de-cuidado/",
        "value": "123"
      }
    ],
    "participant": [
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO",
                "code": "223565",
                "display": "Enfermeiro da Estratégia de Saúde da Família"
              }
            ]
          }
        ],
        "member": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "3333"
          },
          "type": "Practitioner"
        }
      }
    ]
}
'
  

Atribuição de time de cuidado para paciente

Atribuindo uma equipe de cuidado já existente para um paciente.

cuidado

É importante que o time de cuidado a ser atribuído ao paciente já tenha sido criado na plataforma, caso contrário um erro será retornado e a atribuição não será feita, deixando o paciente sem um time de cuidado para acompanhá-lo

info

O identificador do time de cuidado do paciente deve ser diferente do identificador do time de cuidado indicado dentro do atributo participant. Esse identificador representa a relação entre o paciente (subject) e o time de cuidado (participant do tipo CareTeam)

Atribuição de time de cuidado para um paciente

curl --request POST \
  --url https://landing-zone-api.nilo.services/fhir/resources/CareTeam \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <inserir API Key aqui>' \
  --data '
  {
    "resourceType": "CareTeam",
    "identifier": [
      {
        "system": "https://www.acmesaude.com.br/integracao/time-de-cuidado/",
        "value": "321"
      }
    ],
    "participant": [
      {
        "member": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/time-de-cuidado/",
            "value": "123"
          },
          "type": "CareTeam"
        }
      }
    ],
    "subject": {
      "identifier": {
        "system": "https://www.acmesaude.com.br/integracao/paciente/",
        "value": "507823709"
      },
      "type": "Patient"
    }
}
'
  

Finalizando o vínculo de uma equipe de cuidado com um paciente.

cuidado

Após essa ação, o paciente ficará sem um time de cuidado para acompanhá-lo. Será preciso fazer uma nova atribuição, de outra equipe, para que o paciente não fique sem acompanhamento em sua jornada de saúde.

Removendo o vínculo entre time de cuidado e paciente

curl --request POST \
  --url https://landing-zone-api.nilo.services/fhir/resources/CareTeam \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <inserir API Key aqui>' \
  --data '
  {
    "resourceType": "CareTeam",
    "status": "inactive",
    "identifier": [
      {
        "system": "https://www.acmesaude.com.br/integracao/time-de-cuidado/",
        "value": "321"
      }
    ],
    "participant": [
      {
        "member": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/time-de-cuidado/",
            "value": "123"
          },
          "type": "CareTeam"
        }
      }
    ],
    "subject": {
      "identifier": {
        "system": "https://www.acmesaude.com.br/integracao/paciente/",
        "value": "507823709"
      },
      "type": "Patient"
    }
}
'
  

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"
}

Modelagem da API - Request​

Exemplos de uso​

Criação de time de cuidado​

Criação de um time de cuidado com os profissionais e suas respectivas funções dentro desse time.​

Atualização de time de cuidado​

Atualizando o time de cuidado criado no exemplo anterior para efetuar a troca do profissional que faz o papel de enfermeiro.​

Atualizando o time de cuidado para adicionar um novo profissional com um novo papel ao time.​

Atualizando o time de cuidado para remover profissionais. Nesse caso, o time criado no primeiro exemplo teve o médico removido.​

Atribuição de time de cuidado para paciente​

Atribuindo uma equipe de cuidado já existente para um paciente.​

Finalizando o vínculo de uma equipe de cuidado com um paciente.​

Modelagem da API - Response​

Modelagem da API - Request

Exemplos de uso

Criação de time de cuidado

Criação de um time de cuidado com os profissionais e suas respectivas funções dentro desse time.

Atualização de time de cuidado

Atualizando o time de cuidado criado no exemplo anterior para efetuar a troca do profissional que faz o papel de enfermeiro.

Atualizando o time de cuidado para adicionar um novo profissional com um novo papel ao time.

Atualizando o time de cuidado para remover profissionais. Nesse caso, o time criado no primeiro exemplo teve o médico removido.

Atribuição de time de cuidado para paciente

Atribuindo uma equipe de cuidado já existente para um paciente.

Finalizando o vínculo de uma equipe de cuidado com um paciente.

Modelagem da API - Response