Esta página explica como criar, editar, ver e eliminar lojas Health Level Seven Version 2.x (HL7v2). Os armazenamentos de HL7v2 contêm mensagens HL7v2, que são usadas para transmitir dados clínicos entre sistemas.
Criar um armazenamento de HL7v2
Antes de poder criar um armazenamento de HL7v2, tem de criar um conjunto de dados.
Ao criar um armazenamento de HL7v2, especifique a versão do analisador.V3
Não é possível alterar a versão do analisador após criar a loja HL7v2.
Os exemplos seguintes mostram como criar um armazenamento HL7v2 através do analisador V3.
Consola
Na Google Cloud consola, aceda à página Conjuntos de dados.
Selecione o conjunto de dados onde quer criar o armazenamento de HL7v2. É apresentada a página Conjunto de dados.
Clique em add_box Criar arquivo de dados. É apresentada a página Criar arquivo de dados.
No menu Tipo, selecione HL7v2.
No campo ID, introduza um nome para o armazenamento de HL7v2. O nome tem de ser exclusivo no conjunto de dados. Consulte os carateres permitidos e os requisitos de tamanho para ver mais requisitos de nomenclatura.
Clicar em Seguinte. A secção Configure o seu armazenamento de HL7v2 é apresentada.
Configure as seguintes definições:
- Na secção Versão, deixe a seleção predefinida V3 inalterada.
- Para permitir a criação e a carregamento de mensagens HL7v2 sem cabeçalho, selecione Permitir cabeçalhos de mensagens nulos (MSH).
- Para definir um terminador de segmento personalizado, clique em Definir um terminador de segmento personalizado e introduza o terminador no campo Terminador de segmento. Para mais informações, consulte o artigo Definir o terminador de segmentos.
- Para rejeitar mensagens HL7v2 recebidas com os mesmos bytes não processados que uma mensagem HL7v2 que já existe no armazenamento de HL7v2, selecione Rejeitar mensagens duplicadas.
Clicar em Seguinte. A secção Receber notificações do Cloud Pub/Sub é apresentada.
Se quiser receber notificações do Pub/Sub quando ocorrer um evento clínico na sua loja HL7v2, especifique o tópico do Pub/Sub. O tópico tem de existir antes de o poder configurar no armazenamento HL7v2.
Clicar em Seguinte. A secção Adicione etiquetas para organizar os seus repositórios de dados é apresentada.
Para adicionar uma ou mais etiquetas de chave/valor ao arquivo HL7v2, clique em add Adicionar etiqueta. Para mais informações sobre etiquetas de recursos, consulte o artigo Usar etiquetas de recursos.
Clique em Criar. É apresentada a página Conjunto de dados e o armazenamento de HL7v2 é apresentado na tabela Armazenamentos de dados.
gcloud
Para criar um armazenamento de HL7v2, execute o comando gcloud healthcare hl7v2-stores create
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
PROJECT_ID
: o ID do seu Google Cloud projetoLOCATION
: a localização do conjunto de dadosDATASET_ID
: o conjunto de dados principal do armazenamento de HL7v2HL7V2_STORE_ID
: um identificador para o armazenamento de HL7v2 sujeito aos requisitos de carateres e tamanho do armazenamento de 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
Deve receber uma resposta semelhante à seguinte:
Resposta
Created hl7V2Store [HL7V2_STORE_ID].
REST
Para criar um armazenamento HL7v2, use o método
projects.locations.datasets.hl7V2Stores.create
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
PROJECT_ID
: o ID do seu Google Cloud projetoLOCATION
: a localização do conjunto de dadosDATASET_ID
: o conjunto de dados principal do armazenamento de HL7v2HL7V2_STORE_ID
: um identificador para o armazenamento de HL7v2 sujeito aos requisitos de carateres e tamanho do armazenamento de HL7v2
Corpo JSON do pedido:
{ "parserConfig": { "version": "V3" } }
Para enviar o seu pedido, escolha uma destas opções:
curl
Guarde o corpo do pedido num ficheiro denominado request.json
.
Execute o seguinte comando no terminal para criar ou substituir
este ficheiro no diretório atual:
cat > request.json << 'EOF' { "parserConfig": { "version": "V3" } } EOF
Em seguida, execute o seguinte comando para enviar o seu pedido 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
Guarde o corpo do pedido num ficheiro denominado request.json
.
Execute o seguinte comando no terminal para criar ou substituir
este ficheiro no diretório atual:
@' { "parserConfig": { "version": "V3" } } '@ | Out-File -FilePath request.json -Encoding utf8
Em seguida, execute o seguinte comando para enviar o seu pedido 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
Explorador de APIs
Copie o corpo do pedido e abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Cole o corpo do pedido nesta ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.
Deve receber uma resposta JSON semelhante à seguinte:
Go
Java
Node.js
Python
Use tópicos e filtros do Pub/Sub
A utilização do Pub/Sub e de filtros com arquivos HL7v2 é um exemplo de utilização comum, especialmente quando transmite mensagens HL7v2 através de ligações TCP/IP.
Alguns dos exemplos nesta página mostram como configurar um tópico do Pub/Sub existente para o qual a Cloud Healthcare API envia notificações de eventos clínicos numa loja HL7v2. Ao especificar uma lista de tópicos e filtros do Pub/Sub existentes, a Cloud Healthcare API pode enviar notificações para vários tópicos, e pode usar os filtros para restringir as notificações que são enviadas. Para mais informações sobre como configurar tópicos e filtros do Pub/Sub, consulte os artigos Notificações HL7v2 e Ver notificações HL7v2.
Editar um armazenamento de HL7v2
Os exemplos seguintes mostram como editar a lista de tópicos e filtros do Pub/Sub que a Cloud Healthcare API usa para enviar notificações de alterações da loja HL7v2.
Vários exemplos também mostram como editar as etiquetas no armazenamento de HL7v2.
Quando especificar um tópico do Pub/Sub, introduza o URI qualificado para o tópico, conforme mostrado no exemplo seguinte:projects/PROJECT_ID/topics/PUBSUB_TOPIC
Consola
Para editar um arquivo de dados HL7v2, conclua os passos seguintes:
- Na Google Cloud consola, aceda à página Conjuntos de dados.
- Selecione o conjunto de dados que contém o armazenamento de HL7v2 que quer editar.
- Na lista Armazenamentos de dados, clique no armazenamento de dados que quer editar.
- Para editar a configuração do armazenamento de HL7v2, clique em Configuração do armazenamento de HL7v2.
Para mais informações sobre as opções de configuração do armazenamento de HL7v2, consulte o artigo Criar um armazenamento de HL7v2. - Se quiser configurar um tópico do Pub/Sub para o arquivo de dados, clique em Adicionar tópico do Pub/Sub e selecione o nome do tópico. Quando especificar um tópico do Pub/Sub, introduza o URI qualificado para o tópico, conforme mostrado no exemplo seguinte:
projects/PROJECT_ID/topics/PUBSUB_TOPIC
- Se adicionou um tópico do Pub/Sub, clique em Concluído.
- Para adicionar uma ou mais etiquetas à loja, clique em Usar etiquetas de recursos. Etiquetas, clique em Adicionar etiqueta e introduza a etiqueta de chave/valor. Para mais informações sobre etiquetas de recursos, consulte o artigo
- Clique em Guardar.
gcloud
A CLI gcloud não suporta esta ação. Em alternativa, use a Google Cloud consolacurl
, o PowerShell ou o seu idioma preferido.
REST
Para editar um armazenamento de HL7v2, use o método projects.locations.datasets.hl7V2Stores.patch
.
Antes de executar os seguintes exemplos, tem de criar, pelo menos, um tópico do Pub/Sub no seu projeto.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de HL7v2
- HL7V2_STORE_ID: o ID do armazenamento de HL7v2
- PUBSUB_TOPIC1: um tópico do Pub/Sub para o qual as mensagens são publicadas quando ocorre um evento num repositório de dados
- FILTER1: uma string usada para fazer corresponder mensagens publicadas em PUBSUB_TOPIC1
Consulte
filter
para ver exemplos de valores de filtros válidos. - PUBSUB_TOPIC2: um tópico do Pub/Sub para o qual as mensagens são publicadas
- FILTER2: uma string usada para fazer corresponder mensagens publicadas em PUBSUB_TOPIC2
- KEY1: a primeira chave de etiqueta
- VALUE1: o primeiro valor da etiqueta
- KEY2: a segunda chave da etiqueta
- VALUE2: o valor da segunda etiqueta
Corpo JSON do pedido:
{ '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 o seu pedido, escolha uma destas opções:
curl
Guarde o corpo do pedido num ficheiro denominado request.json
.
Execute o seguinte comando no terminal para criar ou substituir
este ficheiro 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
Em seguida, execute o seguinte comando para enviar o seu pedido 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
Guarde o corpo do pedido num ficheiro denominado request.json
.
Execute o seguinte comando no terminal para criar ou substituir
este ficheiro 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
Em seguida, execute o seguinte comando para enviar o seu pedido 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
Explorador de APIs
Copie o corpo do pedido e abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Cole o corpo do pedido nesta ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.
Deve receber uma resposta JSON semelhante à seguinte:
Go
Java
Node.js
Python
Obter detalhes do armazenamento de HL7v2
Os exemplos seguintes mostram como obter detalhes sobre um armazenamento de HL7v2.
Consola
Para ver os detalhes de um armazenamento de HL7v2:
- Na Google Cloud consola, aceda à página Conjuntos de dados.
- Selecione o conjunto de dados que contém o armazenamento de HL7v2 que quer ver.
- Clique no nome do armazenamento de HL7v2.
A página Detalhes do Datastore apresenta os detalhes do armazenamento de HL7v2 selecionado.
gcloud
Para obter detalhes sobre um armazenamento HL7v2, execute o comando gcloud healthcare hl7v2-stores describe
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de HL7v2
- HL7V2_STORE_ID: o ID do armazenamento de 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
Deve receber uma resposta semelhante à seguinte.
Se configurou campos no recurso Hl7V2Store
, estes também aparecem na resposta.
Resposta
... name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID ...
REST
Para obter detalhes sobre um armazenamento de HL7v2, use o método projects.locations.datasets.hl7V2Stores.get
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de HL7v2
- HL7V2_STORE_ID: o ID do armazenamento de HL7v2
Para enviar o seu pedido, 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
Explorador de APIs
Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Preencha todos os campos obrigatórios e clique em Executar.
Deve receber uma resposta semelhante à seguinte.
Se configurou campos no recurso Hl7V2Store
, estes também aparecem na resposta.
Go
Java
Node.js
Python
Apresentar em lista os armazenamentos de HL7v2 num conjunto de dados
Os exemplos seguintes mostram como listar os armazenamentos de HL7v2 num conjunto de dados.
Consola
Para ver os arquivos de dados num conjunto de dados:
- Na Google Cloud consola, aceda à página Conjuntos de dados.
- Selecione o conjunto de dados que contém o arquivo de dados que quer ver.
gcloud
Para apresentar em lista os armazenamentos de HL7v2 num conjunto de dados, execute o comando gcloud healthcare hl7v2-stores list
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de 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
Deve receber uma resposta semelhante à seguinte.
Se configurou campos no recurso Hl7V2Store
, estes também aparecem na resposta.
ID LOCATION TOPIC HL7V2_STORE_ID LOCATION projects/PROJECT_ID/topics/PUBSUB_TOPIC PUBSUB_TOPIC ...
REST
Para listar os armazenamentos de HL7v2 num conjunto de dados, use o método projects.locations.datasets.hl7V2Stores.list
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de HL7v2
Para enviar o seu pedido, 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
Explorador de APIs
Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Preencha todos os campos obrigatórios e clique em Executar.
Deve receber uma resposta semelhante à seguinte.
Se configurou campos no recurso Hl7V2Store
, estes também aparecem na resposta.
Go
Java
Node.js
Python
Eliminar um armazenamento de HL7v2
Os exemplos seguintes mostram como eliminar um armazenamento de HL7v2.
Consola
Para eliminar um arquivo de dados:
- Na Google Cloud consola, aceda à página Conjuntos de dados.
- Selecione o conjunto de dados que contém o arquivo de dados que quer eliminar.
- Escolha Eliminar na lista pendente Ações para o arquivo de dados que quer eliminar.
- Para confirmar, escreva o nome do arquivo de dados e, de seguida, clique em Eliminar.
gcloud
Para eliminar um armazenamento de HL7v2, execute o comando gcloud healthcare hl7v2-stores delete
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de HL7v2
- HL7V2_STORE_ID: o ID do armazenamento de 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 eliminar um armazenamento de HL7v2, use o método projects.locations.datasets.hl7V2Stores.delete
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de HL7v2
- HL7V2_STORE_ID: o ID do armazenamento de HL7v2
Para enviar o seu pedido, 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
Explorador de APIs
Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Preencha todos os campos obrigatórios e clique em Executar.
Go
Java
Node.js
Python
O que se segue?
- Leia a documentação conceptual sobre como o HL7v2 é implementado na Cloud Healthcare API.
- Saiba como criar e gerir mensagens HL7v2.