Class: FHIR::ResearchElementDefinition

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

Defined Under Namespace

Classes: Characteristic

Constant Summary collapse

MULTIPLE_TYPES = 
{
  'subject' => ['CodeableConcept', 'Reference']
}
SEARCH_PARAMS = 
['composed-of', 'context', 'context-quantity', 'context-type', 'date', 'depends-on', 'derived-from', 'description', 'effective', 'identifier', 'jurisdiction', 'name', 'predecessor', 'publisher', 'status', 'successor', 'title', 'topic', 'url', 'version']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'ResearchElementDefinition.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'ResearchElementDefinition.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'ResearchElementDefinition.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'=>'ResearchElementDefinition.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'ResearchElementDefinition.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'ResearchElementDefinition.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'ResearchElementDefinition.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'ResearchElementDefinition.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'url' => {'type'=>'uri', 'path'=>'ResearchElementDefinition.url', 'min'=>0, 'max'=>1},
  'identifier' => {'type'=>'Identifier', 'path'=>'ResearchElementDefinition.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'version' => {'type'=>'string', 'path'=>'ResearchElementDefinition.version', 'min'=>0, 'max'=>1},
  'name' => {'type'=>'string', 'path'=>'ResearchElementDefinition.name', 'min'=>0, 'max'=>1},
  'title' => {'type'=>'string', 'path'=>'ResearchElementDefinition.title', 'min'=>0, 'max'=>1},
  'shortTitle' => {'type'=>'string', 'path'=>'ResearchElementDefinition.shortTitle', 'min'=>0, 'max'=>1},
  'subtitle' => {'type'=>'string', 'path'=>'ResearchElementDefinition.subtitle', 'min'=>0, 'max'=>1},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/publication-status'=>['draft', 'active', 'retired', 'unknown']}, 'type'=>'code', 'path'=>'ResearchElementDefinition.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/publication-status|4.0.0'}},
  'experimental' => {'type'=>'boolean', 'path'=>'ResearchElementDefinition.experimental', 'min'=>0, 'max'=>1},
  'subjectCodeableConcept' => {'valid_codes'=>{'http://hl7.org/fhir/resource-types'=>['Patient', 'Practitioner', 'Organization', 'Location', 'Device', 'Account', 'ActivityDefinition', 'AdverseEvent', 'AllergyIntolerance', 'Appointment', 'AppointmentResponse', 'AuditEvent', 'Basic', 'Binary', 'BiologicallyDerivedProduct', 'BodyStructure', 'Bundle', 'CapabilityStatement', 'CarePlan', 'CareTeam', 'CatalogEntry', 'ChargeItem', 'ChargeItemDefinition', 'Claim', 'ClaimResponse', 'ClinicalImpression', 'CodeSystem', 'Communication', 'CommunicationRequest', 'CompartmentDefinition', 'Composition', 'ConceptMap', 'Condition', 'Consent', 'Contract', 'Coverage', 'CoverageEligibilityRequest', 'CoverageEligibilityResponse', 'DetectedIssue', 'DeviceDefinition', 'DeviceMetric', 'DeviceRequest', 'DeviceUseStatement', 'DiagnosticReport', 'DocumentManifest', 'DocumentReference', 'DomainResource', 'EffectEvidenceSynthesis', 'Encounter', 'Endpoint', 'EnrollmentRequest', 'EnrollmentResponse', 'EpisodeOfCare', 'EventDefinition', 'Evidence', 'EvidenceVariable', 'ExampleScenario', 'ExplanationOfBenefit', 'FamilyMemberHistory', 'Flag', 'Goal', 'GraphDefinition', 'Group', 'GuidanceResponse', 'HealthcareService', 'ImagingStudy', 'Immunization', 'ImmunizationEvaluation', 'ImmunizationRecommendation', 'ImplementationGuide', 'InsurancePlan', 'Invoice', 'Library', 'Linkage', 'List', 'Measure', 'MeasureReport', 'Media', 'Medication', 'MedicationAdministration', 'MedicationDispense', 'MedicationKnowledge', 'MedicationRequest', 'MedicationStatement', 'MedicinalProduct', 'MedicinalProductAuthorization', 'MedicinalProductContraindication', 'MedicinalProductIndication', 'MedicinalProductIngredient', 'MedicinalProductInteraction', 'MedicinalProductManufactured', 'MedicinalProductPackaged', 'MedicinalProductPharmaceutical', 'MedicinalProductUndesirableEffect', 'MessageDefinition', 'MessageHeader', 'MolecularSequence', 'NamingSystem', 'NutritionOrder', 'Observation', 'ObservationDefinition', 'OperationDefinition', 'OperationOutcome', 'OrganizationAffiliation', 'Parameters', 'PaymentNotice', 'PaymentReconciliation', 'Person', 'PlanDefinition', 'PractitionerRole', 'Procedure', 'Provenance', 'Questionnaire', 'QuestionnaireResponse', 'RelatedPerson', 'RequestGroup', 'ResearchDefinition', 'ResearchElementDefinition', 'ResearchStudy', 'ResearchSubject', 'Resource', 'RiskAssessment', 'RiskEvidenceSynthesis', 'Schedule', 'SearchParameter', 'ServiceRequest', 'Slot', 'Specimen', 'SpecimenDefinition', 'StructureDefinition', 'StructureMap', 'Subscription', 'Substance', 'SubstanceNucleicAcid', 'SubstancePolymer', 'SubstanceProtein', 'SubstanceReferenceInformation', 'SubstanceSourceMaterial', 'SubstanceSpecification', 'SupplyDelivery', 'SupplyRequest', 'Task', 'TerminologyCapabilities', 'TestReport', 'TestScript', 'ValueSet', 'VerificationResult', 'VisionPrescription']}, 'type'=>'CodeableConcept', 'path'=>'ResearchElementDefinition.subject[x]', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/subject-type'}},
  'subjectReference' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Group'], 'type'=>'Reference', 'path'=>'ResearchElementDefinition.subject[x]', 'min'=>0, 'max'=>1},
  'date' => {'type'=>'dateTime', 'path'=>'ResearchElementDefinition.date', 'min'=>0, 'max'=>1},
  'publisher' => {'type'=>'string', 'path'=>'ResearchElementDefinition.publisher', 'min'=>0, 'max'=>1},
  'contact' => {'type'=>'ContactDetail', 'path'=>'ResearchElementDefinition.contact', 'min'=>0, 'max'=>Float::INFINITY},
  'description' => {'type'=>'markdown', 'path'=>'ResearchElementDefinition.description', 'min'=>0, 'max'=>1},
  'comment' => {'type'=>'string', 'path'=>'ResearchElementDefinition.comment', 'min'=>0, 'max'=>Float::INFINITY},
  'useContext' => {'type'=>'UsageContext', 'path'=>'ResearchElementDefinition.useContext', 'min'=>0, 'max'=>Float::INFINITY},
  'jurisdiction' => {'type'=>'CodeableConcept', 'path'=>'ResearchElementDefinition.jurisdiction', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/jurisdiction'}},
  'purpose' => {'type'=>'markdown', 'path'=>'ResearchElementDefinition.purpose', 'min'=>0, 'max'=>1},
  'usage' => {'type'=>'string', 'path'=>'ResearchElementDefinition.usage', 'min'=>0, 'max'=>1},
  'copyright' => {'type'=>'markdown', 'path'=>'ResearchElementDefinition.copyright', 'min'=>0, 'max'=>1},
  'approvalDate' => {'type'=>'date', 'path'=>'ResearchElementDefinition.approvalDate', 'min'=>0, 'max'=>1},
  'lastReviewDate' => {'type'=>'date', 'path'=>'ResearchElementDefinition.lastReviewDate', 'min'=>0, 'max'=>1},
  'effectivePeriod' => {'type'=>'Period', 'path'=>'ResearchElementDefinition.effectivePeriod', 'min'=>0, 'max'=>1},
  'topic' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/definition-topic'=>['treatment', 'education', 'assessment']}, 'type'=>'CodeableConcept', 'path'=>'ResearchElementDefinition.topic', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/definition-topic'}},
  'author' => {'type'=>'ContactDetail', 'path'=>'ResearchElementDefinition.author', 'min'=>0, 'max'=>Float::INFINITY},
  'editor' => {'type'=>'ContactDetail', 'path'=>'ResearchElementDefinition.editor', 'min'=>0, 'max'=>Float::INFINITY},
  'reviewer' => {'type'=>'ContactDetail', 'path'=>'ResearchElementDefinition.reviewer', 'min'=>0, 'max'=>Float::INFINITY},
  'endorser' => {'type'=>'ContactDetail', 'path'=>'ResearchElementDefinition.endorser', 'min'=>0, 'max'=>Float::INFINITY},
  'relatedArtifact' => {'type'=>'RelatedArtifact', 'path'=>'ResearchElementDefinition.relatedArtifact', 'min'=>0, 'max'=>Float::INFINITY},
  'library' => {'type'=>'canonical', 'path'=>'ResearchElementDefinition.library', 'min'=>0, 'max'=>Float::INFINITY},
  'type' => {'valid_codes'=>{'http://hl7.org/fhir/research-element-type'=>['population', 'exposure', 'outcome']}, 'type'=>'code', 'path'=>'ResearchElementDefinition.type', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/research-element-type|4.0.0'}},
  'variableType' => {'valid_codes'=>{'http://hl7.org/fhir/variable-type'=>['dichotomous', 'continuous', 'descriptive']}, 'type'=>'code', 'path'=>'ResearchElementDefinition.variableType', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/variable-type|4.0.0'}},
  'characteristic' => {'type'=>'ResearchElementDefinition::Characteristic', 'path'=>'ResearchElementDefinition.characteristic', 'min'=>1, 'max'=>Float::INFINITY}
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Xml

from_xml, #to_xml, valid?, validate

Methods included from Deprecate

#deprecate

Methods included from Json

from_json, #to_json

Methods included from Hashable

#from_hash, #to_hash

Methods inherited from Model

#==, #attribute_mismatch, #compare_attribute, #equals?, #hash, #initialize, #method_missing, #mismatch, #primitive?, #to_reference, #valid?, #validate, #validate_profile

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

#approvalDate ⇒ Object

0-1 date



148
149
150
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 148

def approvalDate
  @approvalDate
end

#author ⇒ Object

0-* [ ContactDetail ]



152
153
154
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 152

def author
  @author
end

#characteristic ⇒ Object

1-* [ ResearchElementDefinition::Characteristic ]



160
161
162
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 160

def characteristic
  @characteristic
end

#comment ⇒ Object

0-* [ string ]



142
143
144
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 142

def comment
  @comment
end

#contact ⇒ Object

0-* [ ContactDetail ]



140
141
142
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 140

def contact
  @contact
end

#contained ⇒ Object

0-* [ Resource ]



124
125
126
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 124

def contained
  @contained
end

#copyright ⇒ Object

0-1 markdown



147
148
149
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 147

def copyright
  @copyright
end

#date ⇒ Object

0-1 dateTime



138
139
140
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 138

def date
  @date
end

#description ⇒ Object

0-1 markdown



141
142
143
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 141

def description
  @description
end

#editor ⇒ Object

0-* [ ContactDetail ]



153
154
155
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 153

def editor
  @editor
end

#effectivePeriod ⇒ Object

0-1 Period



150
151
152
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 150

def effectivePeriod
  @effectivePeriod
end

#endorser ⇒ Object

0-* [ ContactDetail ]



155
156
157
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 155

def endorser
  @endorser
end

#experimental ⇒ Object

0-1 boolean



135
136
137
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 135

def experimental
  @experimental
end

#extension ⇒ Object

0-* [ Extension ]



125
126
127
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 125

def extension
  @extension
end

#id ⇒ Object

0-1 id



119
120
121
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 119

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



128
129
130
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 128

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



121
122
123
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 121

def implicitRules
  @implicitRules
end

#jurisdiction ⇒ Object

0-* [ CodeableConcept ]



144
145
146
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 144

def jurisdiction
  @jurisdiction
end

#language ⇒ Object

0-1 code



122
123
124
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 122

def language
  @language
end

#lastReviewDate ⇒ Object

0-1 date



149
150
151
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 149

def lastReviewDate
  @lastReviewDate
end

#library ⇒ Object

0-* [ canonical ]



157
158
159
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 157

def library
  @library
end

#meta ⇒ Object

0-1 Meta



120
121
122
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 120

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



126
127
128
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 126

def modifierExtension
  @modifierExtension
end

#name ⇒ Object

0-1 string



130
131
132
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 130

def name
  @name
end

#publisher ⇒ Object

0-1 string



139
140
141
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 139

def publisher
  @publisher
end

#purpose ⇒ Object

0-1 markdown



145
146
147
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 145

def purpose
  @purpose
end

#relatedArtifact ⇒ Object

0-* [ RelatedArtifact ]



156
157
158
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 156

def relatedArtifact
  @relatedArtifact
end

#reviewer ⇒ Object

0-* [ ContactDetail ]



154
155
156
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 154

def reviewer
  @reviewer
end

#shortTitle ⇒ Object

0-1 string



132
133
134
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 132

def shortTitle
  @shortTitle
end

#status ⇒ Object

1-1 code



134
135
136
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 134

def status
  @status
end

#subjectCodeableConcept ⇒ Object

0-1 CodeableConcept



136
137
138
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 136

def subjectCodeableConcept
  @subjectCodeableConcept
end

#subjectReference ⇒ Object

0-1 Reference(Group)



137
138
139
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 137

def subjectReference
  @subjectReference
end

#subtitle ⇒ Object

0-1 string



133
134
135
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 133

def subtitle
  @subtitle
end

#text ⇒ Object

0-1 Narrative



123
124
125
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 123

def text
  @text
end

#title ⇒ Object

0-1 string



131
132
133
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 131

def title
  @title
end

#topic ⇒ Object

0-* [ CodeableConcept ]



151
152
153
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 151

def topic
  @topic
end

#type ⇒ Object

1-1 code



158
159
160
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 158

def type
  @type
end

#url ⇒ Object

0-1 uri



127
128
129
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 127

def url
  @url
end

#usage ⇒ Object

0-1 string



146
147
148
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 146

def usage
  @usage
end

#useContext ⇒ Object

0-* [ UsageContext ]



143
144
145
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 143

def useContext
  @useContext
end

#variableType ⇒ Object

0-1 code



159
160
161
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 159

def variableType
  @variableType
end

#version ⇒ Object

0-1 string



129
130
131
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 129

def version
  @version
end

Instance Method Details

#resourceType ⇒ Object 



162
163
164
 
# File 'lib/fhir_models/fhir/resources/ResearchElementDefinition.rb', line 162

def resourceType
  'ResearchElementDefinition'
end