1apiVersion: apiextensions.k8s.io/v1
2kind: CustomResourceDefinition
3metadata:
4 annotations:
5 cnrm.cloud.google.com/version: 0.0.0-dev
6 creationTimestamp: null
7 labels:
8 cnrm.cloud.google.com/managed-by-kcc: "true"
9 cnrm.cloud.google.com/stability-level: alpha
10 cnrm.cloud.google.com/system: "true"
11 cnrm.cloud.google.com/tf2crd: "true"
12 name: healthcarefhirstores.healthcare.cnrm.cloud.google.com
13spec:
14 group: healthcare.cnrm.cloud.google.com
15 names:
16 categories:
17 - gcp
18 kind: HealthcareFHIRStore
19 plural: healthcarefhirstores
20 shortNames:
21 - gcphealthcarefhirstore
22 - gcphealthcarefhirstores
23 singular: healthcarefhirstore
24 preserveUnknownFields: false
25 scope: Namespaced
26 versions:
27 - additionalPrinterColumns:
28 - jsonPath: .metadata.creationTimestamp
29 name: Age
30 type: date
31 - description: When 'True', the most recent reconcile of the resource succeeded
32 jsonPath: .status.conditions[?(@.type=='Ready')].status
33 name: Ready
34 type: string
35 - description: The reason for the value in 'Ready'
36 jsonPath: .status.conditions[?(@.type=='Ready')].reason
37 name: Status
38 type: string
39 - description: The last transition time for the value in 'Status'
40 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
41 name: Status Age
42 type: date
43 name: v1alpha1
44 schema:
45 openAPIV3Schema:
46 properties:
47 apiVersion:
48 description: 'apiVersion defines the versioned schema of this representation
49 of an object. Servers should convert recognized schemas to the latest
50 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
51 type: string
52 kind:
53 description: 'kind is a string value representing the REST resource this
54 object represents. Servers may infer this from the endpoint the client
55 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
56 type: string
57 metadata:
58 type: object
59 spec:
60 properties:
61 dataset:
62 description: |-
63 Immutable. Identifies the dataset addressed by this request. Must be in the format
64 'projects/{project}/locations/{location}/datasets/{dataset}'.
65 type: string
66 disableReferentialIntegrity:
67 description: |-
68 Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store
69 creation. The default value is false, meaning that the API will enforce referential integrity and fail the
70 requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API
71 will skip referential integrity check. Consequently, operations that rely on references, such as
72 Patient.get$everything, will not return all the results if broken references exist.
73
74 ** Changing this property may recreate the FHIR store (removing all data) **.
75 type: boolean
76 disableResourceVersioning:
77 description: |-
78 Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation
79 of FHIR store. If set to false, which is the default behavior, all write operations will cause historical
80 versions to be recorded automatically. The historical versions can be fetched through the history APIs, but
81 cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for
82 attempts to read the historical versions.
83
84 ** Changing this property may recreate the FHIR store (removing all data) **.
85 type: boolean
86 enableHistoryImport:
87 description: |-
88 Immutable. Whether to allow the bulk import API to accept history bundles and directly insert historical resource
89 versions into the FHIR store. Importing resource histories creates resource interactions that appear to have
90 occurred in the past, which clients may not want to allow. If set to false, history bundles within an import
91 will fail with an error.
92
93 ** Changing this property may recreate the FHIR store (removing all data) **
94
95 ** This property can be changed manually in the Google Cloud Healthcare admin console without recreating the FHIR store **.
96 type: boolean
97 enableUpdateCreate:
98 description: |-
99 Whether this FHIR store has the updateCreate capability. This determines if the client can use an Update
100 operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through
101 the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit
102 logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient
103 identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub
104 notifications.
105 type: boolean
106 notificationConfig:
107 description: A nested object resource.
108 properties:
109 pubsubTopic:
110 description: |-
111 The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client.
112 PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message.
113 It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message
114 was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a
115 project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given
116 Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
117 type: string
118 required:
119 - pubsubTopic
120 type: object
121 notificationConfigs:
122 description: A list of notifcation configs that configure the notification
123 for every resource mutation in this FHIR store.
124 items:
125 properties:
126 pubsubTopic:
127 description: |-
128 The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client.
129 PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message.
130 It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message
131 was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a
132 project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given
133 Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
134 type: string
135 sendFullResource:
136 description: |-
137 Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation.
138 Note that setting this to true does not guarantee that all resources will be sent in the format of
139 full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be
140 sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether
141 it needs to fetch the full resource as a separate operation.
142 type: boolean
143 required:
144 - pubsubTopic
145 type: object
146 type: array
147 resourceID:
148 description: Immutable. Optional. The name of the resource. Used for
149 creation and acquisition. When unset, the value of `metadata.name`
150 is used as the default.
151 type: string
152 streamConfigs:
153 description: |-
154 A list of streaming configs that configure the destinations of streaming export for every resource mutation in
155 this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next
156 resource mutation is streamed to the new location in addition to the existing ones. When a location is removed
157 from the list, the server stops streaming to that location. Before adding a new config, you must add the required
158 bigquery.dataEditor role to your project's Cloud Healthcare Service Agent service account. Some lag (typically on
159 the order of dozens of seconds) is expected before the results show up in the streaming destination.
160 items:
161 properties:
162 bigqueryDestination:
163 description: |-
164 The destination BigQuery structure that contains both the dataset location and corresponding schema config.
165 The output is organized in one table per resource type. The server reuses the existing tables (if any) that
166 are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given
167 resource type, the server attempts to create one.
168 See the [streaming config reference](https://cloud.google.com/healthcare/docs/reference/rest/v1beta1/projects.locations.datasets.fhirStores#streamconfig) for more details.
169 properties:
170 datasetUri:
171 description: BigQuery URI to a dataset, up to 2000 characters
172 long, in the format bq://projectId.bqDatasetId.
173 type: string
174 schemaConfig:
175 description: The configuration for the exported BigQuery
176 schema.
177 properties:
178 recursiveStructureDepth:
179 description: |-
180 The depth for all recursive structures in the output analytics schema. For example, concept in the CodeSystem
181 resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called
182 concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default
183 value 2. The maximum depth allowed is 5.
184 type: integer
185 schemaType:
186 description: |-
187 Specifies the output schema type.
188 * ANALYTICS: Analytics schema defined by the FHIR community.
189 See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.
190 * ANALYTICS_V2: Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON.
191 * LOSSLESS: A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification. Default value: "ANALYTICS" Possible values: ["ANALYTICS", "ANALYTICS_V2", "LOSSLESS"].
192 type: string
193 required:
194 - recursiveStructureDepth
195 type: object
196 required:
197 - datasetUri
198 - schemaConfig
199 type: object
200 resourceTypes:
201 description: |-
202 Supply a FHIR resource type (such as "Patient" or "Observation"). See
203 https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats
204 an empty list as an intent to stream all the supported resource types in this FHIR store.
205 items:
206 type: string
207 type: array
208 required:
209 - bigqueryDestination
210 type: object
211 type: array
212 version:
213 description: 'Immutable. The FHIR specification version. Default value:
214 "STU3" Possible values: ["DSTU2", "STU3", "R4"].'
215 type: string
216 required:
217 - dataset
218 type: object
219 status:
220 properties:
221 conditions:
222 description: Conditions represent the latest available observation
223 of the resource's current state.
224 items:
225 properties:
226 lastTransitionTime:
227 description: Last time the condition transitioned from one status
228 to another.
229 type: string
230 message:
231 description: Human-readable message indicating details about
232 last transition.
233 type: string
234 reason:
235 description: Unique, one-word, CamelCase reason for the condition's
236 last transition.
237 type: string
238 status:
239 description: Status is the status of the condition. Can be True,
240 False, Unknown.
241 type: string
242 type:
243 description: Type is the type of the condition.
244 type: string
245 type: object
246 type: array
247 observedGeneration:
248 description: ObservedGeneration is the generation of the resource
249 that was most recently observed by the Config Connector controller.
250 If this is equal to metadata.generation, then that means that the
251 current reported status reflects the most recent desired state of
252 the resource.
253 type: integer
254 selfLink:
255 description: The fully qualified name of this dataset.
256 type: string
257 type: object
258 required:
259 - spec
260 type: object
261 served: true
262 storage: true
263 subresources:
264 status: {}
265status:
266 acceptedNames:
267 kind: ""
268 plural: ""
269 conditions: []
270 storedVersions: []
View as plain text