package google.fhir.proto.validation

Get desktop application:
View/edit binary Protocol Buffers messages

A representation of a Validation requirement defined by a FHIR Profile, expressed as a SQL expression over Analytic FHIR.

• string column_name = 1

  A name to use for the resulting column, that reflects the path name to the constrained resource or datatype, suffixed with an underscore-separated constraint key.

• string sql_expression = 2

  The constraint in Standard SQL.

• ValidationSeverity severity = 3

  The severity of the constraint.

• ValidationType type = 4

  The type of validation that this requirement represents (e.g. `VALIDATION_TYPE_CARDINALITY` for missing required field, or `VALIDATION_TYPE_FHIR_PATH_CONSTRAINT` for FHIRPath Constraint).

• string element_path = 5

  The FHIRPath to the context element (dot-delimited camelCase) for the fhir_path_expression. The fhir_path_expression is evaluated relative to the element_path. For example, a proto like: element_path: Person.name fhir_path_expression: first.exists() or last.exists() means that if Person.name is present, then the expression first.exists() or last.exists() will be evaluated against Person.name.

• string description = 6

  A human-readable description of the requirement.

• string fhir_path_key = 7

  If type is `VALIDATION_TYPE_FHIR_PATH_CONSTRAINT`: Then this field is the FHIR key for the constraint. Not guaranteed to be unique beyond the current element. See: hl7.org/fhir/elementdefinition-definitions.html#ElementDefinition.constraint.key Otherwise: These fields are synthetic and represent unique identifiers.

• string fhir_path_expression = 8

  This field is the expression that was used to generate this SqlRequirement. If type is `VALIDATION_TYPE_FHIR_PATH_CONSTRAINT`: The expression is the FhirPath expression from the FHIR Profile. See: hl7.org/fhir/elementdefinition-definitions.html#ElementDefinition.constraint.expression Otherwise: The expression is a synthetic FhirPath expression generated in order to evaluate the constraint. For example, a cardinality constraint for min size of 1 could be rendered as the synthetic expression `field.exists()`. These are included here for debugging purposes.

• repeated string fields_referenced_by_expression = 9

  The field names referenced by the above fhir_path_expression. For example, an expression like 'a.b.where(c > d.e)' references fields ['a.b', 'a.b.c', 'a.b.d.e']

• string fhir_path_sql_expression = 10

  The fhir_path_expression if it was translated directly to SQL and with no contextual subqueries.

Enum representing the severity of a FHIRPath expression. This is a FHIR-version independent representation of http://hl7.org/fhir/constraint-severity

Used in: SqlRequirement

• SEVERITY_UNINITIALIZED = 0

• SEVERITY_ERROR = 1

• SEVERITY_WARNING = 2

Enum representing the type of a validation

Used in: SqlRequirement

• VALIDATION_TYPE_UNINITIALIZED = 0

• VALIDATION_TYPE_FHIR_PATH_CONSTRAINT = 1

  A validation originating from a FHIRPath Constraint See: hl7.org/fhir/conformance-rules.html#constraints

• VALIDATION_TYPE_CARDINALITY = 2

  A validation originating from a Cardinality requirement See: hl7.org/fhir/conformance-rules.html#cardinality

• VALIDATION_TYPE_CHOICE_TYPE = 5

  A validation originating from violating requirements of a Choice type, i.e., multiple values within a choice type set. See: hl7.org/fhir/formats.html#choice

• VALIDATION_TYPE_PRIMITIVE_REGEX = 4

  A validation originating from violating the regex requirements on primitive types. See: hl7.org/fhir/datatypes.html#primitive

• VALIDATION_TYPE_VALUE_SET_BINDING = 6

  A validation originating from a ValueSet binding. See: hl7.org/fhir/terminologies.html#binding

• VALIDATION_TYPE_REFERENCE_TYPE = 7

  A validation originating from violating requirements of a Reference type, i.e., multiple values within a reference type set or a reference to a type not allowed by the profile. See: https://build.fhir.org/references.html#Reference