Partilhar via


Veterans Affairs Providers (Editora Independente) (Pré-visualização)

A API do Diretório de Provedores facilita o desenvolvimento de aplicativos que podem recuperar listas de provedores de VA, oferecendo detalhes sobre locais de provedores, especialidades, horário de atendimento e status de aceitação do paciente. Ele aproveita os padrões FHIR para garantir a conformidade com os requisitos do CMS para pontos de extremidade de API voltados para o público.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Richard Wilson
URL https://www.richardawilson.com
Email richard.a.wilson@microsoft.com
Metadados do conector
Editora Richard Wilson
Guia de implementação do Plano DaVinci PDEX Net https://docs.microsoft.com/connectors/veteransaffairsprovi
Sítio Web https://developer.va.gov
Política de privacidade https://www.va.gov/privacy/
Categorias Recursos Humanos

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API VA securestring A chave de API VA para esta api Verdade
Meio Ambiente cadeia (de caracteres) O ambiente de API VA a ser usado (Production ou Sandbox) Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Listar funções de profissional

Recupera uma lista de funções de profissional com base em critérios especificados, incluindo identificadores e nomes, refletindo suas funções e responsabilidades.

Listar locais

Recupera uma lista de locais com base em critérios especificados, incluindo locais de provedores, especialidades e horário de expediente.

Listar organizações

Recupera uma lista de organizações com base em critérios especificados, incluindo seus locais, nomes e outras informações de identificação.

Listar profissionais

Recupera uma lista de profissionais com base em critérios especificados, incluindo identificadores, nomes e datas da última atualização.

Obter função de profissional por ID

Recupera informações detalhadas sobre uma função específica do profissional por meio de sua ID exclusiva, incluindo atribuições de função, qualificações e identificadores.

Obter localização por ID

Recupera informações detalhadas sobre um local específico por meio de sua ID, incluindo locais de provedores, especialidades e horário de expediente.

Obter organização por Id

Recupera informações detalhadas sobre uma organização específica por sua ID, incluindo nome, local e outros detalhes relevantes.

Obter profissional por ID

Recupera informações detalhadas sobre um profissional específico por meio de sua ID exclusiva, incluindo identificadores, nomes e qualificações.

Listar funções de profissional

Recupera uma lista de funções de profissional com base em critérios especificados, incluindo identificadores e nomes, refletindo suas funções e responsabilidades.

Parâmetros

Name Chave Necessário Tipo Description
Id
_id string

A ID lógica do recurso. Uma vez atribuído, este valor nunca muda.

Identificador do Profissional
practitioner.identifier string

Um identificador único para um profissional dentro de um determinado sistema.

Nome do Profissional
practitioner.name string

O nome próprio ou familiar do médico.

Última atualização
_lastUpdated string

A data em que o registro da função de praticante foi atualizado pela última vez.

Página
page integer

O número da página que está sendo solicitado.

Contar
_count integer

O número de recursos retornados em uma única página, até um máximo de 100.

Devoluções

Um pacote de recursos de função de praticante, normalmente usado para fornecer um conjunto completo de resultados de pesquisa ou um subconjunto de recursos em uma lista paginada.

Listar locais

Recupera uma lista de locais com base em critérios especificados, incluindo locais de provedores, especialidades e horário de expediente.

Parâmetros

Name Chave Necessário Tipo Description
Id
_id string

A ID lógica do recurso. Uma vez atribuído, este valor nunca muda.

Identificador
identifier string

O identificador lógico do recurso. Uma vez atribuído, este valor nunca muda.

Address
address string

Especifica a localização física do registro usando convenções postais.

Endereço Cidade
address-city string

Especifica a cidade onde o local reside.

Estado do endereço
address-state string

Especifica o estado onde o local reside.

Endereço Postalcode
address-postalcode string

Especifica o código postal da região onde o local reside.

Nome
name string

Indica o nome do local como referenciado por humanos.

Última atualização
_lastUpdated string

A data em que o registro de local foi atualizado pela última vez.

Página
page integer

O número da página do resultado da pesquisa.

Contar
_count integer

O número de recursos retornados em uma única página, até um máximo de 100.

Devoluções

Uma coleção de recursos de 'Localização' retornados como resultado de uma operação de pesquisa/consulta.

Listar organizações

Recupera uma lista de organizações com base em critérios especificados, incluindo seus locais, nomes e outras informações de identificação.

Parâmetros

Name Chave Necessário Tipo Description
Id
_id string

A ID lógica do recurso. Uma vez atribuído, este valor nunca muda.

Identificador
identifier string

O identificador lógico do recurso. Uma vez atribuído, este valor nunca muda.

Address
address string

Especifica a localização física da organização usando convenções postais.

City
address-city string

Especifica a cidade onde a organização reside.

Estado
address-state string

Especifica o estado onde a organização reside.

Código Postal
address-postalcode string

Especifica o código postal da região onde a organização reside.

Nome
name string

Indica o nome da organização à medida que é referenciada por humanos.

Última atualização
_lastUpdated string

A data em que o registro da organização foi atualizado pela última vez.

Página
page integer

O número da página do resultado da pesquisa.

Contar
_count integer

O número de recursos retornados em uma única página, até um máximo de 100.

Devoluções

Listar profissionais

Recupera uma lista de profissionais com base em critérios especificados, incluindo identificadores, nomes e datas da última atualização.

Parâmetros

Name Chave Necessário Tipo Description
Id
_id string

A ID lógica do recurso. Uma vez atribuído, este valor nunca muda.

Identificador
identifier string

Um identificador único para um profissional dentro de um determinado sistema.

Nome de família
family string

O nome de família do praticante.

Nome Próprio
given string

O nome próprio do praticante.

Nome
name string

O nome próprio ou familiar do médico.

Última atualização
_lastUpdated string

A data em que o registo do praticante foi atualizado pela última vez.

Página
page integer

O número da página do resultado da pesquisa.

Contar
_count integer

O número de recursos retornados em uma única página, até um máximo de 100.

Devoluções

Um pacote de recursos contendo informações sobre um ou mais profissionais.

Obter função de profissional por ID

Recupera informações detalhadas sobre uma função específica do profissional por meio de sua ID exclusiva, incluindo atribuições de função, qualificações e identificadores.

Parâmetros

Name Chave Necessário Tipo Description
Id
id True string

A ID lógica do recurso, que permanece inalterada uma vez atribuído.

Devoluções

Define o papel de um profissional dentro de uma organização ou prática de saúde.

Obter localização por ID

Recupera informações detalhadas sobre um local específico por meio de sua ID, incluindo locais de provedores, especialidades e horário de expediente.

Parâmetros

Name Chave Necessário Tipo Description
Id
id True string

A ID lógica do recurso. Uma vez atribuído, este valor nunca muda.

Devoluções

Informações sobre locais físicos onde os serviços são prestados e os recursos estão localizados.

Body
Location

Obter organização por Id

Recupera informações detalhadas sobre uma organização específica por sua ID, incluindo nome, local e outros detalhes relevantes.

Parâmetros

Name Chave Necessário Tipo Description
Id
id True string

A ID lógica do recurso. Uma vez atribuído, este valor nunca muda.

Devoluções

Representa um grupo de pessoas definido por um propósito comum, como um hospital, departamento, equipe ou companhia de seguros.

Obter profissional por ID

Recupera informações detalhadas sobre um profissional específico por meio de sua ID exclusiva, incluindo identificadores, nomes e qualificações.

Parâmetros

Name Chave Necessário Tipo Description
Id
id True string

A ID lógica do recurso. Uma vez atribuído, este valor nunca muda.

Devoluções

Pessoa direta ou indiretamente envolvida na prestação de cuidados de saúde.

Definições

Address

Define um local físico por seus componentes de endereço.

Name Caminho Tipo Description
City
city string

O nome da cidade do endereço.

Country
country string

O nome do país do endereço.

Distrito
district string

O distrito ou sub-região do endereço que ajuda na localização adicional.

Extension
extension array of object

A extensão contém informações adicionais sobre o endereço.

items
extension object
Id
id string

Um identificador exclusivo para o endereço.

Linha
line array of string

A linha de endereço real que descreve o local físico.

period
period Period

Um período de tempo descrito por limites de data/hora de início e fim.

Código Postal
postalCode string

O código postal do endereço.

Estado
state string

O estado ou província do endereço.

Texto
text string

Uma representação textual do endereço.

Tipo
type string

O tipo de endereço (postal, físico ou ambos).

Utilização
use string

O uso do endereço (casa, trabalho, temporário, antigo, faturamento).

Anexo

Um tipo complexo que contém conteúdo em formato digital.

Name Caminho Tipo Description
Tipo de conteúdo
contentType string

O tipo de mímica do conteúdo.

Creation
creation string

A data e a hora em que o conteúdo foi criado.

Data
data string

Os dados reais do conteúdo, representados como uma cadeia de caracteres base64.

Extension
extension array of object

Uma extensão para dados estruturados adicionais.

items
extension object
Hash
hash string

Um hash dos dados (por exemplo, SHA-1, SHA-256 ou MD5) para verificação de integridade.

Id
id string

Um identificador exclusivo para o anexo.

Linguagem
language string

O idioma do conteúdo, representado como uma marca de idioma BCP-47.

Tamanho
size integer

O tamanho dos dados em bytes.

Title
title string

Um rótulo ou título para o anexo.

Endereço URL
url string

Um URL onde os dados podem ser acedidos.

Um link relacionado a um recurso de pacote.

Name Caminho Tipo Description
Extension
extension array of object

Uma extensão para dados estruturados adicionais.

items
extension object
Id
id string

Um identificador exclusivo para o link.

Extensão do modificador
modifierExtension array of object

Uma extensão que modifica outros elementos.

items
modifierExtension object
Relação
relation string

O tipo de relação com o recurso vinculado (por exemplo, próximo, anterior, etc.).

Endereço URL
url string

O URL que aponta para o destino do link.

CodeableConcept

Um conceito que pode ser definido por uma referência formal a uma terminologia ou ontologia ou pode ser fornecido por texto.

Name Caminho Tipo Description
Coding
coding array of Coding

Uma lista de codificações para o conceito.

Extension
extension array of object

Uma extensão para dados estruturados adicionais relacionados ao CodeableConcept.

items
extension object
Id
id string

Um identificador exclusivo para a instância CodeableConcept.

Texto
text string

Uma representação em linguagem humana do conceito tal como visto/selecionado/proferido pelo utilizador que introduziu os dados e/ou que representa o significado pretendido pelo utilizador.

Coding

Uma referência a um código definido num sistema de codificação.

Name Caminho Tipo Description
Código
code string

O símbolo na sintaxe definida pelo sistema.

Ecrã
display string

Uma representação do significado do código em linguagem humana.

Extension
extension array of object

Dados adicionais fornecidos através de extensões.

items
extension object
Id
id string

Um identificador exclusivo para esta instância de codificação.

System
system string

A identificação do sistema de código que define o significado do símbolo no código.

Usuário Selecionado
userSelected boolean

Indica se essa codificação foi selecionada diretamente pelo usuário.

Versão
version string

A versão do sistema de código que foi usada para escolher este código.

Ponto de Contacto

Informações sobre um ponto de contacto mediado por tecnologia (telefone, fax, correio eletrónico, etc.).

Name Caminho Tipo Description
Extension
extension array of object

Dados adicionais fornecidos através de extensões.

items
extension object
Id
id string

Um identificador exclusivo para esta instância de ponto de contacto.

period
period Period

Um período de tempo descrito por limites de data/hora de início e fim.

Classificação
rank integer

Especifica uma ordem de preferência para este ponto de contato.

System
system string

O sistema de comunicação mediada por tecnologia.

Utilização
use string

Identifica a finalidade deste ponto de contacto.

Valor
value string

Os detalhes reais do ponto de contato, como número de telefone ou endereço de e-mail.

HoráriodeFuncionamento

Especifica as horas durante as quais as operações são realizadas.

Name Caminho Tipo Description
Todo o dia
allDay boolean

Indica se o serviço está disponível o dia todo.

Hora de Encerramento
closingTime string

A hora em que as operações terminam durante o dia.

Dias da Semana
daysOfWeek array of string

Os dias da semana em que as operações são realizadas.

Extension
extension array of object

Conteúdo adicional definido por extensões.

items
extension object
Id
id string

Um identificador exclusivo para essas horas de operação.

Extensão do modificador
modifierExtension array of object

Extensões que modificam o horário de funcionamento.

items
modifierExtension object
Horário de Abertura
openingTime string

A hora em que as operações começam para o dia.

Nome Humano

O nome de um ser humano com a capacidade de identificar peças e uso.

Name Caminho Tipo Description
Extension
extension array of object

Conteúdo adicional definido por extensões.

items
extension object
Família
family string

O nome de família (frequentemente designado por «apelido»).

Dado
given array of string

Nomes próprios (não incluindo o nome de família).

Id
id string

Um identificador exclusivo para o nome humano.

period
period Period

Um período de tempo descrito por limites de data/hora de início e fim.

Prefixo
prefix array of string

Honoríficos ou títulos anteriores ao nome.

Sufixo
suffix array of string

Qualificadores ou títulos após o nome.

Texto
text string

Representação em texto do nome completo.

Utilização
use string

Identifica a finalidade desse nome.

Identificador

Um identificador exclusivo atribuído a uma entidade.

Name Caminho Tipo Description
Cedente
assigner object

A organização que emitiu o identificador.

Extension
extension array of object

Dados adicionais para o identificador.

items
extension object
Id
id string

Um identificador exclusivo para a instância Identifier.

period
period Period

Um período de tempo descrito por limites de data/hora de início e fim.

System
system string

O sistema que é usado para atribuir o identificador.

tipo
type CodeableConcept

Um conceito que pode ser definido por uma referência formal a uma terminologia ou ontologia ou pode ser fornecido por texto.

Utilização
use string

A utilização pretendida do identificador.

Valor
value string

O valor do identificador.

Localização

Informações sobre locais físicos onde os serviços são prestados e os recursos estão localizados.

Name Caminho Tipo Description
address
address Address

Define um local físico por seus componentes de endereço.

Alias
alias array of string

Uma lista de nomes alternativos que o local é conhecido como, ou era conhecido como no passado.

Exceções de disponibilidade
availabilityExceptions string

Uma descrição de quando o local não está disponível.

Contido
contained array of Resource

Recursos contidos e em linha.

Description
description string

Descrição do local, que ajuda a encontrar ou referenciar o local.

Ponto final
endpoint array of object

Pontos finais técnicos que fornecem acesso aos serviços operados para o local.

items
endpoint object
Extension
extension array of object

Conteúdo adicional definido por extensões.

items
extension object
horasdeFuncionamento
hoursOfOperation HoursOfOperation

Especifica as horas durante as quais as operações são realizadas.

Id
id string

Identificador exclusivo para o recurso Location.

Identificador
identifier array of Identifier

Código ou número único que identifica a localização para os seus utilizadores.

Regras implícitas
implicitRules string

Um conjunto de regras sob as quais esse conteúdo foi criado.

Linguagem
language string

O idioma do conteúdo do recurso.

Gestão da Organização
managingOrganization object

A organização responsável pelo aprovisionamento e conservação do local.

meta
meta Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Mode
mode string

Indica se o local ainda está em uso.

Extensão do modificador
modifierExtension array of object

Extensões que não podem ser ignoradas.

items
modifierExtension object
Nome
name string

Nome do local como usado por seres humanos.

Situação operacional
operationalStatus Coding

Uma referência a um código definido num sistema de codificação.

Parte da seringa
partOf object

Outro local do qual este local faz parte fisicamente.

Tipo Físico
physicalType CodeableConcept

Um conceito que pode ser definido por uma referência formal a uma terminologia ou ontologia ou pode ser fornecido por texto.

posição
position Position

A posição geográfica de um ponto.

Tipo de Recurso
resourceType string

O tipo de recurso (Local).

Situação
status string

O status do local (por exemplo, ativo, suspenso, inativo).

Telecomunicações
telecom array of ContactPoint

Detalhes de contato do local.

enviar SMS
text Narrative

Um resumo legível por humanos do recurso que transmita as informações clínicas e comerciais essenciais para o recurso.

Tipo
type array of CodeableConcept

Tipo de função desempenhada no local.

LocalizaçãoBundle

Uma coleção de recursos de 'Localização' retornados como resultado de uma operação de pesquisa/consulta.

Name Caminho Tipo Description
Entry
entry array of LocationEntry

Uma lista de entradas, cada uma encapsulando um recurso 'Local'.

Id
id string

Identificador exclusivo do pacote.

identificador
identifier Identifier

Um identificador exclusivo atribuído a uma entidade.

Regras implícitas
implicitRules string

Uma referência às regras sob as quais o pacote foi gerado.

Linguagem
language string

O idioma do pacote.

Link
link array of BundleLink

Uma série de links que fornecem o contexto deste pacote.

meta
meta Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Tipo de Recurso
resourceType string

O tipo de recurso (Bundle).

assinatura
signature Signature

Uma assinatura digital, juntamente com contexto e metadados de suporte.

Data e Hora
timestamp string

A data/hora em que o pacote foi composto.

Total
total integer

O número total de recursos no pacote.

Tipo
type string

O tipo do pacote (por exemplo, documento, conjunto de pesquisa, coleção).

LocalizaçãoEntry

Uma entrada num 'LocationBundle' contendo um recurso 'Location' e informações relacionadas.

Name Caminho Tipo Description
Extension
extension array of object

Conteúdo adicional definido por extensões.

items
extension object
URL completo
fullUrl string

O URL absoluto que é o destino da entrada.

Id
id string

Identificador exclusivo para a entrada dentro do pacote.

Link
link array of BundleLink

Uma série de links relacionados com a entrada.

Extensão do modificador
modifierExtension array of object

Extensões que modificam a entrada.

items
modifierExtension object
pedido
request Request

Um recurso de solicitação dentro de um pacote.

recurso
resource Location

Informações sobre locais físicos onde os serviços são prestados e os recursos estão localizados.

response
response Response

Um recurso de resposta dentro de um pacote.

pesquisa
search Search

Um recurso que representa uma operação de pesquisa ou um recurso de pesquisa.

Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Name Caminho Tipo Description
Extension
extension array of object

Conteúdo adicional definido por extensões.

items
extension object
Id
id string

Identificador exclusivo para a instância Meta.

Última atualização
lastUpdated string

A última vez que o recurso foi atualizado.

Profile
profile array of string

Perfis que definem a estrutura e o uso do recurso.

Segurança
security array of Coding

Tags de segurança para o recurso.

Fonte
source string

O local onde o recurso foi gerado.

Tag
tag array of Coding

Tags para o recurso.

ID da versão
versionId string

A versão do recurso.

Narrativa

Um resumo legível por humanos do recurso que transmita as informações clínicas e comerciais essenciais para o recurso.

Name Caminho Tipo Description
Div
div string

O conteúdo XHTML da narrativa.

Extension
extension array of object

Conteúdo adicional definido por extensões.

items
extension object
Id
id string

Identificador exclusivo para a instância Narrative.

Situação
status string

O status da geração de conteúdo narrativo.

Organização

Representa um grupo de pessoas definido por um propósito comum, como um hospital, departamento, equipe ou companhia de seguros.

Name Caminho Tipo Description
Active
active boolean

Indica se a organização está ativa ou inativa.

address
address array of Address
Alias
alias array of string

Uma lista de nomes alternativos pelos quais a organização é conhecida ou era conhecida no passado.

contacto
contact array of OrganizationContact
contido
contained array of Resource
Ponto final
endpoint array of object

Terminais técnicos que fornecem acesso a serviços eletrónicos operados para a organização.

items
endpoint object
Extension
extension array of object

Extensões para obter informações adicionais.

items
extension object
Id
id string

Identificador exclusivo para a instância da organização.

identificador
identifier array of Identifier
Regras implícitas
implicitRules string

Uma referência ao conjunto de regras sob o qual este recurso foi criado.

Linguagem
language string

O idioma do conteúdo do recurso.

meta
meta Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Extensão do modificador
modifierExtension array of object

Extensões que modificam o recurso.

items
modifierExtension object
Nome
name string

O nome da organização.

Parte da seringa
partOf object

A organização de que esta organização faz parte.

Tipo de Recurso
resourceType string

Tipo de recurso (Organização).

Telecomunicações
telecom array of ContactPoint
enviar SMS
text Narrative

Um resumo legível por humanos do recurso que transmita as informações clínicas e comerciais essenciais para o recurso.

tipo
type array of CodeableConcept

OrganizationBundle

Name Caminho Tipo Description
introdução
entry array of OrganizationEntry
Identificador
id string

O identificador exclusivo para este pacote.

identificador
identifier Identifier

Um identificador exclusivo atribuído a uma entidade.

Regras implícitas
implicitRules string

Uma referência ao conjunto de regras aplicadas ao pacote.

Linguagem
language string

O idioma do conteúdo do pacote.

ligação
link array of BundleLink
meta
meta Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Tipo de Recurso
resourceType string

Define o tipo de recurso, neste caso, um pacote.

assinatura
signature Signature

Uma assinatura digital, juntamente com contexto e metadados de suporte.

Data e Hora
timestamp string

A data e hora em que o pacote foi compilado.

Total
total integer

O número total de entradas no pacote.

Tipo
type string

O tipo de pacote, como documento, mensagem, transação.

OrganizaçãoContato

Um detalhe de contato para a organização.

Name Caminho Tipo Description
address
address Address

Define um local físico por seus componentes de endereço.

Extension
extension array of object

Conteúdo adicional definido por implementações.

items
extension object
Identificador
id string

Identificador exclusivo para o contato da organização.

Extensão do modificador
modifierExtension array of object

Extensões que não podem ser ignoradas, mesmo que não sejam reconhecidas.

items
modifierExtension object
nome
name HumanName

O nome de um ser humano com a capacidade de identificar peças e uso.

purpose
purpose CodeableConcept

Um conceito que pode ser definido por uma referência formal a uma terminologia ou ontologia ou pode ser fornecido por texto.

Telecomunicações
telecom array of ContactPoint

OrganizationEntry

Representa uma entrada em um pacote da organização.

Name Caminho Tipo Description
Extension
extension array of object

Extensão para informações adicionais.

items
extension object
URL completo
fullUrl string

A URL completa do recurso.

ID
id string

O identificador exclusivo da entrada.

Link
link array of BundleLink

Uma série de links que fornecem contexto para esta entrada.

Extensão do modificador
modifierExtension array of object

Extensões que modificam o recurso.

items
modifierExtension object
pedido
request Request

Um recurso de solicitação dentro de um pacote.

recurso
resource Organization

Representa um grupo de pessoas definido por um propósito comum, como um hospital, departamento, equipe ou companhia de seguros.

response
response Response

Um recurso de resposta dentro de um pacote.

pesquisa
search Search

Um recurso que representa uma operação de pesquisa ou um recurso de pesquisa.

Período

Um período de tempo descrito por limites de data/hora de início e fim.

Name Caminho Tipo Description
Fim
end string

A data/hora final do período.

Extension
extension array of object

Informações adicionais ou metadados sobre o período.

items
extension object
Id
id string

Identificador único do período.

Start
start string

A data/hora de início do período.

Position

A posição geográfica de um ponto.

Name Caminho Tipo Description
Altitude
altitude number

A altitude em metros acima do elipsoide de referência.

Extension
extension array of object

Informações adicionais ou metadados sobre a posição.

items
extension object
Id
id string

Identificador exclusivo da posição.

Latitude
latitude number

A latitude em graus decimais (WGS 84).

Longitude
longitude number

A longitude em graus decimais (WGS 84).

Extensão do modificador
modifierExtension array of object

Informações adicionais ou metadados sobre a posição.

items
modifierExtension object

Praticante

Pessoa direta ou indiretamente envolvida na prestação de cuidados de saúde.

Name Caminho Tipo Description
Active
active boolean

Indica se o profissional está atualmente ativo na prestação de cuidados de saúde.

Address
address array of Address

Endereço(s) onde o profissional pode ser contactado ou visitado(s).

Data de nascimento
birthDate string

A data de nascimento do praticante.

Communication
communication array of CodeableConcept

Uma linguagem que o profissional é capaz de usar na comunicação com o paciente.

Contido
contained array of Resource

Recursos contidos neste recurso.

Extensions
extensions array of object

Informações adicionais ou metadados sobre o profissional.

items
extensions object
Sexo
gender string

A identidade de género do praticante.

Id
id string

Identificador único para o praticante.

Identificador
identifier array of Identifier

Uma lista dos identificadores do profissional.

Regras implícitas
implicitRules string

Uma referência a um conjunto de regras que foram seguidas quando o recurso foi construído.

Linguagem
language string

Linguagem que o profissional é capaz de usar na comunicação com o paciente.

meta
meta Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Extensões modificadoras
modifierExtensions array of object

Informações adicionais ou metadados sobre o profissional.

items
modifierExtensions object
Nome
name array of HumanName

O(s) nome(s) associado(s) ao praticante.

Fotografia
photo array of Attachment

Uma foto do praticante.

Qualificação
qualification array of PractitionerQualification

Qualificações obtidas por formação e certificação.

Tipo de Recurso
resourceType string

Tipo de recurso (Practitioner).

Telecomunicações
telecom array of ContactPoint

Um detalhe de contato para o profissional.

enviar SMS
text Narrative

Um resumo legível por humanos do recurso que transmita as informações clínicas e comerciais essenciais para o recurso.

PractitionerAvailableTime

Os horários em que o profissional está disponível para consultas.

Name Caminho Tipo Description
Todo o dia
allDay boolean

Indica se o profissional está disponível o dia todo.

Hora de Fim Disponível
availableEndTime string

A hora de término em que o profissional está disponível para consultas.

Hora de início disponível
availableStartTime string

A hora de início em que o profissional está disponível para consultas.

Dias da Semana
daysOfWeek array of string

Os dias da semana em que o profissional está disponível para consultas.

Extension
extension array of object

Informações adicionais ou metadados sobre a disponibilidade do profissional.

items
extension object
Id
id string

Identificador único para a disponibilidade do profissional.

Extensão do modificador
modifierExtension array of object

Informações adicionais ou metadados sobre a disponibilidade do profissional.

items
modifierExtension object

Pacote Practitioner

Um pacote de recursos contendo informações sobre um ou mais profissionais.

Name Caminho Tipo Description
Entry
entry array of PractitionerEntry

Uma entrada no pacote - terá um recurso, ou informações sobre uma pesquisa, etc.

Id
id string

Identificador exclusivo do pacote.

identificador
identifier Identifier

Um identificador exclusivo atribuído a uma entidade.

Regras implícitas
implicitRules string

Uma referência a um conjunto de regras que foram seguidas quando o recurso foi construído.

Linguagem
language string

Idioma do conteúdo do recurso.

Link
link array of BundleLink

Links relacionados a este pacote.

meta
meta Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Tipo de Recurso
resourceType string

Tipo de recurso (Bundle).

assinatura
signature Signature

Uma assinatura digital, juntamente com contexto e metadados de suporte.

Data e Hora
timestamp string

Quando o pacote foi montado.

Total
total integer

Se pesquisar, o número total de correspondências.

Tipo
type string

O tipo do recurso.

PractitionerEntry

Uma entrada no pacote contendo informações sobre um praticante.

Name Caminho Tipo Description
Extension
extension array of object

Informações adicionais ou metadados sobre a entrada do profissional.

items
extension object
URL completo
fullUrl string

O URL da entrada.

ID
id string

Identificador único para a entrada do profissional.

Link
link array of BundleLink

Links relacionados com esta entrada de praticante.

Extensão do modificador
modifierExtension array of object

Informações adicionais ou metadados sobre a entrada do profissional.

items
modifierExtension object
pedido
request Request

Um recurso de solicitação dentro de um pacote.

recurso
resource Practitioner

Pessoa direta ou indiretamente envolvida na prestação de cuidados de saúde.

response
response Response

Um recurso de resposta dentro de um pacote.

pesquisa
search Search

Um recurso que representa uma operação de pesquisa ou um recurso de pesquisa.

PractitionerNotAvailable

Os horários em que o profissional não está disponível para consultas.

Name Caminho Tipo Description
Description
description string

Uma descrição do motivo pelo qual o profissional não está disponível.

durante a experiência
during Period

Um período de tempo descrito por limites de data/hora de início e fim.

Extension
extension array of object

Informações adicionais ou metadados sobre a indisponibilidade do profissional.

items
extension object
ID
id string

Identificador único para a indisponibilidade do profissional.

Extensão do modificador
modifierExtension array of object

Informações adicionais ou metadados sobre a indisponibilidade do profissional.

items
modifierExtension object

Qualificação Profissional

As qualificações ou certificações detidas pelo profissional.

Name Caminho Tipo Description
código
code CodeableConcept

Um conceito que pode ser definido por uma referência formal a uma terminologia ou ontologia ou pode ser fornecido por texto.

Extension
extension array of object

Informações adicionais ou metadados sobre a qualificação do profissional.

items
extension object
ID
id string

Identificador único para a qualificação do profissional.

Identificador
identifier array of Identifier

Identificadores associados à qualificação do profissional.

Issuer
issuer object

A entidade que emitiu a qualificação.

Extensão do modificador
modifierExtension array of object

Informações adicionais ou metadados sobre a qualificação do profissional.

items
modifierExtension object
period
period Period

Um período de tempo descrito por limites de data/hora de início e fim.

Papel do Profissional

Define o papel de um profissional dentro de uma organização ou prática de saúde.

Name Caminho Tipo Description
Active
active boolean

Indica se a função desse profissional está ativa no momento.

Exceções de disponibilidade
availabilityExceptions string

Informações adicionais sobre a disponibilidade da função deste profissional, se aplicável.

Tempo disponível
availableTime array of PractitionerAvailableTime

Os horários em que este profissional está disponível para consultas ou outros serviços.

Código
code array of CodeableConcept

O(s) código(s) que identifica(m) o tipo de função do prestador de cuidados de saúde que está a ser cumprida.

Contido
contained array of Resource

Recursos relacionados que são definidos em linha dentro do recurso.

Ponto final
endpoint array of object

Os parâmetros técnicos que fornecem acesso aos serviços operados para o profissional.

items
endpoint object
Extension
extension array of object

Conteúdo adicional definido por implementações.

items
extension object
Serviço de Saúde
healthcareService array of object

Os serviços de saúde que este profissional presta para a organização ou prática.

items
healthcareService object
ID
id string

O identificador lógico para esta função de praticante.

Identificador
identifier array of Identifier

O(s) identificador(es) único(s) para esta função de profissional no contexto de um sistema específico.

Regras implícitas
implicitRules string

Uma referência a um conjunto de regras que foram seguidas quando o recurso foi construído e que devem ser entendidas ao processar o conteúdo.

Linguagem
language string

O idioma base no qual o recurso é escrito.

Localização
location array of object

O(s) local(is) onde este profissional presta serviços.

items
location object
meta
meta Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Extensão do modificador
modifierExtension array of object

Conteúdo adicional definido por implementações que modificam o conteúdo do recurso de alguma forma.

items
modifierExtension object
Não Disponível
notAvailable array of PractitionerNotAvailable

Os horários em que este profissional não está disponível para consultas ou outros serviços.

Organização
organization object

A organização ou serviço de saúde onde este papel do profissional é definido.

period
period Period

Um período de tempo descrito por limites de data/hora de início e fim.

Praticante
practitioner object

O profissional responsável pelos serviços prestados por esta função.

Tipo de Recurso
resourceType string

Um tipo de recurso que é identificável juntamente com outros recursos.

Especialidade
specialty array of CodeableConcept

Serviços específicos de especialidade prestados pelo profissional no contexto desta função.

Telecomunicações
telecom array of ContactPoint

Detalhes de contato para a função de praticante.

enviar SMS
text Narrative

Um resumo legível por humanos do recurso que transmita as informações clínicas e comerciais essenciais para o recurso.

PractitionerRoleBundle

Um pacote de recursos de função de praticante, normalmente usado para fornecer um conjunto completo de resultados de pesquisa ou um subconjunto de recursos em uma lista paginada.

Name Caminho Tipo Description
Entry
entry array of PractitionerRoleEntry

Uma entrada no pacote - terá um recurso, ou informações sobre um recurso.

ID
id string

O identificador lógico para este pacote.

identificador
identifier Identifier

Um identificador exclusivo atribuído a uma entidade.

Regras implícitas
implicitRules string

Uma referência a um conjunto de regras que foram seguidas quando o pacote foi construído e que devem ser entendidas ao processar o conteúdo.

Linguagem
language string

O idioma base no qual o recurso é escrito.

Link
link array of BundleLink

Uma série de links que fornecem contexto para este pacote.

meta
meta Meta

Metadados sobre um recurso, incluindo versão, perfil e segurança.

Tipo de Recurso
resourceType string

Um tipo de recurso que é identificável juntamente com outros recursos.

assinatura
signature Signature

Uma assinatura digital, juntamente com contexto e metadados de suporte.

Data e Hora
timestamp string

A hora em que o pacote foi montado.

Total
total integer

O número total de entradas no pacote.

Tipo
type string

O tipo de pacote - indica se é um documento, mensagem, transação, etc.

PractitionerRoleEntry

Uma entrada num pacote do tipo «PractitionerRole» que contém informações sobre o papel de um praticante.

Name Caminho Tipo Description
Extension
extension array of object

Informações adicionais ou metadados sobre a entrada.

items
extension object
URL completo
fullUrl string

A URL completa do recurso na entrada.

ID
id string

Identificador exclusivo da entrada.

Link
link array of BundleLink

Links relacionados com esta entrada.

Extensão do modificador
modifierExtension array of object

Informações adicionais ou metadados sobre a entrada.

items
modifierExtension object
pedido
request Request

Um recurso de solicitação dentro de um pacote.

recurso
resource PractitionerRole

Define o papel de um profissional dentro de uma organização ou prática de saúde.

response
response Response

Um recurso de resposta dentro de um pacote.

pesquisa
search Search

Um recurso que representa uma operação de pesquisa ou um recurso de pesquisa.

Solicitação

Um recurso de solicitação dentro de um pacote.

Name Caminho Tipo Description
object

Um recurso de solicitação dentro de um pacote.

Resource

Um recurso FHIR que representa um único conceito coerente ou ocorrência de uma coisa.

Name Caminho Tipo Description
object

Um recurso FHIR que representa um único conceito coerente ou ocorrência de uma coisa.

Resposta

Um recurso de resposta dentro de um pacote.

Name Caminho Tipo Description
object

Um recurso de resposta dentro de um pacote.

Pesquisa

Um recurso que representa uma operação de pesquisa ou um recurso de pesquisa.

Name Caminho Tipo Description
object

Um recurso que representa uma operação de pesquisa ou um recurso de pesquisa.

Signature

Uma assinatura digital, juntamente com contexto e metadados de suporte.

Name Caminho Tipo Description
Data
data string

O conteúdo da assinatura codificada base64.

Extension
extension array of object

Informações adicionais definidas pelas implementações.

items
extension object
Id
id string

O identificador exclusivo para esta assinatura.

Em nome de
onBehalfOf object

A parte representada por esta assinatura.

Formato da assinatura
sigFormat string

O formato técnico do conteúdo da assinatura.

Formato de destino
targetFormat string

O formato técnico do conteúdo assinado.

Tipo
type array of Coding

A codificação que representa a finalidade da assinatura.

Quando
when string

Quando a assinatura foi criada.

Quem
who object

Para quem é feita esta assinatura.