Class: FHIR::R5::ClinicalUseDefinition

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

Defined Under Namespace

Classes: Contraindication, Indication, Interaction, UndesirableEffect, Warning

Constant Summary collapse

SEARCH_PARAMS =
['contraindication', 'contraindication-reference', 'effect', 'effect-reference', 'identifier', 'indication', 'indication-reference', 'interaction', 'product', 'status', 'subject', 'type']
METADATA =
{
  'id' => {'type'=>'id', 'path'=>'ClinicalUseDefinition.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'ClinicalUseDefinition.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'ClinicalUseDefinition.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'ClinicalUseDefinition.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'additional'=>[{'purpose'=>'starter', 'valueSet'=>'http://hl7.org/fhir/ValueSet/languages'}], 'uri'=>'http://hl7.org/fhir/ValueSet/all-languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'ClinicalUseDefinition.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'ClinicalUseDefinition.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'ClinicalUseDefinition.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'ClinicalUseDefinition.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'ClinicalUseDefinition.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'type' => {'valid_codes'=>{'http://hl7.org/fhir/clinical-use-definition-type'=>['indication', 'contraindication', 'interaction', 'undesirable-effect', 'warning']}, 'type'=>'code', 'path'=>'ClinicalUseDefinition.type', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/clinical-use-definition-type'}},
  'category' => {'valid_codes'=>{'http://hl7.org/fhir/clinical-use-definition-category'=>['Pregnancy', 'Overdose', 'DriveAndMachines']}, 'type'=>'CodeableConcept', 'path'=>'ClinicalUseDefinition.category', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/clinical-use-definition-category'}},
  'subject' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition', 'http://hl7.org/fhir/StructureDefinition/Medication', 'http://hl7.org/fhir/StructureDefinition/ActivityDefinition', 'http://hl7.org/fhir/StructureDefinition/PlanDefinition', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/DeviceDefinition', 'http://hl7.org/fhir/StructureDefinition/Substance', 'http://hl7.org/fhir/StructureDefinition/NutritionProduct', 'http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct'], 'type'=>'Reference', 'path'=>'ClinicalUseDefinition.subject', 'min'=>0, 'max'=>Float::INFINITY},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/publication-status'=>['draft', 'active', 'retired', 'unknown']}, 'type'=>'CodeableConcept', 'path'=>'ClinicalUseDefinition.status', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/publication-status'}},
  'contraindication' => {'type'=>'ClinicalUseDefinition::Contraindication', 'path'=>'ClinicalUseDefinition.contraindication', 'min'=>0, 'max'=>1},
  'indication' => {'type'=>'ClinicalUseDefinition::Indication', 'path'=>'ClinicalUseDefinition.indication', 'min'=>0, 'max'=>1},
  'interaction' => {'type'=>'ClinicalUseDefinition::Interaction', 'path'=>'ClinicalUseDefinition.interaction', 'min'=>0, 'max'=>1},
  'population' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Group'], 'type'=>'Reference', 'path'=>'ClinicalUseDefinition.population', 'min'=>0, 'max'=>Float::INFINITY},
  'library' => {'type'=>'canonical', 'path'=>'ClinicalUseDefinition.library', 'min'=>0, 'max'=>Float::INFINITY},
  'undesirableEffect' => {'type'=>'ClinicalUseDefinition::UndesirableEffect', 'path'=>'ClinicalUseDefinition.undesirableEffect', 'min'=>0, 'max'=>1},
  'warning' => {'type'=>'ClinicalUseDefinition::Warning', 'path'=>'ClinicalUseDefinition.warning', 'min'=>0, 'max'=>1}
}

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

PRIMITIVES, RESOURCES, TYPES

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 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

#categoryObject

0-* [ CodeableConcept ]



218
219
220
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 218

def category
  @category
end

#containedObject

0-* [ Resource ]



213
214
215
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 213

def contained
  @contained
end

#contraindicationObject

0-1 ClinicalUseDefinition::Contraindication



221
222
223
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 221

def contraindication
  @contraindication
end

#extensionObject

0-* [ Extension ]



214
215
216
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 214

def extension
  @extension
end

#idObject

0-1 id



208
209
210
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 208

def id
  @id
end

#identifierObject

0-* [ Identifier ]



216
217
218
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 216

def identifier
  @identifier
end

#implicitRulesObject

0-1 uri



210
211
212
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 210

def implicitRules
  @implicitRules
end

#indicationObject

0-1 ClinicalUseDefinition::Indication



222
223
224
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 222

def indication
  @indication
end

#interactionObject

0-1 ClinicalUseDefinition::Interaction



223
224
225
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 223

def interaction
  @interaction
end

#languageObject

0-1 code



211
212
213
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 211

def language
  @language
end

#libraryObject

0-* [ canonical ]



225
226
227
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 225

def library
  @library
end

#metaObject

0-1 Meta



209
210
211
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 209

def meta
  @meta
end

#modifierExtensionObject

0-* [ Extension ]



215
216
217
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 215

def modifierExtension
  @modifierExtension
end

#populationObject

0-* [ Reference(Group) ]



224
225
226
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 224

def population
  @population
end

#statusObject

0-1 CodeableConcept



220
221
222
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 220

def status
  @status
end

#subjectObject

0-* [ Reference(MedicinalProductDefinition|Medication|ActivityDefinition|PlanDefinition|Device|DeviceDefinition|Substance|NutritionProduct|BiologicallyDerivedProduct) ]



219
220
221
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 219

def subject
  @subject
end

#textObject

0-1 Narrative



212
213
214
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 212

def text
  @text
end

#typeObject

1-1 code



217
218
219
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 217

def type
  @type
end

#undesirableEffectObject

0-1 ClinicalUseDefinition::UndesirableEffect



226
227
228
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 226

def undesirableEffect
  @undesirableEffect
end

#warningObject

0-1 ClinicalUseDefinition::Warning



227
228
229
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 227

def warning
  @warning
end

Instance Method Details

#resourceTypeObject



229
230
231
# File 'lib/fhir_models/r5/generated/resources/ClinicalUseDefinition.rb', line 229

def resourceType
  'ClinicalUseDefinition'
end