Class: FHIR::R5::PlanDefinition::Action

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

Defined Under Namespace

Classes: Condition, DynamicValue, Input, Output, Participant, RelatedAction

Constant Summary collapse

MULTIPLE_TYPES =
{
  'subject' => ['CodeableConcept', 'Reference', 'canonical'],
  'timing' => ['Age', 'Duration', 'Range', 'Timing'],
  'definition' => ['canonical', 'uri']
}
METADATA =
{
  'id' => {'type'=>'string', 'path'=>'Action.id', 'min'=>0, 'max'=>1},
  'extension' => {'type'=>'Extension', 'path'=>'Action.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'Action.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'linkId' => {'type'=>'string', 'path'=>'Action.linkId', 'min'=>0, 'max'=>1},
  'prefix' => {'type'=>'string', 'path'=>'Action.prefix', 'min'=>0, 'max'=>1},
  'title' => {'type'=>'string', 'path'=>'Action.title', 'min'=>0, 'max'=>1},
  'description' => {'type'=>'markdown', 'path'=>'Action.description', 'min'=>0, 'max'=>1},
  'textEquivalent' => {'type'=>'markdown', 'path'=>'Action.textEquivalent', 'min'=>0, 'max'=>1},
  'priority' => {'valid_codes'=>{'http://hl7.org/fhir/request-priority'=>['routine', 'urgent', 'asap', 'stat']}, 'type'=>'code', 'path'=>'Action.priority', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/request-priority'}},
  'code' => {'valid_codes'=>{'http://hl7.org/fhir/action-code'=>['send-message', 'collect-information', 'prescribe-medication', 'recommend-immunization', 'order-service', 'propose-diagnosis', 'record-detected-issue', 'record-inference', 'report-flag']}, 'type'=>'CodeableConcept', 'path'=>'Action.code', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/action-code'}},
  'reason' => {'valid_codes'=>{'http://hl7.org/fhir/action-reason-code'=>['off-pathway', 'risk-assessment', 'care-gap', 'drug-drug-interaction', 'quality-measure']}, 'type'=>'CodeableConcept', 'path'=>'Action.reason', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/action-reason-code'}},
  'documentation' => {'type'=>'RelatedArtifact', 'path'=>'Action.documentation', 'min'=>0, 'max'=>Float::INFINITY},
  'goalId' => {'type'=>'id', 'path'=>'Action.goalId', 'min'=>0, 'max'=>Float::INFINITY},
  'subjectCodeableConcept' => {'valid_codes'=>{'http://hl7.org/fhir/fhir-types'=>['CareTeam', 'Device', 'Group', 'HealthcareService', 'Location', 'Organization', 'Patient', 'Practitioner', 'PractitionerRole', 'RelatedPerson']}, 'type'=>'CodeableConcept', 'path'=>'Action.subject[x]', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/participant-resource-types'}},
  'subjectReference' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Group'], 'type'=>'Reference', 'path'=>'Action.subject[x]', 'min'=>0, 'max'=>1},
  'subjectCanonical' => {'type'=>'canonical', 'path'=>'Action.subject[x]', 'min'=>0, 'max'=>1},
  'trigger' => {'type'=>'TriggerDefinition', 'path'=>'Action.trigger', 'min'=>0, 'max'=>Float::INFINITY},
  'condition' => {'type'=>'PlanDefinition::Action::Condition', 'path'=>'Action.condition', 'min'=>0, 'max'=>Float::INFINITY},
  'input' => {'type'=>'PlanDefinition::Action::Input', 'path'=>'Action.input', 'min'=>0, 'max'=>Float::INFINITY},
  'output' => {'type'=>'PlanDefinition::Action::Output', 'path'=>'Action.output', 'min'=>0, 'max'=>Float::INFINITY},
  'relatedAction' => {'type'=>'PlanDefinition::Action::RelatedAction', 'path'=>'Action.relatedAction', 'min'=>0, 'max'=>Float::INFINITY},
  'timingAge' => {'type'=>'Age', 'path'=>'Action.timing[x]', 'min'=>0, 'max'=>1},
  'timingDuration' => {'type'=>'Duration', 'path'=>'Action.timing[x]', 'min'=>0, 'max'=>1},
  'timingRange' => {'type'=>'Range', 'path'=>'Action.timing[x]', 'min'=>0, 'max'=>1},
  'timingTiming' => {'type'=>'Timing', 'path'=>'Action.timing[x]', 'min'=>0, 'max'=>1},
  'location' => {'type'=>'CodeableReference', 'path'=>'Action.location', 'min'=>0, 'max'=>1},
  'participant' => {'type'=>'PlanDefinition::Action::Participant', 'path'=>'Action.participant', 'min'=>0, 'max'=>Float::INFINITY},
  'type' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/action-type'=>['create', 'update', 'remove', 'fire-event']}, 'type'=>'CodeableConcept', 'path'=>'Action.type', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/action-type'}},
  'groupingBehavior' => {'valid_codes'=>{'http://hl7.org/fhir/action-grouping-behavior'=>['visual-group', 'logical-group', 'sentence-group']}, 'type'=>'code', 'path'=>'Action.groupingBehavior', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/action-grouping-behavior'}},
  'selectionBehavior' => {'valid_codes'=>{'http://hl7.org/fhir/action-selection-behavior'=>['any', 'all', 'all-or-none', 'exactly-one', 'at-most-one', 'one-or-more']}, 'type'=>'code', 'path'=>'Action.selectionBehavior', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/action-selection-behavior'}},
  'requiredBehavior' => {'valid_codes'=>{'http://hl7.org/fhir/action-required-behavior'=>['must', 'could', 'must-unless-documented']}, 'type'=>'code', 'path'=>'Action.requiredBehavior', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/action-required-behavior'}},
  'precheckBehavior' => {'valid_codes'=>{'http://hl7.org/fhir/action-precheck-behavior'=>['yes', 'no']}, 'type'=>'code', 'path'=>'Action.precheckBehavior', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/action-precheck-behavior'}},
  'cardinalityBehavior' => {'valid_codes'=>{'http://hl7.org/fhir/action-cardinality-behavior'=>['single', 'multiple']}, 'type'=>'code', 'path'=>'Action.cardinalityBehavior', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/action-cardinality-behavior'}},
  'definitionCanonical' => {'type'=>'canonical', 'path'=>'Action.definition[x]', 'min'=>0, 'max'=>1},
  'definitionUri' => {'type'=>'uri', 'path'=>'Action.definition[x]', 'min'=>0, 'max'=>1},
  'transform' => {'type'=>'canonical', 'path'=>'Action.transform', 'min'=>0, 'max'=>1},
  'dynamicValue' => {'type'=>'PlanDefinition::Action::DynamicValue', 'path'=>'Action.dynamicValue', 'min'=>0, 'max'=>Float::INFINITY},
  'action' => {'type'=>'PlanDefinition::Action', 'path'=>'Action.action', 'min'=>0, 'max'=>Float::INFINITY}
}

Constants included from FHIR::R4

FHIR::R4::PRIMITIVES, FHIR::R4::RESOURCES, FHIR::R4::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

Constants included from FHIR::R5

FHIR::R5::PRIMITIVES, RESOURCES, TYPES

Instance Attribute Summary collapse

Method Summary

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 included from FHIR::R5

#fhir_version_string, #versioned_fhir_module

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

#actionObject

0-* [ PlanDefinition::Action ]



406
407
408
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 406

def action
  @action
end

#cardinalityBehaviorObject

0-1 code



401
402
403
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 401

def cardinalityBehavior
  @cardinalityBehavior
end

#codeObject

0-1 CodeableConcept



378
379
380
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 378

def code
  @code
end

#conditionObject

0-* [ PlanDefinition::Action::Condition ]



386
387
388
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 386

def condition
  @condition
end

#definitionCanonicalObject

0-1 canonical



402
403
404
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 402

def definitionCanonical
  @definitionCanonical
end

#definitionUriObject

0-1 uri



403
404
405
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 403

def definitionUri
  @definitionUri
end

#descriptionObject

0-1 markdown



375
376
377
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 375

def description
  @description
end

#documentationObject

0-* [ RelatedArtifact ]



380
381
382
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 380

def documentation
  @documentation
end

#dynamicValueObject

0-* [ PlanDefinition::Action::DynamicValue ]



405
406
407
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 405

def dynamicValue
  @dynamicValue
end

#extensionObject

0-* [ Extension ]



370
371
372
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 370

def extension
  @extension
end

#goalIdObject

0-* [ id ]



381
382
383
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 381

def goalId
  @goalId
end

#groupingBehaviorObject

0-1 code



397
398
399
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 397

def groupingBehavior
  @groupingBehavior
end

#idObject

0-1 string



369
370
371
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 369

def id
  @id
end

#inputObject

0-* [ PlanDefinition::Action::Input ]



387
388
389
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 387

def input
  @input
end

#linkIdObject

0-1 string



372
373
374
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 372

def linkId
  @linkId
end

#locationObject

0-1 CodeableReference



394
395
396
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 394

def location
  @location
end

#modifierExtensionObject

0-* [ Extension ]



371
372
373
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 371

def modifierExtension
  @modifierExtension
end

#outputObject

0-* [ PlanDefinition::Action::Output ]



388
389
390
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 388

def output
  @output
end

#participantObject

0-* [ PlanDefinition::Action::Participant ]



395
396
397
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 395

def participant
  @participant
end

#precheckBehaviorObject

0-1 code



400
401
402
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 400

def precheckBehavior
  @precheckBehavior
end

#prefixObject

0-1 string



373
374
375
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 373

def prefix
  @prefix
end

#priorityObject

0-1 code



377
378
379
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 377

def priority
  @priority
end

#reasonObject

0-* [ CodeableConcept ]



379
380
381
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 379

def reason
  @reason
end

#relatedActionObject

0-* [ PlanDefinition::Action::RelatedAction ]



389
390
391
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 389

def relatedAction
  @relatedAction
end

#requiredBehaviorObject

0-1 code



399
400
401
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 399

def requiredBehavior
  @requiredBehavior
end

#selectionBehaviorObject

0-1 code



398
399
400
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 398

def selectionBehavior
  @selectionBehavior
end

#subjectCanonicalObject

0-1 canonical



384
385
386
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 384

def subjectCanonical
  @subjectCanonical
end

#subjectCodeableConceptObject

0-1 CodeableConcept



382
383
384
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 382

def subjectCodeableConcept
  @subjectCodeableConcept
end

#subjectReferenceObject

0-1 Reference(Group)



383
384
385
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 383

def subjectReference
  @subjectReference
end

#textEquivalentObject

0-1 markdown



376
377
378
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 376

def textEquivalent
  @textEquivalent
end

#timingAgeObject

0-1 Age



390
391
392
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 390

def timingAge
  @timingAge
end

#timingDurationObject

0-1 Duration



391
392
393
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 391

def timingDuration
  @timingDuration
end

#timingRangeObject

0-1 Range



392
393
394
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 392

def timingRange
  @timingRange
end

#timingTimingObject

0-1 Timing



393
394
395
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 393

def timingTiming
  @timingTiming
end

#titleObject

0-1 string



374
375
376
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 374

def title
  @title
end

#transformObject

0-1 canonical



404
405
406
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 404

def transform
  @transform
end

#triggerObject

0-* [ TriggerDefinition ]



385
386
387
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 385

def trigger
  @trigger
end

#typeObject

0-1 CodeableConcept



396
397
398
# File 'lib/fhir_models/r5/generated/resources/PlanDefinition.rb', line 396

def type
  @type
end