Class: FHIR::PlanDefinition

Inherits:
Model
  • Object
show all
Includes:
Hashable, Json, Xml
Defined in:
lib/fhir_models/fhir/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', '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|4.0.0'}},
  'experimental' => {'type'=>'boolean', 'path'=>'PlanDefinition.experimental', 'min'=>0, 'max'=>1},
  'subjectCodeableConcept' => {'valid_codes'=>{'http://hl7.org/fhir/resource-types'=>['Patient', 'Practitioner', 'Organization', 'Location', 'Device', 'Account', 'ActivityDefinition', 'AdverseEvent', 'AllergyIntolerance', 'Appointment', 'AppointmentResponse', 'AuditEvent', 'Basic', 'Binary', 'BiologicallyDerivedProduct', 'BodyStructure', 'Bundle', 'CapabilityStatement', 'CarePlan', 'CareTeam', 'CatalogEntry', 'ChargeItem', 'ChargeItemDefinition', 'Claim', 'ClaimResponse', 'ClinicalImpression', 'CodeSystem', 'Communication', 'CommunicationRequest', 'CompartmentDefinition', 'Composition', 'ConceptMap', 'Condition', 'Consent', 'Contract', 'Coverage', 'CoverageEligibilityRequest', 'CoverageEligibilityResponse', 'DetectedIssue', 'DeviceDefinition', 'DeviceMetric', 'DeviceRequest', 'DeviceUseStatement', 'DiagnosticReport', 'DocumentManifest', 'DocumentReference', 'DomainResource', 'EffectEvidenceSynthesis', 'Encounter', 'Endpoint', 'EnrollmentRequest', 'EnrollmentResponse', 'EpisodeOfCare', 'EventDefinition', 'Evidence', 'EvidenceVariable', 'ExampleScenario', 'ExplanationOfBenefit', 'FamilyMemberHistory', 'Flag', 'Goal', 'GraphDefinition', 'Group', 'GuidanceResponse', 'HealthcareService', 'ImagingStudy', 'Immunization', 'ImmunizationEvaluation', 'ImmunizationRecommendation', 'ImplementationGuide', 'InsurancePlan', 'Invoice', 'Library', 'Linkage', 'List', 'Measure', 'MeasureReport', 'Media', 'Medication', 'MedicationAdministration', 'MedicationDispense', 'MedicationKnowledge', 'MedicationRequest', 'MedicationStatement', 'MedicinalProduct', 'MedicinalProductAuthorization', 'MedicinalProductContraindication', 'MedicinalProductIndication', 'MedicinalProductIngredient', 'MedicinalProductInteraction', 'MedicinalProductManufactured', 'MedicinalProductPackaged', 'MedicinalProductPharmaceutical', 'MedicinalProductUndesirableEffect', 'MessageDefinition', 'MessageHeader', 'MolecularSequence', 'NamingSystem', 'NutritionOrder', 'Observation', 'ObservationDefinition', 'OperationDefinition', 'OperationOutcome', 'OrganizationAffiliation', 'Parameters', 'PaymentNotice', 'PaymentReconciliation', 'Person', 'PlanDefinition', 'PractitionerRole', 'Procedure', 'Provenance', 'Questionnaire', 'QuestionnaireResponse', 'RelatedPerson', 'RequestGroup', 'ResearchDefinition', 'ResearchElementDefinition', 'ResearchStudy', 'ResearchSubject', 'Resource', 'RiskAssessment', 'RiskEvidenceSynthesis', 'Schedule', 'SearchParameter', 'ServiceRequest', 'Slot', 'Specimen', 'SpecimenDefinition', 'StructureDefinition', 'StructureMap', 'Subscription', 'Substance', 'SubstanceNucleicAcid', 'SubstancePolymer', 'SubstanceProtein', 'SubstanceReferenceInformation', 'SubstanceSourceMaterial', 'SubstanceSpecification', 'SupplyDelivery', 'SupplyRequest', 'Task', 'TerminologyCapabilities', 'TestReport', 'TestScript', 'ValueSet', 'VerificationResult', 'VisionPrescription']}, '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}
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Xml

from_xml, #to_xml, valid?, validate

Methods included from Deprecate

#deprecate

Methods included from Json

from_json, #to_json

Methods included from Hashable

#from_hash, #to_hash

Methods inherited from Model

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

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 ]



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

def action
  @action
end

#approvalDate ⇒ Object

0-1 date



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

def approvalDate
  @approvalDate
end

#author ⇒ Object

0-* [ ContactDetail ]



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

def author
  @author
end

#contact ⇒ Object

0-* [ ContactDetail ]



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

def contact
  @contact
end

#contained ⇒ Object

0-* [ Resource ]



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

def contained
  @contained
end

#copyright ⇒ Object

0-1 markdown



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

def copyright
  @copyright
end

#date ⇒ Object

0-1 dateTime



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

def date
  @date
end

#description ⇒ Object

0-1 markdown



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

def description
  @description
end

#editor ⇒ Object

0-* [ ContactDetail ]



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

def editor
  @editor
end

#effectivePeriod ⇒ Object

0-1 Period



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

def effectivePeriod
  @effectivePeriod
end

#endorser ⇒ Object

0-* [ ContactDetail ]



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

def endorser
  @endorser
end

#experimental ⇒ Object

0-1 boolean



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

def experimental
  @experimental
end

#extension ⇒ Object

0-* [ Extension ]



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

def extension
  @extension
end

#goal ⇒ Object

0-* [ PlanDefinition::Goal ]



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

def goal
  @goal
end

#id ⇒ Object

0-1 id



289
290
291
 
# File 'lib/fhir_models/fhir/resources/PlanDefinition.rb', line 289

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



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

def implicitRules
  @implicitRules
end

#jurisdiction ⇒ Object

0-* [ CodeableConcept ]



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

def jurisdiction
  @jurisdiction
end

#language ⇒ Object

0-1 code



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

def language
  @language
end

#lastReviewDate ⇒ Object

0-1 date



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

def lastReviewDate
  @lastReviewDate
end

#library ⇒ Object

0-* [ canonical ]



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

def library
  @library
end

#meta ⇒ Object

0-1 Meta



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

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#name ⇒ Object

0-1 string



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

def name
  @name
end

#publisher ⇒ Object

0-1 string



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

def publisher
  @publisher
end

#purpose ⇒ Object

0-1 markdown



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

def purpose
  @purpose
end

#relatedArtifact ⇒ Object

0-* [ RelatedArtifact ]



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

def relatedArtifact
  @relatedArtifact
end

#reviewer ⇒ Object

0-* [ ContactDetail ]



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

def reviewer
  @reviewer
end

#status ⇒ Object

1-1 code



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

def status
  @status
end

#subjectCodeableConcept ⇒ Object

0-1 CodeableConcept



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

def subjectCodeableConcept
  @subjectCodeableConcept
end

#subjectReference ⇒ Object

0-1 Reference(Group)



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

def subjectReference
  @subjectReference
end

#subtitle ⇒ Object

0-1 string



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

def subtitle
  @subtitle
end

#text ⇒ Object

0-1 Narrative



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

def text
  @text
end

#title ⇒ Object

0-1 string



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

def title
  @title
end

#topic ⇒ Object

0-* [ CodeableConcept ]



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

def topic
  @topic
end

#type ⇒ Object

0-1 CodeableConcept



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

def type
  @type
end

#url ⇒ Object

0-1 uri



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

def url
  @url
end

#usage ⇒ Object

0-1 string



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

def usage
  @usage
end

#useContext ⇒ Object

0-* [ UsageContext ]



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

def useContext
  @useContext
end

#version ⇒ Object

0-1 string



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

def version
  @version
end

Instance Method Details

#resourceType ⇒ Object 



330
331
332
 
# File 'lib/fhir_models/fhir/resources/PlanDefinition.rb', line 330

def resourceType
  'PlanDefinition'
end