Nesta página, explicamos como criar, editar, visualizar e excluir armazenamentos de Health Level Seven Versão 2.x (HL7v2). Os armazenamentos HL7v2 contêm mensagens HL7v2, que são usadas para transmitir dados clínicos entre sistemas.
Como criar um armazenamento HL7v2
Antes de criar um armazenamento HL7v2, você precisa criar um conjunto de dados.
Ao criar um armazenamento HL7v2, especifique a versão do analisador V3
. Não é possível mudar a versão do analisador depois de criar o armazenamento HL7v2.
Os exemplos a seguir mostram como criar um armazenamento HL7v2 usando o analisador V3.
Console
No console do Google Cloud, acesse a página Conjuntos de dados.
Selecione o conjunto de dados em que você quer criar o armazenamento HL7v2. A página Conjunto de dados é exibida.
Clique em add_box Criar repositório de dados. A página Criar repositório de dados é exibida.
No menu Tipo, selecione HL7v2.
No campo ID, insira um nome para o armazenamento HL7v2. O nome precisa ser exclusivo no conjunto de dados. Consulte Requisitos de caracteres e tamanho permitidos para mais requisitos de nomenclatura.
Clique em Próxima. A seção Configure your HL7v2 store é exibida.
Defina as configurações a seguir:
- Na seção Versão, não altere a seleção padrão V3.
- Para permitir a criação e a ingestão de mensagens HL7v2 sem cabeçalho, selecione Permitir cabeçalhos de mensagem nulos (MSH).
- Para definir um terminador de segmento personalizado, clique em Definir um terminador de segmento personalizado e insira o terminador no campo Terminador de segmento. Para mais informações, consulte Como definir o terminador de segmento.
- Para rejeitar mensagens HL7v2 recebidas com os mesmos bytes brutos de uma mensagem HL7v2 que já existe no armazenamento HL7v2, selecione Rejeitar mensagens duplicadas.
Clique em Próxima. A seção Receber notificações do Cloud Pub/Sub é exibida.
Se você quiser receber notificações do Pub/Sub quando um evento clínico ocorrer na sua loja HL7v2, especifique o tópico do Pub/Sub. O tópico precisa existir antes de ser configurado na loja HL7v2.
Clique em Próxima. A seção Adicionar rótulos para organizar seus repositórios de dados é mostrada.
Para adicionar um ou mais rótulos de chave/valor à loja HL7v2, clique em add Adicionar rótulo. Saiba mais sobre rótulos de recursos em Como usar rótulos de recursos.
Clique em Criar. A página Dataset é mostrada, e o armazenamento HL7v2 é exibido na tabela Armazenamentos de dados.
gcloud
Para criar um armazenamento HL7v2, execute o comando gcloud healthcare hl7v2-stores create
.
Antes de usar os dados do comando abaixo, faça estas substituições:
PROJECT_ID
: o ID do seu projeto do Google Cloud;LOCATION
: o local do conjunto de dados;DATASET_ID
: o conjunto de dados pai da loja HL7v2HL7V2_STORE_ID
: um identificador para o armazenamento HL7v2 sujeito aos requisitos de tamanho e caracteres do armazenamento HL7v2.
Execute o seguinte comando:
Linux, macOS ou Cloud Shell
gcloud healthcare hl7v2-stores create HL7V2_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION \ --parser-version=v3
Windows (PowerShell)
gcloud healthcare hl7v2-stores create HL7V2_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION ` --parser-version=v3
Windows (cmd.exe)
gcloud healthcare hl7v2-stores create HL7V2_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION ^ --parser-version=v3
Você receberá uma resposta semelhante a esta:
Resposta
Created hl7V2Store [HL7V2_STORE_ID].
REST
Para criar um armazenamento HL7v2, use o
método projects.locations.datasets.hl7V2Stores.create
.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
PROJECT_ID
: o ID do seu projeto do Google Cloud;LOCATION
: o local do conjunto de dados;DATASET_ID
: o conjunto de dados pai da loja HL7v2HL7V2_STORE_ID
: um identificador para o armazenamento HL7v2 sujeito aos requisitos de tamanho e caracteres do armazenamento HL7v2.
Corpo JSON da solicitação:
{ "parserConfig": { "version": "V3" } }
Para enviar a solicitação, escolha uma destas opções:
curl
Salve o corpo da solicitação em um arquivo chamado request.json
.
Execute o comando a seguir no terminal para criar ou substituir
esse arquivo no diretório atual:
cat > request.json << 'EOF' { "parserConfig": { "version": "V3" } } EOF
Depois execute o comando a seguir para enviar a solicitação REST:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores?hl7V2StoreId=HL7V2_STORE_ID"
PowerShell
Salve o corpo da solicitação em um arquivo chamado request.json
.
Execute o comando a seguir no terminal para criar ou substituir
esse arquivo no diretório atual:
@' { "parserConfig": { "version": "V3" } } '@ | Out-File -FilePath request.json -Encoding utf8
Depois execute o comando a seguir para enviar a solicitação REST:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores?hl7V2StoreId=HL7V2_STORE_ID" | Select-Object -Expand Content
APIs Explorer
Copie o corpo da solicitação e abra a página de referência do método. O painel "APIs Explorer" é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Cole o corpo da solicitação nessa ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.
Você receberá uma resposta JSON semelhante a esta:
Go
Java
Node.js
Python
Usar tópicos e filtros do Pub/Sub
O uso do Pub/Sub e dos filtros com armazenamentos HL7v2 é um caso de uso comum, principalmente ao transmitir mensagens HL7v2 por conexões TCP/IP.
Alguns dos exemplos nesta página mostram como configurar um tópico do Pub/Sub para que a API Cloud Healthcare envie notificações de eventos clínicos em uma loja HL7v2. Ao especificar uma lista de tópicos e filtros do Pub/Sub, a API Cloud Healthcare pode enviar notificações para vários tópicos, e você pode usar os filtros para restringir quais notificações são enviadas. Para mais informações sobre como configurar tópicos e filtros do Pub/Sub, consulte Notificações do HL7v2 e Conferir notificações do HL7v2.
Como editar um armazenamento HL7v2
Os exemplos a seguir mostram como editar a lista de tópicos e filtros do Pub/Sub que a API Cloud Healthcare usa para enviar notificações de alterações no armazenamento HL7v2.
Vários exemplos também mostram como editar os rótulos na loja HL7v2.
Ao especificar um tópico do Pub/Sub, insira o URI qualificado para o tópico, conforme mostrado no exemplo a seguir:projects/PROJECT_ID/topics/PUBSUB_TOPIC
Console
Para editar um armazenamento HL7v2, conclua as seguintes etapas:
- No console do Google Cloud, acesse a página Conjuntos de dados.
- Selecione o conjunto de dados que contém o armazenamento HL7v2 que você quer editar.
- Na lista Armazenamento de dados, clique no armazenamento de dados que você quer editar.
- Para editar a configuração do armazenamento HL7v2, clique em Configuração do armazenamento HL7v2.
Saiba mais sobre as opções de configuração do armazenamento HL7v2 em Como criar um armazenamento HL7v2. - Se você quiser configurar um tópico do Pub/Sub para o armazenamento de dados, clique em Adicionar tópico do Pub/Sub e selecione o nome do tópico. Ao especificar um tópico do Pub/Sub, insira o URI qualificado para o tópico, conforme mostrado no exemplo a seguir:
projects/PROJECT_ID/topics/PUBSUB_TOPIC
- Se você adicionou um tópico do Pub/Sub, clique em Concluído.
- Para adicionar um ou mais rótulos ao armazenamento, clique em Como usar rótulos de recursos. Rótulos, clique em Adicionar rótulo e insira o rótulo de chave/valor. Saiba mais sobre rótulos de recursos em
- Clique em Salvar.
gcloud
A CLI gcloud não oferece suporte a essa ação. Em vez disso, use o console do Google Cloud, curl
, PowerShell ou o idioma de sua preferência.
REST
Para editar um armazenamento HL7v2, use o método projects.locations.datasets.hl7V2Stores.patch
.
Antes de executar os exemplos a seguir, crie pelo menos um tópico do Pub/Sub no seu projeto.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: o ID do seu projeto do Google Cloud;
- LOCATION: o local do conjunto de dados;
- DATASET_ID: o conjunto de dados pai da loja HL7v2
- HL7V2_STORE_ID: o ID do repositório HL7v2
- PUBSUB_TOPIC1: um tópico do Pub/Sub em que as mensagens são publicadas quando um evento ocorre em um repositório de dados
- FILTER1: uma string usada para corresponder às mensagens publicadas em PUBSUB_TOPIC1
Consulte
filter
para conferir exemplos de valores de filtro válidos. - PUBSUB_TOPIC2: um tópico do Pub/Sub em que as mensagens são publicadas
- FILTER2: uma string usada para corresponder às mensagens publicadas em PUBSUB_TOPIC2
- KEY1: a primeira chave de identificador
- VALUE1: o primeiro valor do rótulo
- KEY2: a segunda chave do rótulo
- VALUE2: o segundo valor do rótulo
Corpo JSON da solicitação:
{ 'notificationConfigs': [ { 'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC1', 'filter' : 'FILTER1' }, { 'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC2', 'filter': 'FILTER2' }, ], 'labels': { 'KEY1':'VALUE1', 'KEY2':'VALUE2' } }
Para enviar a solicitação, escolha uma destas opções:
curl
Salve o corpo da solicitação em um arquivo chamado request.json
.
Execute o comando a seguir no terminal para criar ou substituir
esse arquivo no diretório atual:
cat > request.json << 'EOF' { 'notificationConfigs': [ { 'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC1', 'filter' : 'FILTER1' }, { 'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC2', 'filter': 'FILTER2' }, ], 'labels': { 'KEY1':'VALUE1', 'KEY2':'VALUE2' } } EOF
Depois execute o comando a seguir para enviar a solicitação REST:
curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID?updateMask=notificationConfigs,labels"
PowerShell
Salve o corpo da solicitação em um arquivo chamado request.json
.
Execute o comando a seguir no terminal para criar ou substituir
esse arquivo no diretório atual:
@' { 'notificationConfigs': [ { 'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC1', 'filter' : 'FILTER1' }, { 'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC2', 'filter': 'FILTER2' }, ], 'labels': { 'KEY1':'VALUE1', 'KEY2':'VALUE2' } } '@ | Out-File -FilePath request.json -Encoding utf8
Depois execute o comando a seguir para enviar a solicitação REST:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID?updateMask=notificationConfigs,labels" | Select-Object -Expand Content
APIs Explorer
Copie o corpo da solicitação e abra a página de referência do método. O painel "APIs Explorer" é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Cole o corpo da solicitação nessa ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.
Você receberá uma resposta JSON semelhante a esta:
Go
Java
Node.js
Python
Como conseguir detalhes da loja HL7v2
Os exemplos a seguir mostram como conseguir detalhes sobre uma loja HL7v2.
Console
Para visualizar os detalhes de um armazenamento HL7v2:
- No console do Google Cloud, acesse a página Conjuntos de dados.
- Selecione o conjunto de dados que contém o armazenamento HL7v2 que você quer visualizar.
- Clique no nome do armazenamento HL7v2.
A página Detalhes do repositório de dados mostra os detalhes da loja HL7v2 selecionada.
gcloud
Para conferir detalhes sobre um armazenamento HL7v2, execute o comando gcloud healthcare hl7v2-stores describe
.
Antes de usar os dados do comando abaixo, faça estas substituições:
- LOCATION: o local do conjunto de dados;
- DATASET_ID: o conjunto de dados pai da loja HL7v2
- HL7V2_STORE_ID: o ID do repositório HL7v2
Execute o seguinte comando:
Linux, macOS ou Cloud Shell
gcloud healthcare hl7v2-stores describe HL7V2_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare hl7v2-stores describe HL7V2_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare hl7v2-stores describe HL7V2_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
Você vai receber uma resposta semelhante a esta.
Se você tiver configurado algum campo no recurso Hl7V2Store
, ele também vai aparecer na resposta.
Resposta
... name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID ...
REST
Para ver detalhes sobre um armazenamento HL7v2, use o método projects.locations.datasets.hl7V2Stores.get
.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: o ID do seu projeto do Google Cloud;
- LOCATION: o local do conjunto de dados;
- DATASET_ID: o conjunto de dados pai da loja HL7v2
- HL7V2_STORE_ID: o ID do repositório HL7v2
Para enviar a solicitação, escolha uma destas opções:
curl
execute o seguinte comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID"
PowerShell
Execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID" | Select-Object -Expand Content
APIs Explorer
Abra a página de referência do método. O painel "APIs Explorer" é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Preencha todos os campos obrigatórios e clique em Executar.
Você vai receber uma resposta semelhante a esta.
Se você tiver configurado algum campo no recurso Hl7V2Store
, ele também vai aparecer na resposta.
Go
Java
Node.js
Python
Como listar os armazenamentos HL7v2 em um conjunto de dados
Os exemplos a seguir mostram como listar os armazenamentos HL7v2 em um conjunto de dados.
Console
Para visualizar os armazenamentos de dados em um conjunto de dados:
- No console do Google Cloud, acesse a página Conjuntos de dados.
- Selecione o conjunto de dados que contém o repositório de dados que você quer visualizar.
gcloud
Para listar os armazenamentos HL7v2 em um conjunto de dados, execute o comando gcloud healthcare hl7v2-stores list
.
Antes de usar os dados do comando abaixo, faça estas substituições:
- LOCATION: o local do conjunto de dados;
- DATASET_ID: o conjunto de dados pai da loja HL7v2
Execute o seguinte comando:
Linux, macOS ou Cloud Shell
gcloud healthcare hl7v2-stores list --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare hl7v2-stores list --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare hl7v2-stores list --dataset=DATASET_ID ^ --location=LOCATION
Você vai receber uma resposta semelhante a esta.
Se você tiver configurado algum campo no recurso Hl7V2Store
, ele também vai aparecer na resposta.
ID LOCATION TOPIC HL7V2_STORE_ID LOCATION projects/PROJECT_ID/topics/PUBSUB_TOPIC PUBSUB_TOPIC ...
REST
Para listar os armazenamentos HL7v2 em um conjunto de dados, use o método projects.locations.datasets.hl7V2Stores.list
.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: o ID do seu projeto do Google Cloud;
- LOCATION: o local do conjunto de dados;
- DATASET_ID: o conjunto de dados pai da loja HL7v2
Para enviar a solicitação, escolha uma destas opções:
curl
execute o seguinte comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores"
PowerShell
Execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores" | Select-Object -Expand Content
APIs Explorer
Abra a página de referência do método. O painel "APIs Explorer" é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Preencha todos os campos obrigatórios e clique em Executar.
Você vai receber uma resposta semelhante a esta.
Se você tiver configurado algum campo no recurso Hl7V2Store
, ele também vai aparecer na resposta.
Go
Java
Node.js
Python
Como excluir um armazenamento HL7v2
Os exemplos a seguir mostram como excluir um armazenamento HL7v2.
Console
Para excluir um armazenamento de dados:
- No console do Google Cloud, acesse a página Conjuntos de dados.
- Selecione o conjunto de dados que contém o armazenamento de dados que você quer excluir.
- Escolha Excluir na lista suspensa Ações para o armazenamento de dados que você quer excluir.
- Para confirmar, digite o nome do armazenamento de dados e clique em Excluir.
gcloud
Para excluir um armazenamento HL7v2, execute o comando gcloud healthcare hl7v2-stores delete
.
Antes de usar os dados do comando abaixo, faça estas substituições:
- LOCATION: o local do conjunto de dados;
- DATASET_ID: o conjunto de dados pai da loja HL7v2
- HL7V2_STORE_ID: o ID do repositório HL7v2
Execute o seguinte comando:
Linux, macOS ou Cloud Shell
gcloud healthcare hl7v2-stores delete HL7V2_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare hl7v2-stores delete HL7V2_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare hl7v2-stores delete HL7V2_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
Deleted hl7v2Store [HL7V2_STORE_ID].
REST
Para excluir um armazenamento HL7v2, use o método projects.locations.datasets.hl7V2Stores.delete
.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: o ID do seu projeto do Google Cloud;
- LOCATION: o local do conjunto de dados;
- DATASET_ID: o conjunto de dados pai da loja HL7v2
- HL7V2_STORE_ID: o ID do repositório HL7v2
Para enviar a solicitação, escolha uma destas opções:
curl
execute o seguinte comando:
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID"
PowerShell
Execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID" | Select-Object -Expand Content
APIs Explorer
Abra a página de referência do método. O painel "APIs Explorer" é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Preencha todos os campos obrigatórios e clique em Executar.
Go
Java
Node.js
Python
A seguir
- Leia a documentação conceitual sobre como a HL7v2 é implementada na API Cloud Healthcare.
- Saiba como criar e gerenciar mensagens HL7v2.