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