Class: FHIR::R4B::SubstanceDefinition

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

Defined Under Namespace

Classes: Code, Moiety, MolecularWeight, Name, Property, Relationship, SourceMaterial, Structure

Constant Summary collapse

SEARCH_PARAMS =
['classification', 'code', 'domain', 'identifier', 'name']
METADATA =
{
  'id' => {'type'=>'id', 'path'=>'SubstanceDefinition.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'SubstanceDefinition.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'SubstanceDefinition.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'=>'SubstanceDefinition.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'SubstanceDefinition.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'SubstanceDefinition.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'SubstanceDefinition.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'SubstanceDefinition.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'SubstanceDefinition.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'version' => {'type'=>'string', 'path'=>'SubstanceDefinition.version', 'min'=>0, 'max'=>1},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/publication-status'=>['draft', 'active', 'retired', 'unknown']}, 'type'=>'CodeableConcept', 'path'=>'SubstanceDefinition.status', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/publication-status'}},
  'classification' => {'type'=>'CodeableConcept', 'path'=>'SubstanceDefinition.classification', 'min'=>0, 'max'=>Float::INFINITY},
  'domain' => {'valid_codes'=>{'http://hl7.org/fhir/medicinal-product-domain'=>['Human', 'Veterinary', 'HumanAndVeterinary']}, 'type'=>'CodeableConcept', 'path'=>'SubstanceDefinition.domain', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/medicinal-product-domain'}},
  'grade' => {'valid_codes'=>{'http://hl7.org/fhir/substance-grade'=>['USP-NF', 'Ph.Eur', 'JP', 'BP', 'CompanyStandard']}, 'type'=>'CodeableConcept', 'path'=>'SubstanceDefinition.grade', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/substance-grade'}},
  'description' => {'type'=>'markdown', 'path'=>'SubstanceDefinition.description', 'min'=>0, 'max'=>1},
  'informationSource' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Citation'], 'type'=>'Reference', 'path'=>'SubstanceDefinition.informationSource', 'min'=>0, 'max'=>Float::INFINITY},
  'note' => {'type'=>'Annotation', 'path'=>'SubstanceDefinition.note', 'min'=>0, 'max'=>Float::INFINITY},
  'manufacturer' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', 'path'=>'SubstanceDefinition.manufacturer', 'min'=>0, 'max'=>Float::INFINITY},
  'supplier' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', 'path'=>'SubstanceDefinition.supplier', 'min'=>0, 'max'=>Float::INFINITY},
  'moiety' => {'type'=>'SubstanceDefinition::Moiety', 'path'=>'SubstanceDefinition.moiety', 'min'=>0, 'max'=>Float::INFINITY},
  'property' => {'type'=>'SubstanceDefinition::Property', 'path'=>'SubstanceDefinition.property', 'min'=>0, 'max'=>Float::INFINITY},
  'molecularWeight' => {'type'=>'SubstanceDefinition::MolecularWeight', 'path'=>'SubstanceDefinition.molecularWeight', 'min'=>0, 'max'=>Float::INFINITY},
  'structure' => {'type'=>'SubstanceDefinition::Structure', 'path'=>'SubstanceDefinition.structure', 'min'=>0, 'max'=>1},
  'code' => {'type'=>'SubstanceDefinition::Code', 'path'=>'SubstanceDefinition.code', 'min'=>0, 'max'=>Float::INFINITY},
  'name' => {'type'=>'SubstanceDefinition::Name', 'path'=>'SubstanceDefinition.name', 'min'=>0, 'max'=>Float::INFINITY},
  'relationship' => {'type'=>'SubstanceDefinition::Relationship', 'path'=>'SubstanceDefinition.relationship', 'min'=>0, 'max'=>Float::INFINITY},
  'sourceMaterial' => {'type'=>'SubstanceDefinition::SourceMaterial', 'path'=>'SubstanceDefinition.sourceMaterial', '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::R4B

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

#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

#classificationObject

0-* [ CodeableConcept ]



348
349
350
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 348

def classification
  @classification
end

#codeObject

0-* [ SubstanceDefinition::Code ]



360
361
362
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 360

def code
  @code
end

#containedObject

0-* [ Resource ]



342
343
344
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 342

def contained
  @contained
end

#descriptionObject

0-1 markdown



351
352
353
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 351

def description
  @description
end

#domainObject

0-1 CodeableConcept



349
350
351
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 349

def domain
  @domain
end

#extensionObject

0-* [ Extension ]



343
344
345
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 343

def extension
  @extension
end

#gradeObject

0-* [ CodeableConcept ]



350
351
352
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 350

def grade
  @grade
end

#idObject

0-1 id



337
338
339
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 337

def id
  @id
end

#identifierObject

0-* [ Identifier ]



345
346
347
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 345

def identifier
  @identifier
end

#implicitRulesObject

0-1 uri



339
340
341
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 339

def implicitRules
  @implicitRules
end

#informationSourceObject

0-* [ Reference(Citation) ]



352
353
354
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 352

def informationSource
  @informationSource
end

#languageObject

0-1 code



340
341
342
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 340

def language
  @language
end

#manufacturerObject

0-* [ Reference(Organization) ]



354
355
356
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 354

def manufacturer
  @manufacturer
end

#metaObject

0-1 Meta



338
339
340
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 338

def meta
  @meta
end

#modifierExtensionObject

0-* [ Extension ]



344
345
346
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 344

def modifierExtension
  @modifierExtension
end

#moietyObject

0-* [ SubstanceDefinition::Moiety ]



356
357
358
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 356

def moiety
  @moiety
end

#molecularWeightObject

0-* [ SubstanceDefinition::MolecularWeight ]



358
359
360
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 358

def molecularWeight
  @molecularWeight
end

#nameObject

0-* [ SubstanceDefinition::Name ]



361
362
363
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 361

def name
  @name
end

#noteObject

0-* [ Annotation ]



353
354
355
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 353

def note
  @note
end

#propertyObject

0-* [ SubstanceDefinition::Property ]



357
358
359
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 357

def property
  @property
end

#relationshipObject

0-* [ SubstanceDefinition::Relationship ]



362
363
364
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 362

def relationship
  @relationship
end

#sourceMaterialObject

0-1 SubstanceDefinition::SourceMaterial



363
364
365
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 363

def sourceMaterial
  @sourceMaterial
end

#statusObject

0-1 CodeableConcept



347
348
349
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 347

def status
  @status
end

#structureObject

0-1 SubstanceDefinition::Structure



359
360
361
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 359

def structure
  @structure
end

#supplierObject

0-* [ Reference(Organization) ]



355
356
357
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 355

def supplier
  @supplier
end

#textObject

0-1 Narrative



341
342
343
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 341

def text
  @text
end

#versionObject

0-1 string



346
347
348
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 346

def version
  @version
end

Instance Method Details

#resourceTypeObject



365
366
367
# File 'lib/fhir_models/r4b/generated/resources/SubstanceDefinition.rb', line 365

def resourceType
  'SubstanceDefinition'
end