001package org.hl7.fhir.r5.patterns; 002 003/*- 004 * #%L 005 * org.hl7.fhir.r5 006 * %% 007 * Copyright (C) 2014 - 2019 Health Level 7 008 * %% 009 * Licensed under the Apache License, Version 2.0 (the "License"); 010 * you may not use this file except in compliance with the License. 011 * You may obtain a copy of the License at 012 * 013 * http://www.apache.org/licenses/LICENSE-2.0 014 * 015 * Unless required by applicable law or agreed to in writing, software 016 * distributed under the License is distributed on an "AS IS" BASIS, 017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 018 * See the License for the specific language governing permissions and 019 * limitations under the License. 020 * #L% 021 */ 022 023 024/* 025 Copyright (c) 2011+, HL7, Inc. 026 All rights reserved. 027 028 Redistribution and use in source and binary forms, with or without modification, 029 are permitted provided that the following conditions are met: 030 031 * Redistributions of source code must retain the above copyright notice, this 032 list of conditions and the following disclaimer. 033 * Redistributions in binary form must reproduce the above copyright notice, 034 this list of conditions and the following disclaimer in the documentation 035 and/or other materials provided with the distribution. 036 * Neither the name of HL7 nor the names of its contributors may be used to 037 endorse or promote products derived from this software without specific 038 prior written permission. 039 040 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 041 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 042 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 043 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 044 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 045 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 046 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 047 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 048 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 049 POSSIBILITY OF SUCH DAMAGE. 050 051*/ 052 053// Generated on Wed, May 8, 2019 10:40+1000 for FHIR v4.1.0 054 055import org.hl7.fhir.r5.model.*; 056import org.hl7.fhir.r5.model.DataType; 057import org.hl7.fhir.r5.model.Enumeration; 058import java.util.*; 059 060import org.hl7.fhir.utilities.Utilities; 061import org.hl7.fhir.r5.model.Enumerations.*; 062import org.hl7.fhir.exceptions.FHIRException; 063/** 064 * A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service. 065 */ 066public interface Definition extends PatternBase { 067 068 /** 069 * @return {@link #url} (An absolute URL that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this {{title}} is (or will be) published. The URL SHOULD include the major version of the {{title}}. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value 070 */ 071 public UriType getUrlElement() throws FHIRException; 072 073 /** 074 * @return whether there is more than zero values for url 075 */ 076 public boolean hasUrl(); 077 /** 078 * @return minimum allowed cardinality for url. Note that with patterns, this may be different for the underlying resource 079 */ 080 public int getUrlMin() throws FHIRException; 081 /** 082 * @return maximum allowed cardinality for url. Note that with patterns, this may be different for the underlying resource 083 */ 084 public int getUrlMax() throws FHIRException; 085 public boolean hasUrlElement(); 086 087 /** 088 * @param value {@link #url} (An absolute URL that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this {{title}} is (or will be) published. The URL SHOULD include the major version of the {{title}}. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value 089 */ 090 public Definition setUrlElement(UriType value) throws FHIRException; 091 092 /** 093 * @return An absolute URL that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this {{title}} is (or will be) published. The URL SHOULD include the major version of the {{title}}. For more information see [Technical and Business Versions](resource.html#versions). 094 */ 095 public String getUrl() throws FHIRException; 096 097 /** 098 * @param value An absolute URL that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this {{title}} is (or will be) published. The URL SHOULD include the major version of the {{title}}. For more information see [Technical and Business Versions](resource.html#versions). 099 */ 100 public Definition setUrl(String value) throws FHIRException; 101 102 /** 103 * @return {@link #identifier} (Business identifiers assigned to this {{title}} by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.) 104 */ 105 public Identifier getIdentifier() throws FHIRException ; 106 107 /** 108 * @return whether there is more than zero values for identifier 109 */ 110 public boolean hasIdentifier(); 111 /** 112 * @return minimum allowed cardinality for identifier. Note that with patterns, this may be different for the underlying resource 113 */ 114 public int getIdentifierMin(); 115 /** 116 * @return maximum allowed cardinality for identifier. Note that with patterns, this may be different for the underlying resource 117 */ 118 public int getIdentifierMax(); 119 /** 120 * @param value {@link #identifier} (Business identifiers assigned to this {{title}} by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.) 121 */ 122 public Definition setIdentifier(Identifier value) throws FHIRException; 123 124 /** 125 * @return {@link #version} (The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value 126 */ 127 public StringType getVersionElement() throws FHIRException; 128 129 /** 130 * @return whether there is more than zero values for version 131 */ 132 public boolean hasVersion(); 133 /** 134 * @return minimum allowed cardinality for version. Note that with patterns, this may be different for the underlying resource 135 */ 136 public int getVersionMin() throws FHIRException; 137 /** 138 * @return maximum allowed cardinality for version. Note that with patterns, this may be different for the underlying resource 139 */ 140 public int getVersionMax() throws FHIRException; 141 public boolean hasVersionElement(); 142 143 /** 144 * @param value {@link #version} (The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value 145 */ 146 public Definition setVersionElement(StringType value) throws FHIRException; 147 148 /** 149 * @return The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. 150 */ 151 public String getVersion() throws FHIRException; 152 153 /** 154 * @param value The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. 155 */ 156 public Definition setVersion(String value) throws FHIRException; 157 158 /** 159 * @return {@link #title} (A short, descriptive, user-friendly title for the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value 160 */ 161 public StringType getTitleElement() throws FHIRException; 162 163 /** 164 * @return whether there is more than zero values for title 165 */ 166 public boolean hasTitle(); 167 /** 168 * @return minimum allowed cardinality for title. Note that with patterns, this may be different for the underlying resource 169 */ 170 public int getTitleMin() throws FHIRException; 171 /** 172 * @return maximum allowed cardinality for title. Note that with patterns, this may be different for the underlying resource 173 */ 174 public int getTitleMax() throws FHIRException; 175 public boolean hasTitleElement(); 176 177 /** 178 * @param value {@link #title} (A short, descriptive, user-friendly title for the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value 179 */ 180 public Definition setTitleElement(StringType value) throws FHIRException; 181 182 /** 183 * @return A short, descriptive, user-friendly title for the {{title}}. 184 */ 185 public String getTitle() throws FHIRException; 186 187 /** 188 * @param value A short, descriptive, user-friendly title for the {{title}}. 189 */ 190 public Definition setTitle(String value) throws FHIRException; 191 192 /** 193 * @return {@link #derivedFromCanonical} (The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.) 194 */ 195 public List<CanonicalType> getDerivedFromCanonical() throws FHIRException; 196 197 /** 198 * @return Returns a reference to <code>this</code> for easy method chaining 199 */ 200 public Definition setDerivedFromCanonical(List<CanonicalType> theDerivedFromCanonical) throws FHIRException; 201 202 /** 203 * @return whether there is more than zero values for derivedFromCanonical 204 */ 205 public boolean hasDerivedFromCanonical(); 206 /** 207 * @return minimum allowed cardinality for derivedFromCanonical. Note that with patterns, this may be different for the underlying resource 208 */ 209 public int getDerivedFromCanonicalMin(); 210 /** 211 * @return maximum allowed cardinality for derivedFromCanonical. Note that with patterns, this may be different for the underlying resource 212 */ 213 public int getDerivedFromCanonicalMax(); 214 215 /** 216 * @return {@link #derivedFromCanonical} (The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.) 217 */ 218 public CanonicalType addDerivedFromCanonicalElement() throws FHIRException; 219 220 /** 221 * @param value {@link #derivedFromCanonical} (The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.) 222 */ 223 public Definition addDerivedFromCanonical(String value) throws FHIRException; 224 225 /** 226 * @param value {@link #derivedFromCanonical} (The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.) 227 */ 228 public boolean hasDerivedFromCanonical(String value) throws FHIRException; 229 230 /** 231 * @return {@link #derivedFromUri} (The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.) 232 */ 233 public List<UriType> getDerivedFromUri() throws FHIRException; 234 235 /** 236 * @return Returns a reference to <code>this</code> for easy method chaining 237 */ 238 public Definition setDerivedFromUri(List<UriType> theDerivedFromUri) throws FHIRException; 239 240 /** 241 * @return whether there is more than zero values for derivedFromUri 242 */ 243 public boolean hasDerivedFromUri(); 244 /** 245 * @return minimum allowed cardinality for derivedFromUri. Note that with patterns, this may be different for the underlying resource 246 */ 247 public int getDerivedFromUriMin(); 248 /** 249 * @return maximum allowed cardinality for derivedFromUri. Note that with patterns, this may be different for the underlying resource 250 */ 251 public int getDerivedFromUriMax(); 252 253 /** 254 * @return {@link #derivedFromUri} (The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.) 255 */ 256 public UriType addDerivedFromUriElement() throws FHIRException; 257 258 /** 259 * @param value {@link #derivedFromUri} (The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.) 260 */ 261 public Definition addDerivedFromUri(String value) throws FHIRException; 262 263 /** 264 * @param value {@link #derivedFromUri} (The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.) 265 */ 266 public boolean hasDerivedFromUri(String value) throws FHIRException; 267 268 /** 269 * @return {@link #partOf} (A larger definition of which this particular definition is a component or step.) 270 */ 271 public List<CanonicalType> getPartOf() throws FHIRException; 272 273 /** 274 * @return Returns a reference to <code>this</code> for easy method chaining 275 */ 276 public Definition setPartOf(List<CanonicalType> thePartOf) throws FHIRException; 277 278 /** 279 * @return whether there is more than zero values for partOf 280 */ 281 public boolean hasPartOf(); 282 /** 283 * @return minimum allowed cardinality for partOf. Note that with patterns, this may be different for the underlying resource 284 */ 285 public int getPartOfMin(); 286 /** 287 * @return maximum allowed cardinality for partOf. Note that with patterns, this may be different for the underlying resource 288 */ 289 public int getPartOfMax(); 290 291 /** 292 * @return {@link #partOf} (A larger definition of which this particular definition is a component or step.) 293 */ 294 public CanonicalType addPartOfElement() throws FHIRException; 295 296 /** 297 * @param value {@link #partOf} (A larger definition of which this particular definition is a component or step.) 298 */ 299 public Definition addPartOf(String value) throws FHIRException; 300 301 /** 302 * @param value {@link #partOf} (A larger definition of which this particular definition is a component or step.) 303 */ 304 public boolean hasPartOf(String value) throws FHIRException; 305 306 /** 307 * @return {@link #replaces} (Completed or terminated request(s) whose function is taken by this new request.) 308 */ 309 public List<CanonicalType> getReplaces() throws FHIRException; 310 311 /** 312 * @return Returns a reference to <code>this</code> for easy method chaining 313 */ 314 public Definition setReplaces(List<CanonicalType> theReplaces) throws FHIRException; 315 316 /** 317 * @return whether there is more than zero values for replaces 318 */ 319 public boolean hasReplaces(); 320 /** 321 * @return minimum allowed cardinality for replaces. Note that with patterns, this may be different for the underlying resource 322 */ 323 public int getReplacesMin(); 324 /** 325 * @return maximum allowed cardinality for replaces. Note that with patterns, this may be different for the underlying resource 326 */ 327 public int getReplacesMax(); 328 329 /** 330 * @return {@link #replaces} (Completed or terminated request(s) whose function is taken by this new request.) 331 */ 332 public CanonicalType addReplacesElement() throws FHIRException; 333 334 /** 335 * @param value {@link #replaces} (Completed or terminated request(s) whose function is taken by this new request.) 336 */ 337 public Definition addReplaces(String value) throws FHIRException; 338 339 /** 340 * @param value {@link #replaces} (Completed or terminated request(s) whose function is taken by this new request.) 341 */ 342 public boolean hasReplaces(String value) throws FHIRException; 343 344 /** 345 * @return {@link #status} (The current state of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value 346 */ 347 public Enumeration<PublicationStatus> getStatusElement() throws FHIRException; 348 349 /** 350 * @return whether there is more than zero values for status 351 */ 352 public boolean hasStatus(); 353 /** 354 * @return minimum allowed cardinality for status. Note that with patterns, this may be different for the underlying resource 355 */ 356 public int getStatusMin() throws FHIRException; 357 /** 358 * @return maximum allowed cardinality for status. Note that with patterns, this may be different for the underlying resource 359 */ 360 public int getStatusMax() throws FHIRException; 361 public boolean hasStatusElement(); 362 363 /** 364 * @param value {@link #status} (The current state of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value 365 */ 366 public Definition setStatusElement(Enumeration<PublicationStatus> value) throws FHIRException; 367 368 /** 369 * @return The current state of the {{title}}. 370 */ 371 public PublicationStatus getStatus() throws FHIRException; 372 373 /** 374 * @param value The current state of the {{title}}. 375 */ 376 public Definition setStatus(PublicationStatus value) throws FHIRException; 377 378 /** 379 * @return {@link #experimental} (A flag to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value 380 */ 381 public BooleanType getExperimentalElement() throws FHIRException; 382 383 /** 384 * @return whether there is more than zero values for experimental 385 */ 386 public boolean hasExperimental(); 387 /** 388 * @return minimum allowed cardinality for experimental. Note that with patterns, this may be different for the underlying resource 389 */ 390 public int getExperimentalMin() throws FHIRException; 391 /** 392 * @return maximum allowed cardinality for experimental. Note that with patterns, this may be different for the underlying resource 393 */ 394 public int getExperimentalMax() throws FHIRException; 395 public boolean hasExperimentalElement(); 396 397 /** 398 * @param value {@link #experimental} (A flag to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value 399 */ 400 public Definition setExperimentalElement(BooleanType value) throws FHIRException; 401 402 /** 403 * @return A flag to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. 404 */ 405 public boolean getExperimental() throws FHIRException; 406 407 /** 408 * @param value A flag to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. 409 */ 410 public Definition setExperimental(boolean value) throws FHIRException; 411 412 /** 413 * @return {@link #subject} (A code or group definition that describes the intended subject of instantiations of this definition.) 414 */ 415 public DataType getSubject() throws FHIRException ; 416 417 /** 418 * @return {@link #subject} (A code or group definition that describes the intended subject of instantiations of this definition.) 419 */ 420 public CodeableConcept getSubjectCodeableConcept() throws FHIRException; 421 422 public boolean hasSubjectCodeableConcept(); 423 424 /** 425 * @return {@link #subject} (A code or group definition that describes the intended subject of instantiations of this definition.) 426 */ 427 public Reference getSubjectReference() throws FHIRException; 428 429 public boolean hasSubjectReference(); 430 431 /** 432 * @return whether there is more than zero values for subject 433 */ 434 public boolean hasSubject(); 435 /** 436 * @return minimum allowed cardinality for subject. Note that with patterns, this may be different for the underlying resource 437 */ 438 public int getSubjectMin(); 439 /** 440 * @return maximum allowed cardinality for subject. Note that with patterns, this may be different for the underlying resource 441 */ 442 public int getSubjectMax(); 443 /** 444 * @param value {@link #subject} (A code or group definition that describes the intended subject of instantiations of this definition.) 445 */ 446 public Definition setSubject(DataType value) throws FHIRException; 447 448 /** 449 * @return {@link #date} (For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value 450 */ 451 public DateTimeType getDateElement() throws FHIRException; 452 453 /** 454 * @return whether there is more than zero values for date 455 */ 456 public boolean hasDate(); 457 /** 458 * @return minimum allowed cardinality for date. Note that with patterns, this may be different for the underlying resource 459 */ 460 public int getDateMin() throws FHIRException; 461 /** 462 * @return maximum allowed cardinality for date. Note that with patterns, this may be different for the underlying resource 463 */ 464 public int getDateMax() throws FHIRException; 465 public boolean hasDateElement(); 466 467 /** 468 * @param value {@link #date} (For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value 469 */ 470 public Definition setDateElement(DateTimeType value) throws FHIRException; 471 472 /** 473 * @return For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal. 474 */ 475 public Date getDate() throws FHIRException; 476 477 /** 478 * @param value For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal. 479 */ 480 public Definition setDate(Date value) throws FHIRException; 481 482 /** 483 * @return {@link #publisher} (Helps establish the "authority/credibility" of the {{title}}. May also allow for contact.) 484 */ 485 public Reference getPublisher() throws FHIRException ; 486 487 /** 488 * @return whether there is more than zero values for publisher 489 */ 490 public boolean hasPublisher(); 491 /** 492 * @return minimum allowed cardinality for publisher. Note that with patterns, this may be different for the underlying resource 493 */ 494 public int getPublisherMin(); 495 /** 496 * @return maximum allowed cardinality for publisher. Note that with patterns, this may be different for the underlying resource 497 */ 498 public int getPublisherMax(); 499 /** 500 * @param value {@link #publisher} (Helps establish the "authority/credibility" of the {{title}}. May also allow for contact.) 501 */ 502 public Definition setPublisher(Reference value) throws FHIRException; 503 504 /** 505 * @return {@link #contact} (Contact details to assist a user in finding and communicating with the publisher.) 506 */ 507 public List<ContactDetail> getContact() throws FHIRException; 508 509 /** 510 * @return Returns a reference to <code>this</code> for easy method chaining 511 */ 512 public Definition setContact(List<ContactDetail> theContact) throws FHIRException; 513 514 /** 515 * @return whether there is more than zero values for contact 516 */ 517 public boolean hasContact(); 518 /** 519 * @return minimum allowed cardinality for contact. Note that with patterns, this may be different for the underlying resource 520 */ 521 public int getContactMin(); 522 /** 523 * @return maximum allowed cardinality for contact. Note that with patterns, this may be different for the underlying resource 524 */ 525 public int getContactMax(); 526 527 public ContactDetail addContact() throws FHIRException; 528 529 public Definition addContact(ContactDetail t) throws FHIRException; 530 531 /** 532 * @return The first repetition of repeating field {@link #contact}, creating it if it does not already exist 533 */ 534 public ContactDetail getContactFirstRep() throws FHIRException; 535 536 /** 537 * @return {@link #description} (A free text natural language description of the {{title}} from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value 538 */ 539 public MarkdownType getDescriptionElement() throws FHIRException; 540 541 /** 542 * @return whether there is more than zero values for description 543 */ 544 public boolean hasDescription(); 545 /** 546 * @return minimum allowed cardinality for description. Note that with patterns, this may be different for the underlying resource 547 */ 548 public int getDescriptionMin() throws FHIRException; 549 /** 550 * @return maximum allowed cardinality for description. Note that with patterns, this may be different for the underlying resource 551 */ 552 public int getDescriptionMax() throws FHIRException; 553 public boolean hasDescriptionElement(); 554 555 /** 556 * @param value {@link #description} (A free text natural language description of the {{title}} from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value 557 */ 558 public Definition setDescriptionElement(MarkdownType value) throws FHIRException; 559 560 /** 561 * @return A free text natural language description of the {{title}} from the consumer's perspective. 562 */ 563 public String getDescription() throws FHIRException; 564 565 /** 566 * @param value A free text natural language description of the {{title}} from the consumer's perspective. 567 */ 568 public Definition setDescription(String value) throws FHIRException; 569 570 /** 571 * @return {@link #useContext} (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.) 572 */ 573 public List<UsageContext> getUseContext() throws FHIRException; 574 575 /** 576 * @return Returns a reference to <code>this</code> for easy method chaining 577 */ 578 public Definition setUseContext(List<UsageContext> theUseContext) throws FHIRException; 579 580 /** 581 * @return whether there is more than zero values for useContext 582 */ 583 public boolean hasUseContext(); 584 /** 585 * @return minimum allowed cardinality for useContext. Note that with patterns, this may be different for the underlying resource 586 */ 587 public int getUseContextMin(); 588 /** 589 * @return maximum allowed cardinality for useContext. Note that with patterns, this may be different for the underlying resource 590 */ 591 public int getUseContextMax(); 592 593 public UsageContext addUseContext() throws FHIRException; 594 595 public Definition addUseContext(UsageContext t) throws FHIRException; 596 597 /** 598 * @return The first repetition of repeating field {@link #useContext}, creating it if it does not already exist 599 */ 600 public UsageContext getUseContextFirstRep() throws FHIRException; 601 602 /** 603 * @return {@link #jurisdiction} (A jurisdiction in which the {{title}} is intended to be used.) 604 */ 605 public List<CodeableConcept> getJurisdiction() throws FHIRException; 606 607 /** 608 * @return Returns a reference to <code>this</code> for easy method chaining 609 */ 610 public Definition setJurisdiction(List<CodeableConcept> theJurisdiction) throws FHIRException; 611 612 /** 613 * @return whether there is more than zero values for jurisdiction 614 */ 615 public boolean hasJurisdiction(); 616 /** 617 * @return minimum allowed cardinality for jurisdiction. Note that with patterns, this may be different for the underlying resource 618 */ 619 public int getJurisdictionMin(); 620 /** 621 * @return maximum allowed cardinality for jurisdiction. Note that with patterns, this may be different for the underlying resource 622 */ 623 public int getJurisdictionMax(); 624 625 public CodeableConcept addJurisdiction() throws FHIRException; 626 627 public Definition addJurisdiction(CodeableConcept t) throws FHIRException; 628 629 /** 630 * @return The first repetition of repeating field {@link #jurisdiction}, creating it if it does not already exist 631 */ 632 public CodeableConcept getJurisdictionFirstRep() throws FHIRException; 633 634 /** 635 * @return {@link #purpose} (Explains why this {{title}} is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value 636 */ 637 public MarkdownType getPurposeElement() throws FHIRException; 638 639 /** 640 * @return whether there is more than zero values for purpose 641 */ 642 public boolean hasPurpose(); 643 /** 644 * @return minimum allowed cardinality for purpose. Note that with patterns, this may be different for the underlying resource 645 */ 646 public int getPurposeMin() throws FHIRException; 647 /** 648 * @return maximum allowed cardinality for purpose. Note that with patterns, this may be different for the underlying resource 649 */ 650 public int getPurposeMax() throws FHIRException; 651 public boolean hasPurposeElement(); 652 653 /** 654 * @param value {@link #purpose} (Explains why this {{title}} is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value 655 */ 656 public Definition setPurposeElement(MarkdownType value) throws FHIRException; 657 658 /** 659 * @return Explains why this {{title}} is needed and why it has been designed as it has. 660 */ 661 public String getPurpose() throws FHIRException; 662 663 /** 664 * @param value Explains why this {{title}} is needed and why it has been designed as it has. 665 */ 666 public Definition setPurpose(String value) throws FHIRException; 667 668 /** 669 * @return {@link #copyright} (A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value 670 */ 671 public MarkdownType getCopyrightElement() throws FHIRException; 672 673 /** 674 * @return whether there is more than zero values for copyright 675 */ 676 public boolean hasCopyright(); 677 /** 678 * @return minimum allowed cardinality for copyright. Note that with patterns, this may be different for the underlying resource 679 */ 680 public int getCopyrightMin() throws FHIRException; 681 /** 682 * @return maximum allowed cardinality for copyright. Note that with patterns, this may be different for the underlying resource 683 */ 684 public int getCopyrightMax() throws FHIRException; 685 public boolean hasCopyrightElement(); 686 687 /** 688 * @param value {@link #copyright} (A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value 689 */ 690 public Definition setCopyrightElement(MarkdownType value) throws FHIRException; 691 692 /** 693 * @return A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}. 694 */ 695 public String getCopyright() throws FHIRException; 696 697 /** 698 * @param value A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}. 699 */ 700 public Definition setCopyright(String value) throws FHIRException; 701 702 /** 703 * @return {@link #approvalDate} (The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value 704 */ 705 public DateType getApprovalDateElement() throws FHIRException; 706 707 /** 708 * @return whether there is more than zero values for approvalDate 709 */ 710 public boolean hasApprovalDate(); 711 /** 712 * @return minimum allowed cardinality for approvalDate. Note that with patterns, this may be different for the underlying resource 713 */ 714 public int getApprovalDateMin() throws FHIRException; 715 /** 716 * @return maximum allowed cardinality for approvalDate. Note that with patterns, this may be different for the underlying resource 717 */ 718 public int getApprovalDateMax() throws FHIRException; 719 public boolean hasApprovalDateElement(); 720 721 /** 722 * @param value {@link #approvalDate} (The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value 723 */ 724 public Definition setApprovalDateElement(DateType value) throws FHIRException; 725 726 /** 727 * @return The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. 728 */ 729 public Date getApprovalDate() throws FHIRException; 730 731 /** 732 * @param value The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. 733 */ 734 public Definition setApprovalDate(Date value) throws FHIRException; 735 736 /** 737 * @return {@link #lastReviewDate} (The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value 738 */ 739 public DateType getLastReviewDateElement() throws FHIRException; 740 741 /** 742 * @return whether there is more than zero values for lastReviewDate 743 */ 744 public boolean hasLastReviewDate(); 745 /** 746 * @return minimum allowed cardinality for lastReviewDate. Note that with patterns, this may be different for the underlying resource 747 */ 748 public int getLastReviewDateMin() throws FHIRException; 749 /** 750 * @return maximum allowed cardinality for lastReviewDate. Note that with patterns, this may be different for the underlying resource 751 */ 752 public int getLastReviewDateMax() throws FHIRException; 753 public boolean hasLastReviewDateElement(); 754 755 /** 756 * @param value {@link #lastReviewDate} (The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value 757 */ 758 public Definition setLastReviewDateElement(DateType value) throws FHIRException; 759 760 /** 761 * @return The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. 762 */ 763 public Date getLastReviewDate() throws FHIRException; 764 765 /** 766 * @param value The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. 767 */ 768 public Definition setLastReviewDate(Date value) throws FHIRException; 769 770 /** 771 * @return {@link #effectivePeriod} (The period during which the {{title}} content was or is planned to be effective.) 772 */ 773 public Period getEffectivePeriod() throws FHIRException ; 774 775 /** 776 * @return whether there is more than zero values for effectivePeriod 777 */ 778 public boolean hasEffectivePeriod(); 779 /** 780 * @return minimum allowed cardinality for effectivePeriod. Note that with patterns, this may be different for the underlying resource 781 */ 782 public int getEffectivePeriodMin(); 783 /** 784 * @return maximum allowed cardinality for effectivePeriod. Note that with patterns, this may be different for the underlying resource 785 */ 786 public int getEffectivePeriodMax(); 787 /** 788 * @param value {@link #effectivePeriod} (The period during which the {{title}} content was or is planned to be effective.) 789 */ 790 public Definition setEffectivePeriod(Period value) throws FHIRException; 791 792 /** 793 * @return {@link #performerType} (The type of individual that is expected to act upon instances of this definition.) 794 */ 795 public CodeableConcept getPerformerType() throws FHIRException ; 796 797 /** 798 * @return whether there is more than zero values for performerType 799 */ 800 public boolean hasPerformerType(); 801 /** 802 * @return minimum allowed cardinality for performerType. Note that with patterns, this may be different for the underlying resource 803 */ 804 public int getPerformerTypeMin(); 805 /** 806 * @return maximum allowed cardinality for performerType. Note that with patterns, this may be different for the underlying resource 807 */ 808 public int getPerformerTypeMax(); 809 /** 810 * @param value {@link #performerType} (The type of individual that is expected to act upon instances of this definition.) 811 */ 812 public Definition setPerformerType(CodeableConcept value) throws FHIRException; 813 814 public String fhirType(); 815 816 817} 818