Primitive Package

{
    "name": "C_PRIMITIVE",
    "documentation": "Parent of types representing constraints on primitive types.",
    "is_abstract": true,
    "properties": {
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "Value to be assumed if none sent in data.",
            "type": "Any"
        }
    },
    "functions": {
        "default_value": {
            "name": "default_value",
            "documentation": "Generate a default value from this constraint object.",
            "is_abstract": true,
            "result": {
                "_type": "P_BMM_SIMPLE_TYPE",
                "type": "Any"
            }
        },
        "has_assumed_value": {
            "name": "has_assumed_value",
            "documentation": "True if there is an assumed value.",
            "is_abstract": true,
            "result": {
                "_type": "P_BMM_SIMPLE_TYPE",
                "type": "Boolean"
            }
        },
        "valid_value": {
            "name": "valid_value",
            "documentation": "True if a_value is valid with respect to constraint expressed in concrete instance of this type.",
            "is_abstract": true,
            "parameters": {
                "a_value": {
                    "_type": "P_BMM_SINGLE_FUNCTION_PARAMETER",
                    "name": "a_value",
                    "type": "Any"
                }
            },
            "result": {
                "_type": "P_BMM_SIMPLE_TYPE",
                "type": "Boolean"
            }
        }
    },
    "invariants": {
        "Assumed_value_valid": "has_assumed_value implies valid_value(assumed_value)"
    }
}

{
    "name": "C_BOOLEAN",
    "documentation": "Constraint on instances of Boolean. Both attributes cannot be set to False, since this would mean that the Boolean value being constrained cannot be True or False.",
    "ancestors": [
        "C_PRIMITIVE"
    ],
    "properties": {
        "true_valid": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "true_valid",
            "documentation": "True if the value True is allowed.",
            "is_mandatory": true,
            "type": "Boolean"
        },
        "false_valid": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "false_valid",
            "documentation": "True if the value False is allowed.",
            "is_mandatory": true,
            "type": "Boolean"
        },
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "The value to assume if this item is not included in data, due to being part of an optional structure.",
            "type": "Boolean"
        }
    }
}

{
    "name": "C_STRING",
    "documentation": "Constraint on instances of STRING. ",
    "ancestors": [
        "C_PRIMITIVE"
    ],
    "properties": {
        "pattern": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "pattern",
            "documentation": "Regular expression pattern for proposed instances of String to match.",
            "type": "String"
        },
        "list": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "list",
            "documentation": "Set of Strings specifying constraint.",
            "type_def": {
                "container_type": "List",
                "type": "String"
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        },
        "list_open": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "list_open",
            "documentation": "True if the list is being used to specify the constraint but is not considered exhaustive.",
            "is_mandatory": true,
            "type": "Boolean"
        },
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "The value to assume if this item is not included in data, due to being part of an optional structure.",
            "type": "String"
        }
    },
    "functions": {
        "valid_value": {
            "name": "valid_value",
            "documentation": "True if a_value is valid with respect to constraint expressed in concrete instance of this type. ",
            "parameters": {
                "a_value": {
                    "_type": "P_BMM_SINGLE_FUNCTION_PARAMETER",
                    "name": "a_value",
                    "type": "String"
                }
            },
            "result": {
                "_type": "P_BMM_SIMPLE_TYPE",
                "type": "Boolean"
            }
        }
    }
}

{
    "name": "C_INTEGER",
    "documentation": "Constraint on instances of Integer.",
    "ancestors": [
        "C_PRIMITIVE"
    ],
    "properties": {
        "list": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "list",
            "documentation": "Set of Integers specifying constraint.",
            "type_def": {
                "container_type": "List",
                "type": "Integer"
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        },
        "range": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "range",
            "documentation": "Range of Integers specifying constraint.",
            "type_def": {
                "root_type": "Interval",
                "generic_parameters": [
                    "Integer"
                ]
            }
        },
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "The value to assume if this item is not included in data, due to being part of an optional structure.",
            "type": "Integer"
        }
    }
}

{
    "name": "C_REAL",
    "documentation": "Constraint on instances of Real.",
    "ancestors": [
        "C_PRIMITIVE"
    ],
    "properties": {
        "list": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "list",
            "documentation": "Set of Reals specifying constraint.",
            "type_def": {
                "container_type": "List",
                "type": "Real"
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        },
        "range": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "range",
            "documentation": "Range of Real specifying constraint.",
            "type_def": {
                "root_type": "Interval",
                "generic_parameters": [
                    "Real"
                ]
            }
        },
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "The value to assume if this item is not included in data, due to being part of an optional structure.",
            "type": "Real"
        }
    }
}

{
    "name": "C_DATE",
    "documentation": "ISO 8601-compatible constraint on instances of Date in the form either of a set of validity values, or an actual date range. There is no validity flag for ‘year’, since it must always be by definition mandatory in order to have a sensible date at all. Syntax expressions of instances of this class include “YYYY-??-??” (date with optional month and day).",
    "ancestors": [
        "C_PRIMITIVE"
    ],
    "properties": {
        "day_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "day_validity",
            "documentation": "Validity of day in constrained date.",
            "type": "VALIDITY_KIND"
        },
        "month_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "month_validity",
            "documentation": "Validity of month in constrained date.",
            "type": "VALIDITY_KIND"
        },
        "range": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "range",
            "documentation": "Interval of Dates specifying constraint.",
            "type_def": {
                "root_type": "Interval",
                "generic_parameters": [
                    "Iso8601_date"
                ]
            }
        },
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "The value to assume if this item is not included in data, due to being part of an optional structure.",
            "type": "Iso8601_date"
        }
    },
    "invariants": {
        "Pattern_validity": "pattern /= Void implies valid_iso8601_date_constraint_pattern(pattern)",
        "Month_validity_optional": "month_validity = {VALIDITY_KIND}.optional implies (day_validity = {VALIDITY_KIND}.optional or day_validity = {VALIDITY_KIND}.disallowed)",
        "Month_validity_disallowed": "month_validity = {VALIDITY_KIND}.disallowed implies day_validity = {VALIDITY_KIND}.disallowed",
        "Validity_is_range": "validity_is_range = (range /= Void)"
    }
}

{
    "name": "C_TIME",
    "documentation": "ISO 8601-compatible constraint on instances of Time. There is no validity flag for ‘hour’, since it must always be by definition mandatory in order to have a sensible time at all. Syntax expressions of instances of this class include “HH:??:xx” (time with optional minutes and seconds not allowed).",
    "ancestors": [
        "C_PRIMITIVE"
    ],
    "properties": {
        "minute_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "minute_validity",
            "documentation": "Validity of minute in constrained time.",
            "type": "VALIDITY_KIND"
        },
        "second_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "second_validity",
            "documentation": "Validity of second in constrained time.",
            "type": "VALIDITY_KIND"
        },
        "millisecond_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "millisecond_validity",
            "documentation": "Validity of millisecond in constrained time.",
            "type": "VALIDITY_KIND"
        },
        "timezone_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "timezone_validity",
            "documentation": "Validity of timezone in constrained date.",
            "type": "VALIDITY_KIND"
        },
        "range": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "range",
            "documentation": "Interval of Times specifying constraint.",
            "type_def": {
                "root_type": "Interval",
                "generic_parameters": [
                    "Iso8601_time"
                ]
            }
        },
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "The value to assume if this item is not included in data, due to being part of an optional structure.",
            "type": "Iso8601_time"
        }
    },
    "functions": {
        "validity_is_range": {
            "name": "validity_is_range",
            "documentation": "True if validity is in the form of a range; useful for developers to check which kind of constraint has been set.",
            "result": {
                "_type": "P_BMM_SIMPLE_TYPE",
                "type": "Boolean"
            }
        }
    },
    "invariants": {
        "Pattern_validity": "pattern /= Void implies valid_iso8601_time_constraint_pattern (pattern)",
        "Minute_validity_optional": "minute_validity = {VALIDITY_KIND}.optional implies (second_validity = {VALIDITY_KIND}.optional or second_validity = {VALIDITY_KIND}.disallowed)",
        "Minute_validity_disallowed": "minute_validity = {VALIDITY_KIND}.disallowed implies second_validity = {VALIDITY_KIND}.disallowed",
        "Second_validity_optional": "second_validity = {VALIDITY_KIND}.optional implies (millisecond_validity = {VALIDITY_KIND}.optional or millisecond_validity = {VALIDITY_KIND}.disallowed)",
        "Second_validity_disallowed": "second_validity = {VALIDITY_KIND}.disallowed implies millisecond_validity = {VALIDITY_KIND}.disallowed Validity_is_range: validity_is_range = (range /= Void)"
    }
}

{
    "name": "C_DATE_TIME",
    "documentation": "ISO 8601-compatible constraint on instances of Date_Time. There is no validity flag for ‘year’, since it must always be by definition mandatory in order to have a sensible date/time at all. Syntax expressions of instances of this class include “YYYY-MM-DDT??:??:??” (date/time with optional time) and “YYYY-MMDDTHH:MM:xx” (date/time, seconds not allowed).",
    "ancestors": [
        "C_PRIMITIVE"
    ],
    "properties": {
        "month_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "month_validity",
            "documentation": "Validity of month in constrained date.",
            "type": "VALIDITY_KIND"
        },
        "day_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "day_validity",
            "documentation": "Validity of day in constrained date.",
            "type": "VALIDITY_KIND"
        },
        "hour_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "hour_validity",
            "documentation": "Validity of hour in constrained time.",
            "type": "VALIDITY_KIND"
        },
        "minute_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "minute_validity",
            "documentation": "Validity of minute in constrained time.",
            "type": "VALIDITY_KIND"
        },
        "second_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "second_validity",
            "documentation": "Validity of second in constrained time.",
            "type": "VALIDITY_KIND"
        },
        "millisecond_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "millisecond_validity",
            "documentation": "Validity of millisecond in constrained time.",
            "type": "VALIDITY_KIND"
        },
        "timezone_validity": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "timezone_validity",
            "documentation": "Validity of timezone in constrained date.",
            "type": "VALIDITY_KIND"
        },
        "range": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "range",
            "documentation": "Range of Date_times specifying constraint.",
            "type_def": {
                "root_type": "Interval",
                "generic_parameters": [
                    "Iso8601_date_time"
                ]
            }
        },
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "The value to assume if this item is not included in data, due to being part of an optional structure.",
            "type": "Iso8601_date_time"
        }
    },
    "functions": {
        "validity_is_range": {
            "name": "validity_is_range",
            "documentation": "True if validity is in the form of a range; useful for developers to check which kind of constraint has been set.",
            "result": {
                "_type": "P_BMM_SIMPLE_TYPE",
                "type": "Boolean"
            }
        }
    },
    "invariants": {
        "Pattern_validity": "pattern /= Void implies valid_iso8601_date_time_constraint_pattern(pattern)",
        "Month_validity_optional:": "month_validity = {VALIDITY_KIND}.optional implies (day_validity = {VALIDITY_KIND}.optional or day_validity = {VALIDITY_KIND}.disallowed)",
        "Month_validity_disallowed": "month_validity = {VALIDITY_KIND}.disallowed implies day_validity = {VALIDITY_KIND}.disallowed",
        "Day_validity_optional": "day_validity = {VALIDITY_KIND}.optional implies (hour_validity = {VALIDITY_KIND}.optional or hour_validity = {VALIDITY_KIND}.disallowed)",
        "Day_validity_disallowed": "day_validity = {VALIDITY_KIND}.disallowed implies hour_validity = {VALIDITY_KIND}.disallowed",
        "Hour_validity_optional": "hour_validity = {VALIDITY_KIND}.optional implies (minute_validity = {VALIDITY_KIND}.optional or minute_validity = {VALIDITY_KIND}.disallowed)",
        "Hour_validity_disallowed": "hour_validity = {VALIDITY_KIND}.disallowed implies minute_validity = {VALIDITY_KIND}.disallowed",
        "Minute_validity_optional": "minute_validity = {VALIDITY_KIND}.optional implies (second_validity = {VALIDITY_KIND}.optional or second_validity = {VALIDITY_KIND}.disallowed)",
        "Minute_validity_disallowed": "minute_validity = {VALIDITY_KIND}.disallowed implies second_validity = {VALIDITY_KIND}.disallowed",
        "Second_validity_optional": "second_validity = {VALIDITY_KIND}.optional implies (millisecond_validity = {VALIDITY_KIND}.optional or millisecond_validity = {VALIDITY_KIND}.disallowed)",
        "Second_validity_disallowed": "second_validity = {VALIDITY_KIND}.disallowed implies millisecond_validity = {VALIDITY_KIND}.disallowed",
        "Validity_is_range": "validity_is_range = (range /= Void)"
    }
}

{
    "name": "C_DURATION",
    "documentation": "ISO 8601-compatible constraint on instances of Duration. In ISO 8601 terms, constraints might are of the form “PWD” (weeks and/or days), “PDTHMS” (days, hours, minutes, seconds) and so on.\n\nBoth range and the constraint pattern can be set at the same time, corresponding to the ADL constraint `\"PWD/|P0W..P50W|\"`.\n\nAs for all of openEHR, two ISO 8601 exceptions are allowed: \n\n* the ‘W’ (week) designator can be mixed in - the allowed patterns are: `P[Y|y][M|m][D|d][T[H|h][M|m][S|s]]` and `P[W|w]`;\n* the values used in an interval constraint may be negated, i.e. a leading minus (`'-'`) sign may be used.\n",
    "ancestors": [
        "C_PRIMITIVE"
    ],
    "properties": {
        "years_allowed": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "years_allowed",
            "type": "Boolean"
        },
        "months_allowed": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "months_allowed",
            "documentation": "True if months are allowed in the constrained Duration.",
            "type": "Boolean"
        },
        "weeks_allowed": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "weeks_allowed",
            "type": "Boolean"
        },
        "days_allowed": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "days_allowed",
            "documentation": "True if days are allowed in the constrained Duration.",
            "type": "Boolean"
        },
        "hours_allowed": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "hours_allowed",
            "documentation": "True if hours are allowed in the constrained Duration.",
            "type": "Boolean"
        },
        "minutes_allowed": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "minutes_allowed",
            "documentation": "True if minutes are allowed in the constrained Duration.",
            "type": "Boolean"
        },
        "seconds_allowed": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "seconds_allowed",
            "type": "Boolean"
        },
        "fractional_seconds_allowed": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "fractional_seconds_allowed",
            "documentation": "True if fractional seconds are allowed in the constrained Duration.",
            "type": "Boolean"
        },
        "range": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "range",
            "documentation": "Range of Durations specifying constraint.",
            "type_def": {
                "root_type": "Interval",
                "generic_parameters": [
                    "Iso8601_duration"
                ]
            }
        },
        "assumed_value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "assumed_value",
            "documentation": "The value to assume if this item is not included in data, due to being part of an optional structure.",
            "type": "Iso8601_duration"
        }
    }
}