Hl7Store
A Hl7V2Store is a datastore inside a Healthcare dataset that conforms to the FHIR (https://www.hl7.org/hl7V2/STU3/) standard for Healthcare information exchange
To get more information about Hl7V2Store, see:
- API documentation
- How-to Guides
Create a Hl7Store Resource
new Hl7Store(name: string, args: Hl7StoreArgs, opts?: CustomResourceOptions);def Hl7Store(resource_name, opts=None, dataset=None, labels=None, name=None, notification_config=None, notification_configs=None, parser_config=None, __props__=None);func NewHl7Store(ctx *Context, name string, args Hl7StoreArgs, opts ...ResourceOption) (*Hl7Store, error)public Hl7Store(string name, Hl7StoreArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args Hl7StoreArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args Hl7StoreArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args Hl7StoreArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
Hl7Store Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The Hl7Store resource accepts the following input properties:
- Dataset string
Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
- Labels Dictionary<string, string>
User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- Name string
The resource name for the Hl7V2Store. ** Changing this property may recreate the Hl7v2 store (removing all data) **
- Notification
Config Hl7StoreNotification Config Args - (Optional, Deprecated) A nested object resource Structure is documented below.
- Notification
Configs List<Hl7StoreNotification Configs Args> A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. Structure is documented below.
- Parser
Config Hl7StoreParser Config Args A nested object resource Structure is documented below.
- Dataset string
Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
- Labels map[string]string
User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- Name string
The resource name for the Hl7V2Store. ** Changing this property may recreate the Hl7v2 store (removing all data) **
- Notification
Config Hl7StoreNotification Config - (Optional, Deprecated) A nested object resource Structure is documented below.
- Notification
Configs []Hl7StoreNotification Configs A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. Structure is documented below.
- Parser
Config Hl7StoreParser Config A nested object resource Structure is documented below.
- dataset string
Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
- labels {[key: string]: string}
User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- name string
The resource name for the Hl7V2Store. ** Changing this property may recreate the Hl7v2 store (removing all data) **
- notification
Config Hl7StoreNotification Config - (Optional, Deprecated) A nested object resource Structure is documented below.
- notification
Configs Hl7StoreNotification Configs[] A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. Structure is documented below.
- parser
Config Hl7StoreParser Config A nested object resource Structure is documented below.
- dataset str
Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
- labels Dict[str, str]
User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- name str
The resource name for the Hl7V2Store. ** Changing this property may recreate the Hl7v2 store (removing all data) **
- notification_
config Dict[Hl7StoreNotification Config] - (Optional, Deprecated) A nested object resource Structure is documented below.
- notification_
configs List[Hl7StoreNotification Configs] A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. Structure is documented below.
- parser_
config Dict[Hl7StoreParser Config] A nested object resource Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Hl7Store resource produces the following output properties:
Look up an Existing Hl7Store Resource
Get an existing Hl7Store resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: Hl7StoreState, opts?: CustomResourceOptions): Hl7Storestatic get(resource_name, id, opts=None, dataset=None, labels=None, name=None, notification_config=None, notification_configs=None, parser_config=None, self_link=None, __props__=None);func GetHl7Store(ctx *Context, name string, id IDInput, state *Hl7StoreState, opts ...ResourceOption) (*Hl7Store, error)public static Hl7Store Get(string name, Input<string> id, Hl7StoreState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Dataset string
Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
- Labels Dictionary<string, string>
User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- Name string
The resource name for the Hl7V2Store. ** Changing this property may recreate the Hl7v2 store (removing all data) **
- Notification
Config Hl7StoreNotification Config Args - (Optional, Deprecated) A nested object resource Structure is documented below.
- Notification
Configs List<Hl7StoreNotification Configs Args> A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. Structure is documented below.
- Parser
Config Hl7StoreParser Config Args A nested object resource Structure is documented below.
- Self
Link string The fully qualified name of this dataset
- Dataset string
Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
- Labels map[string]string
User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- Name string
The resource name for the Hl7V2Store. ** Changing this property may recreate the Hl7v2 store (removing all data) **
- Notification
Config Hl7StoreNotification Config - (Optional, Deprecated) A nested object resource Structure is documented below.
- Notification
Configs []Hl7StoreNotification Configs A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. Structure is documented below.
- Parser
Config Hl7StoreParser Config A nested object resource Structure is documented below.
- Self
Link string The fully qualified name of this dataset
- dataset string
Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
- labels {[key: string]: string}
User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- name string
The resource name for the Hl7V2Store. ** Changing this property may recreate the Hl7v2 store (removing all data) **
- notification
Config Hl7StoreNotification Config - (Optional, Deprecated) A nested object resource Structure is documented below.
- notification
Configs Hl7StoreNotification Configs[] A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. Structure is documented below.
- parser
Config Hl7StoreParser Config A nested object resource Structure is documented below.
- self
Link string The fully qualified name of this dataset
- dataset str
Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
- labels Dict[str, str]
User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- name str
The resource name for the Hl7V2Store. ** Changing this property may recreate the Hl7v2 store (removing all data) **
- notification_
config Dict[Hl7StoreNotification Config] - (Optional, Deprecated) A nested object resource Structure is documented below.
- notification_
configs List[Hl7StoreNotification Configs] A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. Structure is documented below.
- parser_
config Dict[Hl7StoreParser Config] A nested object resource Structure is documented below.
- self_
link str The fully qualified name of this dataset
Supporting Types
Hl7StoreNotificationConfig
- Pubsub
Topic string The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- Pubsub
Topic string The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- pubsub
Topic string The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- pubsub
Topic str The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
Hl7StoreNotificationConfigs
- Pubsub
Topic string The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- Filter string
Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * messageType, from the MSH-9.1 field. For example, NOT messageType = “ADT”. * send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset’s timeZone, from the MSH-7 segment. For example, send_date < “2017-01-02”. * sendTime, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, sendTime < “2017-01-02T00:00:00-05:00”. * sendFacility, the care center that the message came from, from the MSH-4 segment. For example, sendFacility = “ABC”. * PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, PatientId(“123456”, “MRN”). * labels.x, a string value of the label with key x as set using the Message.labels map. For example, labels.“priority”=“high”. The operator :* can be used to assert the existence of a label. For example, labels.“priority”:*.
- Pubsub
Topic string The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- Filter string
Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * messageType, from the MSH-9.1 field. For example, NOT messageType = “ADT”. * send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset’s timeZone, from the MSH-7 segment. For example, send_date < “2017-01-02”. * sendTime, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, sendTime < “2017-01-02T00:00:00-05:00”. * sendFacility, the care center that the message came from, from the MSH-4 segment. For example, sendFacility = “ABC”. * PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, PatientId(“123456”, “MRN”). * labels.x, a string value of the label with key x as set using the Message.labels map. For example, labels.“priority”=“high”. The operator :* can be used to assert the existence of a label. For example, labels.“priority”:*.
- pubsub
Topic string The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- filter string
Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * messageType, from the MSH-9.1 field. For example, NOT messageType = “ADT”. * send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset’s timeZone, from the MSH-7 segment. For example, send_date < “2017-01-02”. * sendTime, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, sendTime < “2017-01-02T00:00:00-05:00”. * sendFacility, the care center that the message came from, from the MSH-4 segment. For example, sendFacility = “ABC”. * PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, PatientId(“123456”, “MRN”). * labels.x, a string value of the label with key x as set using the Message.labels map. For example, labels.“priority”=“high”. The operator :* can be used to assert the existence of a label. For example, labels.“priority”:*.
- pubsub
Topic str The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- filter str
Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * messageType, from the MSH-9.1 field. For example, NOT messageType = “ADT”. * send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset’s timeZone, from the MSH-7 segment. For example, send_date < “2017-01-02”. * sendTime, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, sendTime < “2017-01-02T00:00:00-05:00”. * sendFacility, the care center that the message came from, from the MSH-4 segment. For example, sendFacility = “ABC”. * PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, PatientId(“123456”, “MRN”). * labels.x, a string value of the label with key x as set using the Message.labels map. For example, labels.“priority”=“high”. The operator :* can be used to assert the existence of a label. For example, labels.“priority”:*.
Hl7StoreParserConfig
- Allow
Null boolHeader Determines whether messages with no header are allowed.
- Schema string
JSON encoded string for schemas used to parse messages in this store if schematized parsing is desired.
- Segment
Terminator string Byte(s) to be used as the segment terminator. If this is unset, ‘\r’ will be used as segment terminator. A base64-encoded string.
- Allow
Null boolHeader Determines whether messages with no header are allowed.
- Schema string
JSON encoded string for schemas used to parse messages in this store if schematized parsing is desired.
- Segment
Terminator string Byte(s) to be used as the segment terminator. If this is unset, ‘\r’ will be used as segment terminator. A base64-encoded string.
- allow
Null booleanHeader Determines whether messages with no header are allowed.
- schema string
JSON encoded string for schemas used to parse messages in this store if schematized parsing is desired.
- segment
Terminator string Byte(s) to be used as the segment terminator. If this is unset, ‘\r’ will be used as segment terminator. A base64-encoded string.
- allow
Null boolHeader Determines whether messages with no header are allowed.
- schema str
JSON encoded string for schemas used to parse messages in this store if schematized parsing is desired.
- segment
Terminator str Byte(s) to be used as the segment terminator. If this is unset, ‘\r’ will be used as segment terminator. A base64-encoded string.
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.