Class: FHIR::R5::Specimen

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

Defined Under Namespace

Classes: Collection, Container, Feature, Processing

Constant Summary collapse

SEARCH_PARAMS = 
['accession', 'bodysite', 'collected', 'collector', 'container-device', 'identifier', 'parent', 'patient', 'procedure', 'status', 'subject', 'type']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'Specimen.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'Specimen.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'Specimen.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'Specimen.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'=>'Specimen.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'Specimen.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'Specimen.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'Specimen.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'Specimen.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'accessionIdentifier' => {'type'=>'Identifier', 'path'=>'Specimen.accessionIdentifier', 'min'=>0, 'max'=>1},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/specimen-status'=>['available', 'unavailable', 'unsatisfactory', 'entered-in-error']}, 'type'=>'code', 'path'=>'Specimen.status', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/specimen-status'}},
  'type' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v2-0487'=>['ABS', '...', 'ACNE', 'ACNFLD', 'AIRS', 'ALL', 'AMN', 'AMP', 'ANGI', 'ARTC', 'ASERU', 'ASP', 'ATTE', 'AUTOA', 'AUTOC', 'AUTP', 'BBL', 'BCYST', 'BDY', 'BIFL', 'BITE', 'BLD', 'BLDA', 'BLDCO', 'BLDV', 'BLEB', 'BLIST', 'BOIL', 'BON', 'BOWL', 'BPH', 'BPU', 'BRN', 'BRSH', 'BRTH', 'BRUS', 'BUB', 'BULLA', 'BX', 'CALC', 'BONE', 'CARBU', 'CAT', 'CBITE', 'CDM', 'CLIPP', 'CNJT', 'CNL', 'COL', 'CONE', 'CSCR', 'CSERU', 'CSF', 'CSITE', 'CSMY', 'CST', 'CSVR', 'CTP', 'CUR', 'CVM', 'CVPS', 'CVPT', 'CYN', 'CYST', 'DBITE', 'DCS', 'DEC', 'DEION', 'DIA', 'DIAF', 'DISCHG', 'DIV', 'DRN', 'DRNG', 'DRNGP', 'DUFL', 'EARW', 'EBRUSH', 'EEYE', 'EFF', 'EFFUS', 'EFOD', 'EISO', 'ELT', 'ENVIR', 'EOS', 'EOTH', 'ESOI', 'ESOS', 'ETA', 'ETTP', 'ETTUB', 'EWHI', 'EXG', 'EXS', 'EXUDTE', 'FAW', 'FBLOOD', 'FGA', 'FIB', 'FIST', 'FLD', 'FLT', 'FLU', 'FLUID', 'FOLEY', 'FRS', 'FSCLP', 'FUR', 'GAS', 'GASA', 'GASAN', 'GASBR', 'GASD', 'GAST', 'GENL', 'GENV', 'GRAFT', 'GRAFTS', 'GRANU', 'GROSH', 'GSOL', 'GSPEC', 'GT', 'GTUBE', 'HAR', 'HBITE', 'HBLUD', 'HEMAQ', 'HEMO', 'HERNI', 'HEV', 'HIC', 'HYDC', 'IBITE', 'ICYST', 'IDC', 'IHG', 'ILEO', 'ILLEG', 'IMP', 'INCI', 'INFIL', 'INS', 'INTRD', 'ISLT', 'IT', 'IUD', 'IVCAT', 'IVFLD', 'IVTIP', 'JEJU', 'JNTFLD', 'JP', 'KELOI', 'KIDFLD', 'LAVG', 'LAVGG', 'LAVGP', 'LAVPG', 'LENS1', 'LENS2', 'LESN', 'LIQ', 'LIQO', 'LNA', 'LNV', 'LSAC', 'LYM', 'MAC', 'MAHUR', 'MAR', 'MASS', 'MBLD', 'MEC', 'MILK', 'MLK', 'MUCOS', 'MUCUS', 'NAIL', 'NASDR', 'NEDL', 'NEPH', 'NGASP', 'NGAST', 'NGS', 'NODUL', 'NSECR', 'ORH', 'ORL', 'OTH', 'PACEM', 'PAFL', 'PCFL', 'PDSIT', 'PDTS', 'PELVA', 'PENIL', 'PERIA', 'PILOC', 'PINS', 'PIS', 'PLAN', 'PLAS', 'PLB', 'PLC', 'PLEVS', 'PLR', 'PMN', 'PND', 'POL', 'POPGS', 'POPLG', 'POPLV', 'PORTA', 'PPP', 'PROST', 'PRP', 'PSC', 'PUNCT', 'PUS', 'PUSFR', 'PUST', 'QC3', 'RANDU', 'RBC', 'RBITE', 'RECT', 'RECTA', 'RENALC', 'RENC', 'RES', 'SAL', 'SCAR', 'SCLV', 'SCROA', 'SECRE', 'SER', 'SHU', 'SHUNF', 'SHUNT', 'SITE', 'SKBP', 'SKN', 'SMM', 'SMN', 'SNV', 'SPRM', 'SPRP', 'SPRPB', 'SPS', 'SPT', 'SPTC', 'SPTT', 'SPUT1', 'SPUTIN', 'SPUTSP', 'STER', 'STL', 'STONE', 'SUBMA', 'SUBMX', 'SUMP', 'SUP', 'SUTUR', 'SWGZ', 'SWT', 'TASP', 'TEAR', 'THRB', 'TISS', 'TISU', 'TLC', 'TRAC', 'TRANS', 'TSERU', 'TSTES', 'TTRA', 'TUBES', 'TUMOR', 'TZANC', 'UDENT', 'UMED', 'UR', 'URC', 'URINB', 'URINC', 'URINM', 'URINN', 'URINP', 'URNS', 'URT', 'USCOP', 'USPEC', 'USUB', 'VASTIP', 'VENT', 'VITF', 'VOM', 'WASH', 'WASI', 'WAT', 'WB', 'WBC', 'WEN', 'WICK', 'WND', 'WNDA', 'WNDD', 'WNDE', 'WORM', 'WRT', 'WWA', 'WWO', 'WWT']}, 'type'=>'CodeableConcept', 'path'=>'Specimen.type', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://terminology.hl7.org/ValueSet/v2-0487'}},
  'subject' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct', 'http://hl7.org/fhir/StructureDefinition/Substance', 'http://hl7.org/fhir/StructureDefinition/Location'], 'type'=>'Reference', 'path'=>'Specimen.subject', 'min'=>0, 'max'=>1},
  'receivedTime' => {'type'=>'dateTime', 'path'=>'Specimen.receivedTime', 'min'=>0, 'max'=>1},
  'parent' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Specimen'], 'type'=>'Reference', 'path'=>'Specimen.parent', 'min'=>0, 'max'=>Float::INFINITY},
  'request' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/ServiceRequest'], 'type'=>'Reference', 'path'=>'Specimen.request', 'min'=>0, 'max'=>Float::INFINITY},
  'combined' => {'valid_codes'=>{'http://hl7.org/fhir/specimen-combined'=>['grouped', 'pooled']}, 'type'=>'code', 'path'=>'Specimen.combined', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/specimen-combined'}},
  'role' => {'valid_codes'=>{'http://hl7.org/fhir/specimen-role'=>['b', 'c', 'e', 'f', 'o', 'p', 'q', 'r', 'v']}, 'type'=>'CodeableConcept', 'path'=>'Specimen.role', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/specimen-role'}},
  'feature' => {'type'=>'Specimen::Feature', 'path'=>'Specimen.feature', 'min'=>0, 'max'=>Float::INFINITY},
  'collection' => {'type'=>'Specimen::Collection', 'path'=>'Specimen.collection', 'min'=>0, 'max'=>1},
  'processing' => {'type'=>'Specimen::Processing', 'path'=>'Specimen.processing', 'min'=>0, 'max'=>Float::INFINITY},
  'container' => {'type'=>'Specimen::Container', 'path'=>'Specimen.container', 'min'=>0, 'max'=>Float::INFINITY},
  'condition' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v2-0493'=>['AUT', 'CLOT', 'CON', 'COOL', 'FROZ', 'HEM', 'LIVE', 'ROOM', 'SNR', 'CFU']}, 'type'=>'CodeableConcept', 'path'=>'Specimen.condition', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://terminology.hl7.org/ValueSet/v2-0493'}},
  'note' => {'type'=>'Annotation', 'path'=>'Specimen.note', '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

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

#accessionIdentifier ⇒ Object

0-1 Identifier



158
159
160
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 158

def accessionIdentifier
  @accessionIdentifier
end

#collection ⇒ Object

0-1 Specimen::Collection



168
169
170
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 168

def collection
  @collection
end

#combined ⇒ Object

0-1 code



165
166
167
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 165

def combined
  @combined
end

#condition ⇒ Object

0-* [ CodeableConcept ]



171
172
173
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 171

def condition
  @condition
end

#contained ⇒ Object

0-* [ Resource ]



154
155
156
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 154

def contained
  @contained
end

#container ⇒ Object

0-* [ Specimen::Container ]



170
171
172
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 170

def container
  @container
end

#extension ⇒ Object

0-* [ Extension ]



155
156
157
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 155

def extension
  @extension
end

#feature ⇒ Object

0-* [ Specimen::Feature ]



167
168
169
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 167

def feature
  @feature
end

#id ⇒ Object

0-1 id



149
150
151
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 149

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



157
158
159
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 157

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



151
152
153
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 151

def implicitRules
  @implicitRules
end

#language ⇒ Object

0-1 code



152
153
154
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 152

def language
  @language
end

#meta ⇒ Object

0-1 Meta



150
151
152
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 150

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



156
157
158
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 156

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



172
173
174
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 172

def note
  @note
end

#parent ⇒ Object

0-* [ Reference(Specimen) ]



163
164
165
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 163

def parent
  @parent
end

#processing ⇒ Object

0-* [ Specimen::Processing ]



169
170
171
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 169

def processing
  @processing
end

#receivedTime ⇒ Object

0-1 dateTime



162
163
164
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 162

def receivedTime
  @receivedTime
end

#request ⇒ Object

0-* [ Reference(ServiceRequest) ]



164
165
166
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 164

def request
  @request
end

#role ⇒ Object

0-* [ CodeableConcept ]



166
167
168
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 166

def role
  @role
end

#status ⇒ Object

0-1 code



159
160
161
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 159

def status
  @status
end

#subject ⇒ Object

0-1 Reference(Patient|Group|Device|BiologicallyDerivedProduct|Substance|Location)



161
162
163
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 161

def subject
  @subject
end

#text ⇒ Object

0-1 Narrative



153
154
155
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 153

def text
  @text
end

#type ⇒ Object

0-1 CodeableConcept



160
161
162
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 160

def type
  @type
end

Instance Method Details

#resourceType ⇒ Object 



174
175
176
 
# File 'lib/fhir_models/r5/generated/resources/Specimen.rb', line 174

def resourceType
  'Specimen'
end