Class: FHIR::R5::SubstanceDefinition

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

Defined Under Namespace

Classes: Characterization, 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' => {'type'=>'code', 'path'=>'SubstanceDefinition.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'=>'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},
  'characterization' => {'type'=>'SubstanceDefinition::Characterization', 'path'=>'SubstanceDefinition.characterization', 'min'=>0, 'max'=>Float::INFINITY},
  'property' => {'type'=>'SubstanceDefinition::Property', 'path'=>'SubstanceDefinition.property', 'min'=>0, 'max'=>Float::INFINITY},
  'referenceInformation' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation'], 'type'=>'Reference', 'path'=>'SubstanceDefinition.referenceInformation', 'min'=>0, 'max'=>1},
  '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},
  'nucleicAcid' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid'], 'type'=>'Reference', 'path'=>'SubstanceDefinition.nucleicAcid', 'min'=>0, 'max'=>1},
  'polymer' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/SubstancePolymer'], 'type'=>'Reference', 'path'=>'SubstanceDefinition.polymer', 'min'=>0, 'max'=>1},
  'protein' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/SubstanceProtein'], 'type'=>'Reference', 'path'=>'SubstanceDefinition.protein', 'min'=>0, 'max'=>1},
  '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::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

#characterization ⇒ Object

0-* [ SubstanceDefinition::Characterization ]



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

def characterization
  @characterization
end

#classification ⇒ Object

0-* [ CodeableConcept ]



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

def classification
  @classification
end

#code ⇒ Object

0-* [ SubstanceDefinition::Code ]



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

def code
  @code
end

#contained ⇒ Object

0-* [ Resource ]



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

def contained
  @contained
end

#description ⇒ Object

0-1 markdown



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

def description
  @description
end

#domain ⇒ Object

0-1 CodeableConcept



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

def domain
  @domain
end

#extension ⇒ Object

0-* [ Extension ]



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

def extension
  @extension
end

#grade ⇒ Object

0-* [ CodeableConcept ]



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

def grade
  @grade
end

#id ⇒ Object

0-1 id



366
367
368
 
# File 'lib/fhir_models/r5/generated/resources/SubstanceDefinition.rb', line 366

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



368
369
370
 
# File 'lib/fhir_models/r5/generated/resources/SubstanceDefinition.rb', line 368

def implicitRules
  @implicitRules
end

#informationSource ⇒ Object

0-* [ Reference(Citation) ]



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

def informationSource
  @informationSource
end

#language ⇒ Object

0-1 code



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

def language
  @language
end

#manufacturer ⇒ Object

0-* [ Reference(Organization) ]



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

def manufacturer
  @manufacturer
end

#meta ⇒ Object

0-1 Meta



367
368
369
 
# File 'lib/fhir_models/r5/generated/resources/SubstanceDefinition.rb', line 367

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#moiety ⇒ Object

0-* [ SubstanceDefinition::Moiety ]



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

def moiety
  @moiety
end

#molecularWeight ⇒ Object

0-* [ SubstanceDefinition::MolecularWeight ]



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

def molecularWeight
  @molecularWeight
end

#name ⇒ Object

0-* [ SubstanceDefinition::Name ]



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

def name
  @name
end

#note ⇒ Object

0-* [ Annotation ]



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

def note
  @note
end

#nucleicAcid ⇒ Object

0-1 Reference(SubstanceNucleicAcid)



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

def nucleicAcid
  @nucleicAcid
end

#polymer ⇒ Object

0-1 Reference(SubstancePolymer)



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

def polymer
  @polymer
end

#property ⇒ Object

0-* [ SubstanceDefinition::Property ]



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

def property
  @property
end

#protein ⇒ Object

0-1 Reference(SubstanceProtein)



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

def protein
  @protein
end

#referenceInformation ⇒ Object

0-1 Reference(SubstanceReferenceInformation)



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

def referenceInformation
  @referenceInformation
end

#relationship ⇒ Object

0-* [ SubstanceDefinition::Relationship ]



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

def relationship
  @relationship
end

#sourceMaterial ⇒ Object

0-1 SubstanceDefinition::SourceMaterial



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

def sourceMaterial
  @sourceMaterial
end

#status ⇒ Object

0-1 CodeableConcept



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

def status
  @status
end

#structure ⇒ Object

0-1 SubstanceDefinition::Structure



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

def structure
  @structure
end

#supplier ⇒ Object

0-* [ Reference(Organization) ]



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

def supplier
  @supplier
end

#text ⇒ Object

0-1 Narrative



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

def text
  @text
end

#version ⇒ Object

0-1 string



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

def version
  @version
end

Instance Method Details

#resourceType ⇒ Object 



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

def resourceType
  'SubstanceDefinition'
end