[90] | 1 | # This module is an implementation of this UML:
|
---|
| 2 | # http://www.openehr.org/uml/release-1.0.1/Browsable/_9_0_76d0249_1109331021343_528780_2066Report.html
|
---|
| 3 | # Ticket refs #39
|
---|
[216] | 4 | module OpenEHR
|
---|
[4] | 5 | module RM
|
---|
| 6 | module Support
|
---|
[26] | 7 | module Identification
|
---|
[259] | 8 | class ObjectID
|
---|
[90] | 9 | attr_reader :value
|
---|
[26] | 10 |
|
---|
[259] | 11 | def initialize(args = {})
|
---|
| 12 | self.value=args[:value]
|
---|
[4] | 13 | end
|
---|
[90] | 14 |
|
---|
| 15 | def value=(value)
|
---|
[91] | 16 | raise ArgumentError, "empty value" if value.nil? or value.empty?
|
---|
[90] | 17 | @value = value
|
---|
| 18 | end
|
---|
[259] | 19 |
|
---|
[94] | 20 | def ==(object_id)
|
---|
| 21 | @value == object_id.value
|
---|
| 22 | end
|
---|
[4] | 23 | end # of ObjectID
|
---|
[94] | 24 |
|
---|
[167] | 25 | class ObjectRef
|
---|
[94] | 26 | attr_reader :namespace, :type, :id
|
---|
| 27 |
|
---|
| 28 | def initialize(namespace, type, id)
|
---|
| 29 | self.namespace = namespace
|
---|
| 30 | self.type = type
|
---|
| 31 | self.id = id
|
---|
| 32 | end
|
---|
| 33 |
|
---|
| 34 | def namespace=(namespace)
|
---|
[259] | 35 | raise ArgumentError if namespace.nil? or namespace.empty? or !(/([a-z]|[A-Z]).*/ =~ namespace) # error original is =~ #([a-z][A-Z])([a-z]|[A-Z]|\s|[v0-9]|[_-\:\/\&\+\?])*/
|
---|
[94] | 36 | @namespace = namespace
|
---|
| 37 | end
|
---|
| 38 |
|
---|
| 39 | def type=(type)
|
---|
| 40 | raise ArgumentError if type.nil? or type.empty?
|
---|
| 41 | @type = type
|
---|
| 42 | end
|
---|
| 43 |
|
---|
| 44 | def id=(id)
|
---|
| 45 | raise ArgumentError if id.nil?
|
---|
| 46 | @id = id
|
---|
| 47 | end
|
---|
| 48 | end
|
---|
[97] | 49 |
|
---|
[259] | 50 | class ArchetypeID < ObjectID
|
---|
[262] | 51 | attr_reader :rm_originator, :rm_name, :rm_entity,
|
---|
| 52 | :concept_name, :specialisation, :version_id
|
---|
| 53 |
|
---|
| 54 | def initialize(args = {})
|
---|
| 55 | if args[:value].nil?
|
---|
| 56 | self.rm_originator = args[:rm_originator]
|
---|
| 57 | self.rm_name = args[:rm_name]
|
---|
| 58 | self.rm_entity = args[:rm_entity]
|
---|
| 59 | self.concept_name = args[:concept_name]
|
---|
| 60 | self.version_id = args[:version_id]
|
---|
| 61 | self.specialisation = args[:specialisation]
|
---|
| 62 | else
|
---|
[264] | 63 | super(args)
|
---|
[262] | 64 | end
|
---|
| 65 | end
|
---|
[91] | 66 |
|
---|
[262] | 67 | def value=(value)
|
---|
| 68 | if /([a-zA-Z]\w+)-([a-zA-Z]\w+)-([a-zA-Z]\w+)\.([a-zA-Z]\w+)(-([a-zA-Z]\w+))?\.(v[1-9]\d*)/ =~ value
|
---|
| 69 | self.rm_originator = $1
|
---|
| 70 | self.rm_name = $2
|
---|
| 71 | self.rm_entity = $3
|
---|
| 72 | self.concept_name = $4
|
---|
| 73 | self.specialisation = $6
|
---|
| 74 | self.version_id = $7
|
---|
| 75 | else
|
---|
| 76 | raise ArgumentError, 'invalid archetype id form'
|
---|
| 77 | end
|
---|
[91] | 78 | end
|
---|
| 79 |
|
---|
[262] | 80 | def qualified_rm_entity
|
---|
| 81 | return @rm_originator + '-' + @rm_name + '-' + @rm_entity
|
---|
| 82 | end
|
---|
| 83 |
|
---|
| 84 | def domain_concept
|
---|
[264] | 85 | if @specialisation.nil?
|
---|
| 86 | return @concept_name
|
---|
| 87 | else
|
---|
| 88 | return @concept_name + '-' + @specialisation
|
---|
| 89 | end
|
---|
[262] | 90 | end
|
---|
| 91 |
|
---|
| 92 | def concept_name=(concept_name)
|
---|
| 93 | if concept_name.nil? or concept_name.empty?
|
---|
| 94 | raise ArgumentError, 'concept_name is mandatory'
|
---|
| 95 | end
|
---|
| 96 | @concept_name = concept_name
|
---|
| 97 | end
|
---|
| 98 |
|
---|
[91] | 99 | def domain_concept=(domain_concept)
|
---|
[262] | 100 | if domain_concept.nil? or domain_concept.empty?
|
---|
| 101 | raise ArgumentError, "domain concept not valid"
|
---|
| 102 | end
|
---|
| 103 | if /([a-zA-Z]\w+)(-([a-zA-Z]\w))?/ =~ domain_concept
|
---|
| 104 | self.concept_name = $1
|
---|
| 105 | self.specialisation = $3
|
---|
| 106 | else
|
---|
| 107 | raise ArgumentError, 'invalid domain concept form'
|
---|
| 108 | end
|
---|
[91] | 109 | end
|
---|
| 110 |
|
---|
| 111 | def rm_name=(rm_name)
|
---|
| 112 | raise ArgumentError, "rm_name not valid" if rm_name.nil? or rm_name.empty?
|
---|
| 113 | @rm_name = rm_name
|
---|
| 114 | end
|
---|
| 115 |
|
---|
| 116 | def rm_entity=(rm_entity)
|
---|
[262] | 117 | if rm_entity.nil? or rm_entity.empty?
|
---|
| 118 | raise ArgumentError, "rm_entity is mandatory"
|
---|
| 119 | end
|
---|
[91] | 120 | @rm_entity = rm_entity
|
---|
| 121 | end
|
---|
| 122 |
|
---|
| 123 | def rm_originator=(rm_originator)
|
---|
[262] | 124 | if rm_originator.nil? or rm_originator.empty?
|
---|
| 125 | raise ArgumentError, "rm_originator not valid"
|
---|
| 126 | end
|
---|
[91] | 127 | @rm_originator = rm_originator
|
---|
| 128 | end
|
---|
| 129 |
|
---|
| 130 | def specialisation=(specialisation)
|
---|
[262] | 131 | if !specialisation.nil? and specialisation.empty?
|
---|
| 132 | raise ArgumentError, "rm_specialisation not valid"
|
---|
| 133 | end
|
---|
[91] | 134 | @specialisation = specialisation
|
---|
| 135 | end
|
---|
[264] | 136 |
|
---|
[91] | 137 | def version_id=(version_id)
|
---|
| 138 | raise ArgumentError, "version_id not valid" if version_id.nil? or version_id.empty?
|
---|
| 139 | @version_id = version_id
|
---|
| 140 | end
|
---|
[26] | 141 | end
|
---|
| 142 |
|
---|
[259] | 143 | class TerminologyID < ObjectID
|
---|
[92] | 144 | attr_reader :name, :version_id
|
---|
[26] | 145 |
|
---|
[259] | 146 | def initialize(args = {})
|
---|
| 147 | super(args)
|
---|
[4] | 148 | end
|
---|
[26] | 149 |
|
---|
[107] | 150 | def value
|
---|
| 151 | if @version_id.empty?
|
---|
| 152 | @name
|
---|
| 153 | else
|
---|
| 154 | @name + '(' + @version_id + ')'
|
---|
| 155 | end
|
---|
| 156 | end
|
---|
| 157 |
|
---|
| 158 |
|
---|
| 159 | def value=(value)
|
---|
[106] | 160 | raise ArgumentError, "value not valid" if value.nil? or value.empty?
|
---|
[107] | 161 | if /(.*)\((.*)\)$/ =~ value
|
---|
[106] | 162 | @name = $1
|
---|
| 163 | @version_id = $2
|
---|
| 164 | else
|
---|
| 165 | @name = value
|
---|
[158] | 166 | @version_id = ''
|
---|
[106] | 167 | end
|
---|
| 168 | @value = value
|
---|
| 169 | end
|
---|
| 170 |
|
---|
[92] | 171 | def name=(name)
|
---|
| 172 | raise ArgumentError, "name not valid" if name.nil? or name.empty?
|
---|
| 173 | @name = name
|
---|
[4] | 174 | end
|
---|
[26] | 175 |
|
---|
[92] | 176 | def version_id=(version_id)
|
---|
| 177 | raise ArgumentError, "version_id not valid" if version_id.nil?
|
---|
| 178 | @version_id = version_id
|
---|
[4] | 179 | end
|
---|
[92] | 180 | end # of Terminology_ID
|
---|
[26] | 181 |
|
---|
[259] | 182 | class GenericID < ObjectID
|
---|
[92] | 183 | attr_reader :scheme
|
---|
[26] | 184 |
|
---|
[92] | 185 | def initialize(value, scheme)
|
---|
| 186 | super(value)
|
---|
| 187 | self.scheme = scheme
|
---|
[4] | 188 | end
|
---|
[26] | 189 |
|
---|
[92] | 190 | def scheme=(scheme)
|
---|
| 191 | raise ArgumentError, "scheme not valid" if scheme.nil? or scheme.empty?
|
---|
| 192 | @scheme = scheme
|
---|
[4] | 193 | end
|
---|
[92] | 194 | end # of Generic_ID
|
---|
[94] | 195 |
|
---|
[259] | 196 | class TemplateID < ObjectID
|
---|
[100] | 197 |
|
---|
| 198 | end
|
---|
| 199 |
|
---|
[259] | 200 | class UIDBasedID < ObjectID
|
---|
[93] | 201 | def initialize(value)
|
---|
| 202 | super(value)
|
---|
| 203 | end
|
---|
[97] | 204 |
|
---|
[93] | 205 | def extension
|
---|
| 206 | if self.has_extension?
|
---|
| 207 | @value[/::.*/][2..-1]
|
---|
| 208 | else
|
---|
| 209 | ''
|
---|
| 210 | end
|
---|
| 211 | end
|
---|
[97] | 212 |
|
---|
[93] | 213 | def has_extension?
|
---|
| 214 | @value.include? '::'
|
---|
| 215 | end
|
---|
[97] | 216 |
|
---|
[93] | 217 | def root
|
---|
| 218 | if self.has_extension?
|
---|
| 219 | @value[/.*::/][0..-3]
|
---|
| 220 | else
|
---|
| 221 | @value
|
---|
| 222 | end
|
---|
| 223 | end
|
---|
| 224 | end
|
---|
[95] | 225 |
|
---|
[259] | 226 | class ObjectVersionID < UIDBasedID
|
---|
[157] | 227 | attr_reader :object_id, :creating_system_id, :version_tree_id
|
---|
| 228 |
|
---|
| 229 | def initialize(value)
|
---|
| 230 | super(value)
|
---|
| 231 | end
|
---|
| 232 |
|
---|
| 233 | def value=(value)
|
---|
| 234 | super(value)
|
---|
| 235 | if /^(\w+)::(\w+)::((\d|\.)+)$/ =~ value
|
---|
[259] | 236 | self.object_id = UID.new($1)
|
---|
| 237 | self.creating_system_id = UID.new($2)
|
---|
| 238 | self.version_tree_id = VersionTreeID.new($3)
|
---|
[157] | 239 | else
|
---|
| 240 | raise ArgumentError, 'invalid format'
|
---|
| 241 | end
|
---|
| 242 | end
|
---|
| 243 |
|
---|
| 244 | def object_id=(object_id)
|
---|
| 245 | raise ArgumentError, 'object_id is mandatory' if object_id.nil?
|
---|
| 246 | @object_id = object_id
|
---|
| 247 | end
|
---|
| 248 |
|
---|
| 249 | def creating_system_id=(creating_system_id)
|
---|
| 250 | if creating_system_id.nil?
|
---|
| 251 | raise ArgumentError, 'creating_system_id is mandatory'
|
---|
| 252 | end
|
---|
| 253 | @creating_system_id = creating_system_id
|
---|
| 254 | end
|
---|
| 255 |
|
---|
| 256 | def version_tree_id=(version_tree_id)
|
---|
| 257 | if version_tree_id.nil?
|
---|
| 258 | raise ArgumentError, 'version_tree_id is mandatory'
|
---|
| 259 | end
|
---|
| 260 | @version_tree_id = version_tree_id
|
---|
| 261 | end
|
---|
[158] | 262 |
|
---|
| 263 | def is_branch?
|
---|
| 264 | return @version_tree_id.is_branch?
|
---|
| 265 | end
|
---|
[157] | 266 | end
|
---|
| 267 |
|
---|
[167] | 268 | class LocatableRef < ObjectRef
|
---|
[97] | 269 | attr_reader :namespace, :type, :id, :path
|
---|
| 270 |
|
---|
| 271 | def initialize(namespace, type, id, path)
|
---|
| 272 | super(namespace, type, id)
|
---|
| 273 | self.path = path
|
---|
| 274 | end
|
---|
| 275 |
|
---|
| 276 | def path=(path)
|
---|
| 277 | raise ArgumentError if path.nil? or path.empty?
|
---|
| 278 | @path = path
|
---|
| 279 | end
|
---|
| 280 |
|
---|
| 281 | def as_uri
|
---|
| 282 | 'ehr://' + @id.value + '/' + @path
|
---|
| 283 | end
|
---|
| 284 | end
|
---|
| 285 |
|
---|
[167] | 286 | class PartyRef < ObjectRef
|
---|
[98] | 287 |
|
---|
| 288 | def type=(type)
|
---|
[100] | 289 | parties = ['PERSON', 'ORGANISATION', 'GROUP', 'AGENT', 'ROLE','PARTY', 'ACTOR']
|
---|
[101] | 290 | raise ArgumentError, 'type invalid' unless parties.include? type
|
---|
[98] | 291 | @type = type
|
---|
| 292 | end
|
---|
| 293 | end
|
---|
[99] | 294 |
|
---|
[167] | 295 | class AccessGroupRef < ObjectRef
|
---|
[99] | 296 | def type=(type)
|
---|
[101] | 297 | raise ArgumentError, 'type invalid' unless type == 'ACCESS_GROUP'
|
---|
[99] | 298 | @type = type
|
---|
| 299 | end
|
---|
| 300 | end
|
---|
| 301 |
|
---|
[259] | 302 | class HierObjectID < UIDBasedID
|
---|
[95] | 303 |
|
---|
| 304 | end
|
---|
| 305 |
|
---|
[259] | 306 | class VersionTreeID
|
---|
[98] | 307 | attr_reader :value, :trunk_version, :branch_number, :branch_version
|
---|
| 308 |
|
---|
| 309 | def initialize(value)
|
---|
| 310 | self.value = value
|
---|
| 311 | end
|
---|
| 312 |
|
---|
| 313 | def value=(value)
|
---|
| 314 | raise ArgumentError, 'value invalid' if value.nil? or value.empty?
|
---|
[101] | 315 | @trunk_version = @branch_number = @branch_version = nil
|
---|
[98] | 316 | (trunk_version, branch_number, branch_version) = value.split '.'
|
---|
[100] | 317 | self.trunk_version = trunk_version
|
---|
| 318 | self.branch_number = branch_number
|
---|
| 319 | self.branch_version = branch_version
|
---|
[98] | 320 | end
|
---|
| 321 |
|
---|
| 322 | def trunk_version=(trunk_version)
|
---|
[101] | 323 | raise ArgumentError, 'trunk_version invalid' if trunk_version.nil? and !trunk_version.to_i >= 1
|
---|
[98] | 324 | @trunk_version = trunk_version
|
---|
[101] | 325 | set_value
|
---|
[98] | 326 | end
|
---|
| 327 |
|
---|
| 328 | def branch_number=(branch_number)
|
---|
[101] | 329 | raise ArgumentError, 'branch number invalid' unless branch_number.nil? or branch_number.to_i >= 1
|
---|
[100] | 330 | @branch_number = branch_number
|
---|
[101] | 331 | set_value
|
---|
[98] | 332 | end
|
---|
| 333 |
|
---|
[100] | 334 | def branch_version=(branch_version)
|
---|
[101] | 335 | raise ArgumentError, 'branch version invalid' if (!branch_version.nil? and !( branch_version.to_i >= 1)) or (!branch_version.nil? and @branch_number.nil?)
|
---|
[100] | 336 | @branch_version = branch_version
|
---|
[101] | 337 | set_value
|
---|
[100] | 338 | end
|
---|
[98] | 339 | def is_branch?
|
---|
[101] | 340 | !@branch_version.nil? and !@branch_number.nil?
|
---|
[98] | 341 | end
|
---|
[101] | 342 |
|
---|
| 343 | def is_first?
|
---|
| 344 | trunk_version == '1'
|
---|
| 345 | end
|
---|
| 346 |
|
---|
[98] | 347 | private
|
---|
[101] | 348 | def set_value
|
---|
| 349 | @value = trunk_version
|
---|
| 350 | @value = @value + '.' + @branch_number unless @branch_number.nil?
|
---|
| 351 | @value = @value + '.' + @branch_version unless @branch_version.nil?
|
---|
[98] | 352 | end
|
---|
| 353 | end
|
---|
| 354 |
|
---|
[259] | 355 | class UID
|
---|
[98] | 356 | attr_reader :value
|
---|
| 357 |
|
---|
| 358 | def initialize(value)
|
---|
| 359 | self.value = value
|
---|
| 360 | end
|
---|
| 361 |
|
---|
| 362 | def value=(value)
|
---|
| 363 | raise ArgumentError if value.nil? or value.empty?
|
---|
| 364 | @value = value
|
---|
| 365 | end
|
---|
| 366 | end
|
---|
| 367 |
|
---|
[259] | 368 | class UUID < UID
|
---|
[98] | 369 |
|
---|
| 370 | end
|
---|
| 371 |
|
---|
[259] | 372 | class InternetID <UID
|
---|
[98] | 373 |
|
---|
| 374 | end
|
---|
| 375 |
|
---|
[259] | 376 | class IsoOID <UID
|
---|
[98] | 377 |
|
---|
[157] | 378 | end
|
---|
[93] | 379 | end # of Identification
|
---|
[4] | 380 | end # of Support
|
---|
| 381 | end # of RM
|
---|
| 382 | end # of OpenEHR
|
---|