Provedores de Assuntos de Veteranos (Editor Independente) (versão prévia)
A API do Diretório do Provedor facilita o desenvolvimento de aplicativos que podem recuperar listas de provedores de VA, oferecendo detalhes sobre locais de provedor, especialidades, horários de escritório 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.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – 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 |
| richard.a.wilson@microsoft.com |
| Metadados do conector | |
|---|---|
| Publicador | Richard Wilson |
| Guia de implementação do DaVinci PDEX Plan Net | https://docs.microsoft.com/connectors/veteransaffairsprovi |
| Site | https://developer.va.gov |
| Política de privacidade | https://www.va.gov/privacy/ |
| Categorias | Recursos Humanos |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 da API va para esta api | Verdade |
| Ambiente | cadeia | O ambiente de API de VA a ser usado (Produção ou Área Restrita) | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Listar funções de praticante |
Recupera uma lista de funções de praticante 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 do provedor, especialidades e horas de escritório. |
| 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 de última atualização. |
| Obter a função de praticante por ID |
Recupera informações detalhadas sobre uma função de profissional específica por 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 sua ID, incluindo locais de provedor, especialidades e horários de escritório. |
| Obter o praticante por ID |
Recupera informações detalhadas sobre um profissional específico por sua ID exclusiva, incluindo identificadores, nomes e qualificações. |
| 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. |
Listar funções de praticante
Recupera uma lista de funções de praticante com base em critérios especificados, incluindo identificadores e nomes, refletindo suas funções e responsabilidades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
_id | string |
A ID lógica do recurso. Uma vez atribuído, esse valor nunca é alterado. |
|
|
Identificador do praticante
|
practitioner.identifier | string |
Um identificador exclusivo para um praticante dentro de um determinado sistema. |
|
|
Nome do praticante
|
practitioner.name | string |
O nome fornecido ou da família do praticante. |
|
|
Última Atualização
|
_lastUpdated | string |
A data em que o registro de função do praticante foi atualizado pela última vez. |
|
|
Página
|
page | integer |
O número da página que está sendo solicitado. |
|
|
Contagem
|
_count | integer |
O número de recursos retornados em uma única página, até um máximo de 100. |
Retornos
Um pacote de recursos de função do praticante, normalmente usados para fornecer um conjunto completo de resultados de pesquisa ou um subconjunto de recursos em uma lista paginada.
- Corpo
- PractitionerRoleBundle
Listar locais
Recupera uma lista de locais com base em critérios especificados, incluindo locais do provedor, especialidades e horas de escritório.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
_id | string |
A ID lógica do recurso. Uma vez atribuído, esse valor nunca é alterado. |
|
|
Identificador
|
identifier | string |
O identificador lógico do recurso. Uma vez atribuído, esse valor nunca é alterado. |
|
|
Endereço
|
address | string |
Especifica o local físico do registro usando convenções postais. |
|
|
Cidade do Endereço
|
address-city | string |
Especifica a cidade em que o local reside. |
|
|
Estado do endereço
|
address-state | string |
Especifica o estado em que o local reside. |
|
|
Endereço Postalcode
|
address-postalcode | string |
Especifica o código postal para a região em que 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 localização foi atualizado pela última vez. |
|
|
Página
|
page | integer |
O número da página do resultado da pesquisa. |
|
|
Contagem
|
_count | integer |
O número de recursos retornados em uma única página, até um máximo de 100. |
Retornos
Uma coleção de recursos 'Location' retornados como resultado de uma operação de pesquisa/consulta.
- Corpo
- LocationBundle
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
_id | string |
A ID lógica do recurso. Uma vez atribuído, esse valor nunca é alterado. |
|
|
Identificador
|
identifier | string |
O identificador lógico do recurso. Uma vez atribuído, esse valor nunca é alterado. |
|
|
Endereço
|
address | string |
Especifica o local físico da organização usando convenções postais. |
|
|
City
|
address-city | string |
Especifica a cidade em que a organização reside. |
|
|
Estado
|
address-state | string |
Especifica o estado em que a organização reside. |
|
|
Código postal
|
address-postalcode | string |
Especifica o código postal para a região em que a organização reside. |
|
|
Nome
|
name | string |
Indica o nome da organização como ela é 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. |
|
|
Contagem
|
_count | integer |
O número de recursos retornados em uma única página, até um máximo de 100. |
Retornos
- Corpo
- OrganizationBundle
Listar profissionais
Recupera uma lista de profissionais com base em critérios especificados, incluindo identificadores, nomes e datas de última atualização.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
_id | string |
A ID lógica do recurso. Uma vez atribuído, esse valor nunca é alterado. |
|
|
Identificador
|
identifier | string |
Um identificador exclusivo para um praticante dentro de um determinado sistema. |
|
|
Sobrenome
|
family | string |
O nome da família do praticante. |
|
|
Nome
|
given | string |
O nome determinado do praticante. |
|
|
Nome
|
name | string |
O nome fornecido ou da família do praticante. |
|
|
Última Atualização
|
_lastUpdated | string |
A data em que o registro do praticante foi atualizado pela última vez. |
|
|
Página
|
page | integer |
O número da página do resultado da pesquisa. |
|
|
Contagem
|
_count | integer |
O número de recursos retornados em uma única página, até um máximo de 100. |
Retornos
Um pacote de recursos que contém informações sobre um ou mais profissionais.
- Corpo
- PractitionerBundle
Obter a função de praticante por ID
Recupera informações detalhadas sobre uma função de profissional específica por sua ID exclusiva, incluindo atribuições de função, qualificações e identificadores.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
A ID lógica do recurso, que permanece inalterada uma vez atribuída. |
Retornos
Define a função de um profissional dentro de uma organização ou prática de saúde.
- Corpo
- PractitionerRole
Obter localização por ID
Recupera informações detalhadas sobre um local específico por sua ID, incluindo locais de provedor, especialidades e horários de escritório.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
A ID lógica do recurso. Uma vez atribuído, esse valor nunca é alterado. |
Retornos
Informações sobre locais físicos onde os serviços são fornecidos e os recursos estão localizados.
- Corpo
- Location
Obter o praticante por ID
Recupera informações detalhadas sobre um profissional específico por sua ID exclusiva, incluindo identificadores, nomes e qualificações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
A ID lógica do recurso. Uma vez atribuído, esse valor nunca é alterado. |
Retornos
Uma pessoa envolvida direta ou indiretamente na prestação de serviços de saúde.
- Corpo
- Practitioner
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
A ID lógica do recurso. Uma vez atribuído, esse valor nunca é alterado. |
Retornos
Representa um grupo de pessoas definido por uma finalidade comum, como um hospital, departamento, equipe ou companhia de seguros.
- Corpo
- Organization
Definições
Endereço
Define um local físico por seus componentes de endereço.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
City
|
city | string |
O nome da cidade do endereço. |
|
País
|
country | string |
O nome do país do endereço. |
|
Distrito
|
district | string |
O distrito ou a sub-região do endereço que ajuda na localização adicional. |
|
Extension
|
extension | array of object |
A extensão contém informações extras 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 pelos limites de data/hora de início e término. |
|
Código postal
|
postalCode | string |
O código postal do endereço. |
|
Estado
|
state | string |
O estado ou a 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 (home, work, temp, old, billing). |
Anexo
Um tipo complexo que contém conteúdo em formato digital.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de conteúdo
|
contentType | string |
O tipo de mime do conteúdo. |
|
Criação
|
creation | string |
A data e a hora em que o conteúdo foi criado. |
|
Dados
|
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. |
|
URL
|
url | string |
Uma URL em que os dados podem ser acessados. |
BundleLink
Um link relacionado a um recurso de pacote.
| Nome | 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 | |
|
Relation
|
relation | string |
O tipo de relação com o recurso vinculado (por exemplo, próximo, anterior, etc.). |
|
URL
|
url | string |
A 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 pelo texto.
| Nome | 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 como visto/selecionado/proferido pelo usuário que inseriu os dados e/ou que representa o significado pretendido do usuário. |
Coding
Uma referência a um código definido em um sistema de codificação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
code | string |
O símbolo na sintaxe definida pelo sistema. |
|
Display
|
display | string |
Uma representação do significado do código na linguagem humana. |
|
Extension
|
extension | array of object |
Dados adicionais fornecidos por meio de extensões. |
|
items
|
extension | object | |
|
ID
|
id | string |
Um identificador exclusivo para essa 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 esse código. |
ContactPoint
Detalhes de um ponto de contato mediado por tecnologia (telefone, fax, email etc.).
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Extension
|
extension | array of object |
Dados adicionais fornecidos por meio de extensões. |
|
items
|
extension | object | |
|
ID
|
id | string |
Um identificador exclusivo para essa instância de ponto de contato. |
|
period
|
period | Period |
Um período de tempo descrito pelos limites de data/hora de início e término. |
|
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 contato. |
|
Value
|
value | string |
Os detalhes reais do ponto de contato, como número de telefone ou endereço de email. |
HoursOfOperation
Especifica as horas durante as quais as operações são realizadas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
O dia todo
|
allDay | boolean |
Indica se o serviço está disponível o dia todo. |
|
Hora de Fechamento
|
closingTime | string |
A hora em que as operações terminam para 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 as horas de operação. |
|
items
|
modifierExtension | object | |
|
Hora de Abertura
|
openingTime | string |
A hora em que as operações começam para o dia. |
HumanName
O nome de um humano com a capacidade de identificar partes e uso.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Extension
|
extension | array of object |
Conteúdo adicional definido por extensões. |
|
items
|
extension | object | |
|
Família
|
family | string |
O nome da família (muitas vezes chamado de 'Sobrenome'). |
|
Dado
|
given | array of string |
Nomes fornecidos (sem incluir o nome da família). |
|
ID
|
id | string |
Um identificador exclusivo para o nome humano. |
|
period
|
period | Period |
Um período de tempo descrito pelos limites de data/hora de início e término. |
|
Prefixo
|
prefix | array of string |
Honoríficos ou títulos anteriores ao nome. |
|
Sufixo
|
suffix | array of string |
Qualificadores ou títulos seguindo o nome. |
|
Texto
|
text | string |
Representação de texto do nome completo. |
|
Utilização
|
use | string |
Identifica a finalidade desse nome. |
Identificador
Um identificador exclusivo atribuído a uma entidade.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Atribuídor
|
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 do Identificador. |
|
period
|
period | Period |
Um período de tempo descrito pelos limites de data/hora de início e término. |
|
System
|
system | string |
O sistema 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 pelo texto. |
|
Utilização
|
use | string |
O uso pretendido do identificador. |
|
Value
|
value | string |
O valor do identificador. |
Localização
Informações sobre locais físicos onde os serviços são fornecidos e os recursos estão localizados.
| Nome | 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 embutidos contidos. |
|
Description
|
description | string |
Descrição do Local, que ajuda a localizar ou referenciar o local. |
|
Ponto final
|
endpoint | array of object |
Pontos de extremidade 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 | |
|
hoursOfOperation
|
hoursOfOperation | HoursOfOperation |
Especifica as horas durante as quais as operações são realizadas. |
|
ID
|
id | string |
Identificador exclusivo para o recurso Local. |
|
Identificador
|
identifier | array of Identifier |
Código ou número exclusivo que identifica o local para seus usuários. |
|
Regras implícitas
|
implicitRules | string |
Um conjunto de regras sob o qual esse conteúdo foi criado. |
|
Linguagem
|
language | string |
O idioma do conteúdo do recurso. |
|
Gerenciando a organização
|
managingOrganization | object |
A organização responsável pelo provisionamento e manutençã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, conforme usado por humanos. |
|
operationalStatus
|
operationalStatus | Coding |
Uma referência a um código definido em um sistema de codificação. |
|
Parte de
|
partOf | object |
Outro local do qual este Local faz parte fisicamente. |
|
physicalType
|
physicalType | CodeableConcept |
Um conceito que pode ser definido por uma referência formal a uma terminologia ou ontologia ou pode ser fornecido pelo texto. |
|
posição
|
position | Position |
A posição geográfica de um ponto. |
|
Tipo de recurso
|
resourceType | string |
O tipo do recurso (Local). |
|
Situação
|
status | string |
O status do local (por exemplo, ativo, suspenso, inativo). |
|
Telecomunicações
|
telecom | array of ContactPoint |
Contate os detalhes do local. |
|
enviar SMS
|
text | Narrative |
Um resumo legível pelo homem do recurso que transmite as informações clínicas e comerciais essenciais para o recurso. |
|
Tipo
|
type | array of CodeableConcept |
Tipo de função executada no local. |
LocationBundle
Uma coleção de recursos 'Location' retornados como resultado de uma operação de pesquisa/consulta.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Entry
|
entry | array of LocationEntry |
Uma lista de entradas, cada uma encapsulando um recurso 'Location'. |
|
ID
|
id | string |
Identificador exclusivo para o 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 desse pacote. |
|
meta
|
meta | Meta |
Metadados sobre um recurso, incluindo versão, perfil e segurança. |
|
Tipo de recurso
|
resourceType | string |
O tipo do recurso (Pacote). |
|
assinatura
|
signature | Signature |
Uma assinatura digital, juntamente com contexto e metadados de suporte. |
|
Timestamp
|
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 pesquisas, coleção). |
LocationEntry
Uma entrada em um 'LocationBundle' que contém um recurso 'Location' e informações relacionadas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Extension
|
extension | array of object |
Conteúdo adicional definido por extensões. |
|
items
|
extension | object | |
|
URL completa
|
fullUrl | string |
A URL absoluta 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 à entrada. |
|
Extensão do modificador
|
modifierExtension | array of object |
Extensões que modificam a entrada. |
|
items
|
modifierExtension | object | |
|
solicitação
|
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 fornecidos e os recursos estão localizados. |
|
response
|
response | Response |
Um recurso de resposta dentro de um pacote. |
|
busca
|
search | Search |
Um recurso que representa uma operação de pesquisa ou uma funcionalidade de pesquisa. |
Meta
Metadados sobre um recurso, incluindo versão, perfil e segurança.
| Nome | 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 do 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 |
Marcas de segurança para o recurso. |
|
Source
|
source | string |
O local onde o recurso foi gerado. |
|
Etiqueta
|
tag | array of Coding |
Marcas para o recurso. |
|
ID da versão
|
versionId | string |
A versão do recurso. |
Narrativa
Um resumo legível pelo homem do recurso que transmite as informações clínicas e comerciais essenciais para o recurso.
| Nome | 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 narrativa. |
|
Situação
|
status | string |
O status da geração de conteúdo narrativo. |
Organização
Representa um grupo de pessoas definido por uma finalidade comum, como um hospital, departamento, equipe ou companhia de seguros.
| Nome | 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. |
|
contato
|
contact | array of OrganizationContact | |
|
contido
|
contained | array of Resource | |
|
Ponto final
|
endpoint | array of object |
Pontos de extremidade técnicos que fornecem acesso aos 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 esse 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 de
|
partOf | object |
A organização da qual essa 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 pelo homem do recurso que transmite as informações clínicas e comerciais essenciais para o recurso. |
|
tipo
|
type | array of CodeableConcept |
OrganizationBundle
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
entrada
|
entry | array of OrganizationEntry | |
|
Identificador
|
id | string |
O identificador exclusivo para esse pacote. |
|
identificador
|
identifier | Identifier |
Um identificador exclusivo atribuído a uma entidade. |
|
Regras implícitas
|
implicitRules | string |
Uma referência ao conjunto de regras aplicado ao pacote. |
|
Linguagem
|
language | string |
O idioma do conteúdo no pacote. |
|
link
|
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, nesse caso, um pacote. |
|
assinatura
|
signature | Signature |
Uma assinatura digital, juntamente com contexto e metadados de suporte. |
|
Timestamp
|
timestamp | string |
A data e a 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. |
OrganizationContact
Um detalhe de contato para a organização.
| Nome | 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 se não forem reconhecidas. |
|
items
|
modifierExtension | object | |
|
nome
|
name | HumanName |
O nome de um humano com a capacidade de identificar partes e uso. |
|
propósito
|
purpose | CodeableConcept |
Um conceito que pode ser definido por uma referência formal a uma terminologia ou ontologia ou pode ser fornecido pelo texto. |
|
telecomunicações
|
telecom | array of ContactPoint |
OrganizationEntry
Representa uma entrada em um pacote da organização.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Extension
|
extension | array of object |
Extensão para obter informações adicionais. |
|
items
|
extension | object | |
|
URL completa
|
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 essa entrada. |
|
Extensão do modificador
|
modifierExtension | array of object |
Extensões que modificam o recurso. |
|
items
|
modifierExtension | object | |
|
solicitação
|
request | Request |
Um recurso de solicitação dentro de um pacote. |
|
recurso
|
resource | Organization |
Representa um grupo de pessoas definido por uma finalidade comum, como um hospital, departamento, equipe ou companhia de seguros. |
|
response
|
response | Response |
Um recurso de resposta dentro de um pacote. |
|
busca
|
search | Search |
Um recurso que representa uma operação de pesquisa ou uma funcionalidade de pesquisa. |
Período
Um período de tempo descrito pelos limites de data/hora de início e término.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
participante
|
end | string |
A data/hora de término do período. |
|
Extension
|
extension | array of object |
Informações adicionais ou metadados sobre o período. |
|
items
|
extension | object | |
|
ID
|
id | string |
Identificador exclusivo do período. |
|
Start
|
start | string |
A data/hora de início do período. |
Cargo
A posição geográfica de um ponto.
| Nome | 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 para a 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
Uma pessoa envolvida direta ou indiretamente na prestação de serviços de saúde.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
active | boolean |
Indica se o profissional está ativo no momento na prestação de serviços de saúde. |
|
Endereço
|
address | array of Address |
Os endereços em que o profissional pode ser contatado ou visitado. |
|
Data de nascimento
|
birthDate | string |
A data de nascimento do praticante. |
|
Communication
|
communication | array of CodeableConcept |
Uma linguagem que o praticante pode usar na comunicação do paciente. |
|
Contido
|
contained | array of Resource |
Recursos contidos neste recurso. |
|
Extensions
|
extensions | array of object |
Informações adicionais ou metadados sobre o praticante. |
|
items
|
extensions | object | |
|
Gênero
|
gender | string |
A identidade de gênero do praticante. |
|
ID
|
id | string |
Identificador exclusivo para o praticante. |
|
Identificador
|
identifier | array of Identifier |
Uma lista dos identificadores do praticante. |
|
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 que o praticante pode usar na comunicação do paciente. |
|
meta
|
meta | Meta |
Metadados sobre um recurso, incluindo versão, perfil e segurança. |
|
Extensões do modificador
|
modifierExtensions | array of object |
Informações adicionais ou metadados sobre o praticante. |
|
items
|
modifierExtensions | object | |
|
Nome
|
name | array of HumanName |
Os nomes associados ao praticante. |
|
Foto
|
photo | array of Attachment |
Uma foto do praticante. |
|
Qualificação
|
qualification | array of PractitionerQualification |
Qualificações obtidas por treinamento e certificação. |
|
Tipo de recurso
|
resourceType | string |
Tipo de recurso (Practitioner). |
|
Telecomunicações
|
telecom | array of ContactPoint |
Um detalhe de contato para o praticante. |
|
enviar SMS
|
text | Narrative |
Um resumo legível pelo homem do recurso que transmite as informações clínicas e comerciais essenciais para o recurso. |
PractitionerAvailableTime
As horas em que o praticante está disponível para compromissos.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
O dia todo
|
allDay | boolean |
Indica se o praticante está disponível o dia todo. |
|
Hora de término disponível
|
availableEndTime | string |
A hora de término em que o praticante está disponível para compromissos. |
|
Hora de início disponível
|
availableStartTime | string |
A hora de início em que o praticante está disponível para compromissos. |
|
Dias da Semana
|
daysOfWeek | array of string |
Os dias da semana em que o praticante está disponível para compromissos. |
|
Extension
|
extension | array of object |
Informações adicionais ou metadados sobre a disponibilidade do praticante. |
|
items
|
extension | object | |
|
ID
|
id | string |
Identificador exclusivo para a disponibilidade do praticante. |
|
Extensão do modificador
|
modifierExtension | array of object |
Informações adicionais ou metadados sobre a disponibilidade do praticante. |
|
items
|
modifierExtension | object |
PractitionerBundle
Um pacote de recursos que contém informações sobre um ou mais profissionais.
| Nome | 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 para o 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 (Pacote). |
|
assinatura
|
signature | Signature |
Uma assinatura digital, juntamente com contexto e metadados de suporte. |
|
Timestamp
|
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 que contém informações sobre um praticante.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Extension
|
extension | array of object |
Informações adicionais ou metadados sobre a entrada do praticante. |
|
items
|
extension | object | |
|
URL completa
|
fullUrl | string |
A URL da entrada. |
|
ID
|
id | string |
Identificador exclusivo para a entrada do praticante. |
|
Link
|
link | array of BundleLink |
Links relacionados a essa entrada de praticante. |
|
Extensão do modificador
|
modifierExtension | array of object |
Informações adicionais ou metadados sobre a entrada do praticante. |
|
items
|
modifierExtension | object | |
|
solicitação
|
request | Request |
Um recurso de solicitação dentro de um pacote. |
|
recurso
|
resource | Practitioner |
Uma pessoa envolvida direta ou indiretamente na prestação de serviços de saúde. |
|
response
|
response | Response |
Um recurso de resposta dentro de um pacote. |
|
busca
|
search | Search |
Um recurso que representa uma operação de pesquisa ou uma funcionalidade de pesquisa. |
PractitionerNotAvailable
As horas em que o praticante não está disponível para compromissos.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Description
|
description | string |
Uma descrição do motivo pelo qual o praticante não está disponível. |
|
durante
|
during | Period |
Um período de tempo descrito pelos limites de data/hora de início e término. |
|
Extension
|
extension | array of object |
Informações adicionais ou metadados sobre a indisponibilidade do praticante. |
|
items
|
extension | object | |
|
ID
|
id | string |
Identificador exclusivo para a indisponibilidade do praticante. |
|
Extensão do modificador
|
modifierExtension | array of object |
Informações adicionais ou metadados sobre a indisponibilidade do praticante. |
|
items
|
modifierExtension | object |
PractitionerQualification
As qualificações ou certificações mantidas pelo profissional.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | CodeableConcept |
Um conceito que pode ser definido por uma referência formal a uma terminologia ou ontologia ou pode ser fornecido pelo texto. |
|
Extension
|
extension | array of object |
Informações adicionais ou metadados sobre a qualificação do praticante. |
|
items
|
extension | object | |
|
ID
|
id | string |
Identificador exclusivo para a qualificação do praticante. |
|
Identificador
|
identifier | array of Identifier |
Identificadores associados à qualificação do praticante. |
|
Emissor
|
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 praticante. |
|
items
|
modifierExtension | object | |
|
period
|
period | Period |
Um período de tempo descrito pelos limites de data/hora de início e término. |
PractitionerRole
Define a função de um profissional dentro de uma organização ou prática de saúde.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
active | boolean |
Indica se a função desse praticante está ativa no momento. |
|
Exceções de disponibilidade
|
availabilityExceptions | string |
Informações adicionais sobre a disponibilidade da função desse praticante, se aplicável. |
|
Tempo Disponível
|
availableTime | array of PractitionerAvailableTime |
Os horários durante os quais esse profissional está disponível para compromissos ou outros serviços. |
|
Code
|
code | array of CodeableConcept |
Os códigos que identificam o tipo de função de provedor de saúde que está sendo atendida. |
|
Contido
|
contained | array of Resource |
Recursos relacionados definidos embutidos no recurso. |
|
Ponto final
|
endpoint | array of object |
Os pontos de extremidade técnicos que fornecem acesso aos serviços operados para o praticante. |
|
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 esse profissional fornece para a organização ou a prática. |
|
items
|
healthcareService | object | |
|
ID
|
id | string |
O identificador lógico para essa função de praticante. |
|
Identificador
|
identifier | array of Identifier |
Os identificadores exclusivos para essa função de praticante dentro do 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 deve ser compreendida ao processar o conteúdo. |
|
Linguagem
|
language | string |
A linguagem base na qual o recurso é gravado. |
|
Localização
|
location | array of object |
Os locais em que esse profissional fornece 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 durante os quais esse profissional não está disponível para compromissos ou outros serviços. |
|
Organização
|
organization | object |
A organização ou o serviço de saúde em que essa função de praticante é definida. |
|
period
|
period | Period |
Um período de tempo descrito pelos limites de data/hora de início e término. |
|
Praticante
|
practitioner | object |
O profissional responsável pelos serviços fornecidos por essa função. |
|
Tipo de recurso
|
resourceType | string |
Um tipo de recurso que é identificável junto com outros recursos. |
|
Especialidade
|
specialty | array of CodeableConcept |
Serviços específicos de especialidade fornecidos pelo profissional dentro do contexto dessa função. |
|
Telecomunicações
|
telecom | array of ContactPoint |
Entre em contato com os detalhes da função de praticante. |
|
enviar SMS
|
text | Narrative |
Um resumo legível pelo homem do recurso que transmite as informações clínicas e comerciais essenciais para o recurso. |
PractitionerRoleBundle
Um pacote de recursos de função do praticante, normalmente usados para fornecer um conjunto completo de resultados de pesquisa ou um subconjunto de recursos em uma lista paginada.
| Nome | 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 desse 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 deve ser compreendida ao processar o conteúdo. |
|
Linguagem
|
language | string |
A linguagem base na qual o recurso é gravado. |
|
Link
|
link | array of BundleLink |
Uma série de links que fornecem contexto para esse 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 junto com outros recursos. |
|
assinatura
|
signature | Signature |
Uma assinatura digital, juntamente com contexto e metadados de suporte. |
|
Timestamp
|
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 em um pacote do tipo 'PractitionerRole' que contém informações sobre a função de um praticante.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Extension
|
extension | array of object |
Informações adicionais ou metadados sobre a entrada. |
|
items
|
extension | object | |
|
URL completa
|
fullUrl | string |
A URL completa do recurso na entrada. |
|
ID
|
id | string |
Identificador exclusivo para a entrada. |
|
Link
|
link | array of BundleLink |
Links relacionados a essa entrada. |
|
Extensão do modificador
|
modifierExtension | array of object |
Informações adicionais ou metadados sobre a entrada. |
|
items
|
modifierExtension | object | |
|
solicitação
|
request | Request |
Um recurso de solicitação dentro de um pacote. |
|
recurso
|
resource | PractitionerRole |
Define a função 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. |
|
busca
|
search | Search |
Um recurso que representa uma operação de pesquisa ou uma funcionalidade de pesquisa. |
Solicitação
Um recurso de solicitação dentro de um pacote.
| Nome | 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.
| Nome | 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.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
object |
Um recurso de resposta dentro de um pacote. |
Pesquisa
Um recurso que representa uma operação de pesquisa ou uma funcionalidade de pesquisa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
object |
Um recurso que representa uma operação de pesquisa ou uma funcionalidade de pesquisa. |
Signature
Uma assinatura digital, juntamente com contexto e metadados de suporte.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | string |
O conteúdo da assinatura codificada em base64. |
|
Extension
|
extension | array of object |
Informações adicionais definidas por implementações. |
|
items
|
extension | object | |
|
ID
|
id | string |
O identificador exclusivo dessa assinatura. |
|
Em nome de
|
onBehalfOf | object |
O partido representado por esta assinatura. |
|
Formato de 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. |
|
When
|
when | string |
Quando a assinatura foi criada. |
|
Quem
|
who | object |
Para quem esta assinatura foi feita. |