gcp-healthcare-hl7v2-store

Health Level Seven International Version 2 (HL7v2) is a clinical messaging format that provides data about events that occur inside an organization.

---

Design

For detailed information, check out our Operator Guide for this bundle.

Usage

Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the Massdriver platform.

What are Bundles?

Bundles are the basic building blocks of infrastructure, applications, and architectures in Massdriver. Read more here.

Bundle

Params

Form input parameters for configuring a bundle for deployment.

View

Properties

• parser (object)
  • allow_null_header (boolean): If checked, messages with no header are allowed. For more information view the documentation. Default: False.
  • enable_custom_segment_terminator (boolean): The HL7v2 message format requires that segments be terminated using the return character \r``, but you can configure the HL7v2 store to accept HL7v2 messages with a non-standard terminator. For more information view [the documentation](https://cloud.google.com/healthcare-api/docs/how-tos/hl7v2-messages#setting_the_segment_terminator). Default: False`.

Connections

Connections from other bundles that this bundle depends on.

View

Properties

• dataset (object): GCP Healthcare Dataset.

  • data (object)

    • infrastructure (object): Minimal GCP Infrastructure Config. Cannot contain additional properties.

      • grn (string): GCP Resource Name (GRN).

        Examples:

        "projects/my-project/global/networks/my-global-network"

        "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"

        "projects/my-project/topics/my-pubsub-topic"

        "projects/my-project/subscriptions/my-pubsub-subscription"

        "projects/my-project/locations/us-west2/instances/my-redis-instance"

        "projects/my-project/locations/us-west2/clusters/my-gke-cluster"

    • security (object): GCP Security Configuration. Cannot contain additional properties.

      • iam (object): IAM Roles And Conditions. Cannot contain additional properties.
        • ^[a-z]+[a-z_]*[a-z]$ (object)

          • condition (string): GCP IAM Condition.

          • role: GCP Role.

            Examples:

            "roles/owner"

            "roles/redis.editor"

            "roles/storage.objectCreator"

            "roles/storage.legacyObjectReader"

  • specs (object)

    • gcp (object): .

      • project (string)

      • region (string): The GCP region to provision resources in.

        Examples:

        "us-east1"

        "us-east4"

        "us-west1"

        "us-west2"

        "us-west3"

        "us-west4"

        "us-central1"

• gcp_authentication (object): GCP Service Account. Cannot contain additional properties.

  • data (object)

    • auth_provider_x509_cert_url (string): Auth Provider x509 Certificate URL. Default: https://www.googleapis.com/oauth2/v1/certs.

      Examples:

      "https://example.com/some/path"

      "https://massdriver.cloud"

    • auth_uri (string): Auth URI. Default: https://accounts.google.com/o/oauth2/auth.

      Examples:

      "https://example.com/some/path"

      "https://massdriver.cloud"

    • client_email (string): Service Account Email.

      Examples:

      "[email protected]"

      "[email protected]"

    • client_id (string): .

    • client_x509_cert_url (string): Client x509 Certificate URL.

      Examples:

      "https://example.com/some/path"

      "https://massdriver.cloud"

    • private_key (string): .

    • private_key_id (string): .

    • project_id (string): .

    • token_uri (string): Token URI. Default: https://oauth2.googleapis.com/token.

      Examples:

      "https://example.com/some/path"

      "https://massdriver.cloud"

    • type (string): . Default: service_account.

  • specs (object)
    • gcp (object): .

      • project (string)

      • region (string): The GCP region to provision resources in.

        Examples:

        "us-east1"

        "us-east4"

        "us-west1"

        "us-west2"

        "us-west3"

        "us-west4"

        "us-central1"

• pubsub_topic (object): GCP PubSub Topic. Cannot contain additional properties.

  • data (object): Cannot contain additional properties.

    • infrastructure (object): PubSub topic configuration. Cannot contain additional properties.

      • grn (string): GCP Resource Name (GRN).

        Examples:

        "projects/my-project/global/networks/my-global-network"

        "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"

        "projects/my-project/topics/my-pubsub-topic"

        "projects/my-project/subscriptions/my-pubsub-subscription"

        "projects/my-project/locations/us-west2/instances/my-redis-instance"

        "projects/my-project/locations/us-west2/clusters/my-gke-cluster"

    • security (object): GCP Security Configuration. Cannot contain additional properties.

      • iam (object): IAM Roles And Conditions. Cannot contain additional properties.
        • ^[a-z]+[a-z_]*[a-z]$ (object)

          • condition (string): GCP IAM Condition.

          • role: GCP Role.

            Examples:

            "roles/owner"

            "roles/redis.editor"

            "roles/storage.objectCreator"

            "roles/storage.legacyObjectReader"

  • specs (object)

    • topic (object): . Cannot contain additional properties.
      • distribution (string): Must be one of: ['pubsub'].

Artifacts

Resources created by this bundle that can be connected to other bundles.

View

Properties

• hl7v2_store (object): GCP Healthcare HL7v2 Store.

  • data (object)

    • infrastructure (object): Minimal GCP Infrastructure Config. Cannot contain additional properties.

      • grn (string): GCP Resource Name (GRN).

        Examples:

        "projects/my-project/global/networks/my-global-network"

        "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"

        "projects/my-project/topics/my-pubsub-topic"

        "projects/my-project/subscriptions/my-pubsub-subscription"

        "projects/my-project/locations/us-west2/instances/my-redis-instance"

        "projects/my-project/locations/us-west2/clusters/my-gke-cluster"

    • security (object): GCP Security Configuration. Cannot contain additional properties.

      • iam (object): IAM Roles And Conditions. Cannot contain additional properties.
        • ^[a-z]+[a-z_]*[a-z]$ (object)

          • condition (string): GCP IAM Condition.

          • role: GCP Role.

            Examples:

            "roles/owner"

            "roles/redis.editor"

            "roles/storage.objectCreator"

            "roles/storage.legacyObjectReader"

  • specs (object)

    • gcp (object): .

      • project (string)

      • region (string): The GCP region to provision resources in.

        Examples:

        "us-east1"

        "us-east4"

        "us-west1"

        "us-west2"

        "us-west3"

        "us-west4"

        "us-central1"

Contributing

Bug Reports & Feature Requests

Did we miss something? Please submit an issue to report any bugs or request additional features.

Developing

Note: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the Massdriver platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.

Still want to get involved? First check out our contribution guidelines.

Fix or Fork

If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or create your own bundle from scratch!

Connect

Questions? Concerns? Adulations? We'd love to hear from you!

Please connect with us!