Class: FHIR::R4::PlanDefinition

Inherits:
Model show all
Includes:
Hashable, Json, Xml
Defined in:
lib/fhir_models/r4/generated/resources/PlanDefinition.rb

Defined Under Namespace

Classes: Action, Goal

Constant Summary collapse

MULTIPLE_TYPES = 
{
  'subject' => ['CodeableConcept', 'Reference']
}
SEARCH_PARAMS = 
['composed-of', 'context', 'context-quantity', 'context-type', 'context-type-quantity', 'context-type-value', 'date', 'definition', 'depends-on', 'derived-from', 'description', 'effective', 'identifier', 'jurisdiction', 'name', 'predecessor', 'publisher', 'status', 'successor', 'title', 'topic', 'type', 'url', 'version']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'PlanDefinition.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'PlanDefinition.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'PlanDefinition.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'valid_codes'=>{'urn:ietf:bcp:47'=>['ar', 'bn', 'cs', 'da', 'de', 'de-AT', 'de-CH', 'de-DE', 'el', 'en', 'en-AU', 'en-CA', 'en-GB', 'en-IN', 'en-NZ', 'en-SG', 'en-US', 'es', 'es-AR', 'es-ES', 'es-UY', 'fi', 'fr', 'fr-BE', 'fr-CH', 'fr-FR', 'fy', 'fy-NL', 'hi', 'hr', 'it', 'it-CH', 'it-IT', 'ja', 'ko', 'nl', 'nl-BE', 'nl-NL', 'no', 'no-NO', 'pa', 'pl', 'pt', 'pt-BR', 'ru', 'ru-RU', 'sr', 'sr-RS', 'sv', 'sv-SE', 'te', 'zh', 'zh-CN', 'zh-HK', 'zh-SG', 'zh-TW']}, 'type'=>'code', 'path'=>'PlanDefinition.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'PlanDefinition.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'PlanDefinition.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'PlanDefinition.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'PlanDefinition.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'url' => {'type'=>'uri', 'path'=>'PlanDefinition.url', 'min'=>0, 'max'=>1},
  'identifier' => {'type'=>'Identifier', 'path'=>'PlanDefinition.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'version' => {'type'=>'string', 'path'=>'PlanDefinition.version', 'min'=>0, 'max'=>1},
  'name' => {'type'=>'string', 'path'=>'PlanDefinition.name', 'min'=>0, 'max'=>1},
  'title' => {'type'=>'string', 'path'=>'PlanDefinition.title', 'min'=>0, 'max'=>1},
  'subtitle' => {'type'=>'string', 'path'=>'PlanDefinition.subtitle', 'min'=>0, 'max'=>1},
  'type' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/plan-definition-type'=>['order-set', 'clinical-protocol', 'eca-rule', 'workflow-definition']}, 'type'=>'CodeableConcept', 'path'=>'PlanDefinition.type', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/plan-definition-type'}},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/publication-status'=>['draft', 'active', 'retired', 'unknown']}, 'type'=>'code', 'path'=>'PlanDefinition.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/publication-status'}},
  'experimental' => {'type'=>'boolean', 'path'=>'PlanDefinition.experimental', 'min'=>0, 'max'=>1},
  'subjectCodeableConcept' => {'valid_codes'=>{'http://hl7.org/fhir/resource-types'=>['Patient', 'Practitioner', 'Organization', 'Location', 'Device']}, 'type'=>'CodeableConcept', 'path'=>'PlanDefinition.subject[x]', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/subject-type'}},
  'subjectReference' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Group'], 'type'=>'Reference', 'path'=>'PlanDefinition.subject[x]', 'min'=>0, 'max'=>1},
  'date' => {'type'=>'dateTime', 'path'=>'PlanDefinition.date', 'min'=>0, 'max'=>1},
  'publisher' => {'type'=>'string', 'path'=>'PlanDefinition.publisher', 'min'=>0, 'max'=>1},
  'contact' => {'type'=>'ContactDetail', 'path'=>'PlanDefinition.contact', 'min'=>0, 'max'=>Float::INFINITY},
  'description' => {'type'=>'markdown', 'path'=>'PlanDefinition.description', 'min'=>0, 'max'=>1},
  'useContext' => {'type'=>'UsageContext', 'path'=>'PlanDefinition.useContext', 'min'=>0, 'max'=>Float::INFINITY},
  'jurisdiction' => {'type'=>'CodeableConcept', 'path'=>'PlanDefinition.jurisdiction', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/jurisdiction'}},
  'purpose' => {'type'=>'markdown', 'path'=>'PlanDefinition.purpose', 'min'=>0, 'max'=>1},
  'usage' => {'type'=>'string', 'path'=>'PlanDefinition.usage', 'min'=>0, 'max'=>1},
  'copyright' => {'type'=>'markdown', 'path'=>'PlanDefinition.copyright', 'min'=>0, 'max'=>1},
  'approvalDate' => {'type'=>'date', 'path'=>'PlanDefinition.approvalDate', 'min'=>0, 'max'=>1},
  'lastReviewDate' => {'type'=>'date', 'path'=>'PlanDefinition.lastReviewDate', 'min'=>0, 'max'=>1},
  'effectivePeriod' => {'type'=>'Period', 'path'=>'PlanDefinition.effectivePeriod', 'min'=>0, 'max'=>1},
  'topic' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/definition-topic'=>['treatment', 'education', 'assessment']}, 'type'=>'CodeableConcept', 'path'=>'PlanDefinition.topic', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/definition-topic'}},
  'author' => {'type'=>'ContactDetail', 'path'=>'PlanDefinition.author', 'min'=>0, 'max'=>Float::INFINITY},
  'editor' => {'type'=>'ContactDetail', 'path'=>'PlanDefinition.editor', 'min'=>0, 'max'=>Float::INFINITY},
  'reviewer' => {'type'=>'ContactDetail', 'path'=>'PlanDefinition.reviewer', 'min'=>0, 'max'=>Float::INFINITY},
  'endorser' => {'type'=>'ContactDetail', 'path'=>'PlanDefinition.endorser', 'min'=>0, 'max'=>Float::INFINITY},
  'relatedArtifact' => {'type'=>'RelatedArtifact', 'path'=>'PlanDefinition.relatedArtifact', 'min'=>0, 'max'=>Float::INFINITY},
  'library' => {'type'=>'canonical', 'path'=>'PlanDefinition.library', 'min'=>0, 'max'=>Float::INFINITY},
  'goal' => {'type'=>'PlanDefinition::Goal', 'path'=>'PlanDefinition.goal', 'min'=>0, 'max'=>Float::INFINITY},
  'action' => {'type'=>'PlanDefinition::Action', 'path'=>'PlanDefinition.action', 'min'=>0, 'max'=>Float::INFINITY}
}

Constants included from FHIR::R4

PRIMITIVES, RESOURCES, TYPES

Constants included from FHIR

Account, ActivityDefinition, Address, AdverseEvent, Age, AllergyIntolerance, Annotation, Appointment, AppointmentResponse, Attachment, AuditEvent, BackboneElement, Basic, Binary, BiologicallyDerivedProduct, BodyStructure, Bundle, CapabilityStatement, CarePlan, CareTeam, CatalogEntry, ChargeItem, ChargeItemDefinition, Claim, ClaimResponse, ClinicalImpression, CodeSystem, CodeableConcept, Coding, Communication, CommunicationRequest, CompartmentDefinition, Composition, ConceptMap, Condition, Consent, ContactDetail, ContactPoint, Contract, Contributor, Count, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DataRequirement, Definitions, DetectedIssue, Device, DeviceDefinition, DeviceMetric, DeviceRequest, DeviceUseStatement, DiagnosticReport, Distance, DocumentManifest, DocumentReference, DomainResource, Dosage, Duration, EffectEvidenceSynthesis, Element, ElementDefinition, Encounter, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, Expression, Extension, FamilyMemberHistory, Flag, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, HumanName, Identifier, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, InsurancePlan, Invoice, Library, Linkage, List, Location, MarketingStatus, Measure, MeasureReport, Media, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MessageDefinition, MessageHeader, Meta, MolecularSequence, Money, NamingSystem, Narrative, NutritionOrder, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, PRIMITIVES, ParameterDefinition, Parameters, Patient, PaymentNotice, PaymentReconciliation, Period, Person, PlanDefinition, Population, Practitioner, PractitionerRole, Procedure, ProdCharacteristic, ProductShelfLife, Provenance, Quantity, Questionnaire, QuestionnaireResponse, FHIR::RESOURCES, FHIR::Range, FHIR::Ratio, FHIR::Reference, FHIR::RelatedArtifact, FHIR::RelatedPerson, FHIR::RequestGroup, FHIR::ResearchDefinition, FHIR::ResearchElementDefinition, FHIR::ResearchStudy, FHIR::ResearchSubject, FHIR::Resource, FHIR::RiskAssessment, FHIR::RiskEvidenceSynthesis, SampledData, Schedule, SearchParameter, ServiceRequest, Signature, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureDefinitionCompare, StructureMap, Subscription, Substance, SubstanceAmount, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, SupplyDelivery, SupplyRequest, TYPES, Task, TerminologyCapabilities, TestReport, TestScript, Timing, TriggerDefinition, UsageContext, ValueSet, VerificationResult, VisionPrescription

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FHIR::R4

#fhir_version_string, #versioned_fhir_module

Methods included from FHIR

default_logger, fhir_version_string, logger, logger=, primitive?, versioned_fhir_module

Methods included from ClassMethods

#from_contents

Methods included from ClassXml

#from_xml, #valid?, #validate, #xml_node_to_hash

Methods included from InstanceXml

#hash_to_xml_node, #to_xml

Methods included from ClassJson

#from_json

Methods included from InstanceJson

#to_json

Methods included from Hashable

#from_hash, #to_hash

Methods inherited from Model

#==, #attribute_mismatch, #compare_attribute, #each_element, #equals?, #hash, #initialize, #method_missing, #mismatch, #primitive?, #respond_to_missing?, #to_reference, #valid?, #validate, #validate_profile

Methods included from Deprecate

#deprecate

Constructor Details

This class inherits a constructor from FHIR::Model

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class FHIR::Model

Instance Attribute Details

#action ⇒ Object

0-* [ PlanDefinition::Action ]



329
330
331
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 329

def action
  @action
end

#approvalDate ⇒ Object

0-1 date



318
319
320
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 318

def approvalDate
  @approvalDate
end

#author ⇒ Object

0-* [ ContactDetail ]



322
323
324
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 322

def author
  @author
end

#contact ⇒ Object

0-* [ ContactDetail ]



311
312
313
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 311

def contact
  @contact
end

#contained ⇒ Object

0-* [ Resource ]



295
296
297
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 295

def contained
  @contained
end

#copyright ⇒ Object

0-1 markdown



317
318
319
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 317

def copyright
  @copyright
end

#date ⇒ Object

0-1 dateTime



309
310
311
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 309

def date
  @date
end

#description ⇒ Object

0-1 markdown



312
313
314
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 312

def description
  @description
end

#editor ⇒ Object

0-* [ ContactDetail ]



323
324
325
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 323

def editor
  @editor
end

#effectivePeriod ⇒ Object

0-1 Period



320
321
322
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 320

def effectivePeriod
  @effectivePeriod
end

#endorser ⇒ Object

0-* [ ContactDetail ]



325
326
327
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 325

def endorser
  @endorser
end

#experimental ⇒ Object

0-1 boolean



306
307
308
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 306

def experimental
  @experimental
end

#extension ⇒ Object

0-* [ Extension ]



296
297
298
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 296

def extension
  @extension
end

#goal ⇒ Object

0-* [ PlanDefinition::Goal ]



328
329
330
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 328

def goal
  @goal
end

#id ⇒ Object

0-1 id



290
291
292
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 290

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



299
300
301
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 299

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



292
293
294
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 292

def implicitRules
  @implicitRules
end

#jurisdiction ⇒ Object

0-* [ CodeableConcept ]



314
315
316
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 314

def jurisdiction
  @jurisdiction
end

#language ⇒ Object

0-1 code



293
294
295
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 293

def language
  @language
end

#lastReviewDate ⇒ Object

0-1 date



319
320
321
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 319

def lastReviewDate
  @lastReviewDate
end

#library ⇒ Object

0-* [ canonical ]



327
328
329
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 327

def library
  @library
end

#meta ⇒ Object

0-1 Meta



291
292
293
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 291

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



297
298
299
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 297

def modifierExtension
  @modifierExtension
end

#name ⇒ Object

0-1 string



301
302
303
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 301

def name
  @name
end

#publisher ⇒ Object

0-1 string



310
311
312
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 310

def publisher
  @publisher
end

#purpose ⇒ Object

0-1 markdown



315
316
317
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 315

def purpose
  @purpose
end

#relatedArtifact ⇒ Object

0-* [ RelatedArtifact ]



326
327
328
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 326

def relatedArtifact
  @relatedArtifact
end

#reviewer ⇒ Object

0-* [ ContactDetail ]



324
325
326
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 324

def reviewer
  @reviewer
end

#status ⇒ Object

1-1 code



305
306
307
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 305

def status
  @status
end

#subjectCodeableConcept ⇒ Object

0-1 CodeableConcept



307
308
309
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 307

def subjectCodeableConcept
  @subjectCodeableConcept
end

#subjectReference ⇒ Object

0-1 Reference(Group)



308
309
310
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 308

def subjectReference
  @subjectReference
end

#subtitle ⇒ Object

0-1 string



303
304
305
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 303

def subtitle
  @subtitle
end

#text ⇒ Object

0-1 Narrative



294
295
296
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 294

def text
  @text
end

#title ⇒ Object

0-1 string



302
303
304
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 302

def title
  @title
end

#topic ⇒ Object

0-* [ CodeableConcept ]



321
322
323
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 321

def topic
  @topic
end

#type ⇒ Object

0-1 CodeableConcept



304
305
306
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 304

def type
  @type
end

#url ⇒ Object

0-1 uri



298
299
300
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 298

def url
  @url
end

#usage ⇒ Object

0-1 string



316
317
318
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 316

def usage
  @usage
end

#useContext ⇒ Object

0-* [ UsageContext ]



313
314
315
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 313

def useContext
  @useContext
end

#version ⇒ Object

0-1 string



300
301
302
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 300

def version
  @version
end

Instance Method Details

#resourceType ⇒ Object 



331
332
333
 
# File 'lib/fhir_models/r4/generated/resources/PlanDefinition.rb', line 331

def resourceType
  'PlanDefinition'
end