Class: FHIR::ResearchDefinition

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

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'=>'ResearchDefinition.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'ResearchDefinition.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'ResearchDefinition.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'=>'ResearchDefinition.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'ResearchDefinition.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'ResearchDefinition.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'ResearchDefinition.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'ResearchDefinition.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'url' => {'type'=>'uri', 'path'=>'ResearchDefinition.url', 'min'=>0, 'max'=>1},
  'identifier' => {'type'=>'Identifier', 'path'=>'ResearchDefinition.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'version' => {'type'=>'string', 'path'=>'ResearchDefinition.version', 'min'=>0, 'max'=>1},
  'name' => {'type'=>'string', 'path'=>'ResearchDefinition.name', 'min'=>0, 'max'=>1},
  'title' => {'type'=>'string', 'path'=>'ResearchDefinition.title', 'min'=>0, 'max'=>1},
  'shortTitle' => {'type'=>'string', 'path'=>'ResearchDefinition.shortTitle', 'min'=>0, 'max'=>1},
  'subtitle' => {'type'=>'string', 'path'=>'ResearchDefinition.subtitle', 'min'=>0, 'max'=>1},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/publication-status'=>['draft', 'active', 'retired', 'unknown']}, 'type'=>'code', 'path'=>'ResearchDefinition.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/publication-status|4.0.0'}},
  'experimental' => {'type'=>'boolean', 'path'=>'ResearchDefinition.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'=>'ResearchDefinition.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'=>'ResearchDefinition.subject[x]', 'min'=>0, 'max'=>1},
  'date' => {'type'=>'dateTime', 'path'=>'ResearchDefinition.date', 'min'=>0, 'max'=>1},
  'publisher' => {'type'=>'string', 'path'=>'ResearchDefinition.publisher', 'min'=>0, 'max'=>1},
  'contact' => {'type'=>'ContactDetail', 'path'=>'ResearchDefinition.contact', 'min'=>0, 'max'=>Float::INFINITY},
  'description' => {'type'=>'markdown', 'path'=>'ResearchDefinition.description', 'min'=>0, 'max'=>1},
  'comment' => {'type'=>'string', 'path'=>'ResearchDefinition.comment', 'min'=>0, 'max'=>Float::INFINITY},
  'useContext' => {'type'=>'UsageContext', 'path'=>'ResearchDefinition.useContext', 'min'=>0, 'max'=>Float::INFINITY},
  'jurisdiction' => {'type'=>'CodeableConcept', 'path'=>'ResearchDefinition.jurisdiction', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/jurisdiction'}},
  'purpose' => {'type'=>'markdown', 'path'=>'ResearchDefinition.purpose', 'min'=>0, 'max'=>1},
  'usage' => {'type'=>'string', 'path'=>'ResearchDefinition.usage', 'min'=>0, 'max'=>1},
  'copyright' => {'type'=>'markdown', 'path'=>'ResearchDefinition.copyright', 'min'=>0, 'max'=>1},
  'approvalDate' => {'type'=>'date', 'path'=>'ResearchDefinition.approvalDate', 'min'=>0, 'max'=>1},
  'lastReviewDate' => {'type'=>'date', 'path'=>'ResearchDefinition.lastReviewDate', 'min'=>0, 'max'=>1},
  'effectivePeriod' => {'type'=>'Period', 'path'=>'ResearchDefinition.effectivePeriod', 'min'=>0, 'max'=>1},
  'topic' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/definition-topic'=>['treatment', 'education', 'assessment']}, 'type'=>'CodeableConcept', 'path'=>'ResearchDefinition.topic', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/definition-topic'}},
  'author' => {'type'=>'ContactDetail', 'path'=>'ResearchDefinition.author', 'min'=>0, 'max'=>Float::INFINITY},
  'editor' => {'type'=>'ContactDetail', 'path'=>'ResearchDefinition.editor', 'min'=>0, 'max'=>Float::INFINITY},
  'reviewer' => {'type'=>'ContactDetail', 'path'=>'ResearchDefinition.reviewer', 'min'=>0, 'max'=>Float::INFINITY},
  'endorser' => {'type'=>'ContactDetail', 'path'=>'ResearchDefinition.endorser', 'min'=>0, 'max'=>Float::INFINITY},
  'relatedArtifact' => {'type'=>'RelatedArtifact', 'path'=>'ResearchDefinition.relatedArtifact', 'min'=>0, 'max'=>Float::INFINITY},
  'library' => {'type'=>'canonical', 'path'=>'ResearchDefinition.library', 'min'=>0, 'max'=>Float::INFINITY},
  'population' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition'], 'type'=>'Reference', 'path'=>'ResearchDefinition.population', 'min'=>1, 'max'=>1},
  'exposure' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition'], 'type'=>'Reference', 'path'=>'ResearchDefinition.exposure', 'min'=>0, 'max'=>1},
  'exposureAlternative' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition'], 'type'=>'Reference', 'path'=>'ResearchDefinition.exposureAlternative', 'min'=>0, 'max'=>1},
  'outcome' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition'], 'type'=>'Reference', 'path'=>'ResearchDefinition.outcome', 'min'=>0, 'max'=>1}
}

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



86
87
88
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 86

def approvalDate
  @approvalDate
end

#author ⇒ Object

0-* [ ContactDetail ]



90
91
92
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 90

def author
  @author
end

#comment ⇒ Object

0-* [ string ]



80
81
82
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 80

def comment
  @comment
end

#contact ⇒ Object

0-* [ ContactDetail ]



78
79
80
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 78

def contact
  @contact
end

#contained ⇒ Object

0-* [ Resource ]



62
63
64
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 62

def contained
  @contained
end

#copyright ⇒ Object

0-1 markdown



85
86
87
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 85

def copyright
  @copyright
end

#date ⇒ Object

0-1 dateTime



76
77
78
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 76

def date
  @date
end

#description ⇒ Object

0-1 markdown



79
80
81
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 79

def description
  @description
end

#editor ⇒ Object

0-* [ ContactDetail ]



91
92
93
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 91

def editor
  @editor
end

#effectivePeriod ⇒ Object

0-1 Period



88
89
90
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 88

def effectivePeriod
  @effectivePeriod
end

#endorser ⇒ Object

0-* [ ContactDetail ]



93
94
95
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 93

def endorser
  @endorser
end

#experimental ⇒ Object

0-1 boolean



73
74
75
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 73

def experimental
  @experimental
end

#exposure ⇒ Object

0-1 Reference(ResearchElementDefinition)



97
98
99
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 97

def exposure
  @exposure
end

#exposureAlternative ⇒ Object

0-1 Reference(ResearchElementDefinition)



98
99
100
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 98

def exposureAlternative
  @exposureAlternative
end

#extension ⇒ Object

0-* [ Extension ]



63
64
65
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 63

def extension
  @extension
end

#id ⇒ Object

0-1 id



57
58
59
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 57

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



66
67
68
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 66

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



59
60
61
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 59

def implicitRules
  @implicitRules
end

#jurisdiction ⇒ Object

0-* [ CodeableConcept ]



82
83
84
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 82

def jurisdiction
  @jurisdiction
end

#language ⇒ Object

0-1 code



60
61
62
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 60

def language
  @language
end

#lastReviewDate ⇒ Object

0-1 date



87
88
89
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 87

def lastReviewDate
  @lastReviewDate
end

#library ⇒ Object

0-* [ canonical ]



95
96
97
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 95

def library
  @library
end

#meta ⇒ Object

0-1 Meta



58
59
60
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 58

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



64
65
66
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 64

def modifierExtension
  @modifierExtension
end

#name ⇒ Object

0-1 string



68
69
70
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 68

def name
  @name
end

#outcome ⇒ Object

0-1 Reference(ResearchElementDefinition)



99
100
101
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 99

def outcome
  @outcome
end

#population ⇒ Object

1-1 Reference(ResearchElementDefinition)



96
97
98
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 96

def population
  @population
end

#publisher ⇒ Object

0-1 string



77
78
79
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 77

def publisher
  @publisher
end

#purpose ⇒ Object

0-1 markdown



83
84
85
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 83

def purpose
  @purpose
end

#relatedArtifact ⇒ Object

0-* [ RelatedArtifact ]



94
95
96
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 94

def relatedArtifact
  @relatedArtifact
end

#reviewer ⇒ Object

0-* [ ContactDetail ]



92
93
94
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 92

def reviewer
  @reviewer
end

#shortTitle ⇒ Object

0-1 string



70
71
72
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 70

def shortTitle
  @shortTitle
end

#status ⇒ Object

1-1 code



72
73
74
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 72

def status
  @status
end

#subjectCodeableConcept ⇒ Object

0-1 CodeableConcept



74
75
76
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 74

def subjectCodeableConcept
  @subjectCodeableConcept
end

#subjectReference ⇒ Object

0-1 Reference(Group)



75
76
77
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 75

def subjectReference
  @subjectReference
end

#subtitle ⇒ Object

0-1 string



71
72
73
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 71

def subtitle
  @subtitle
end

#text ⇒ Object

0-1 Narrative



61
62
63
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 61

def text
  @text
end

#title ⇒ Object

0-1 string



69
70
71
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 69

def title
  @title
end

#topic ⇒ Object

0-* [ CodeableConcept ]



89
90
91
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 89

def topic
  @topic
end

#url ⇒ Object

0-1 uri



65
66
67
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 65

def url
  @url
end

#usage ⇒ Object

0-1 string



84
85
86
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 84

def usage
  @usage
end

#useContext ⇒ Object

0-* [ UsageContext ]



81
82
83
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 81

def useContext
  @useContext
end

#version ⇒ Object

0-1 string



67
68
69
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 67

def version
  @version
end

Instance Method Details

#resourceType ⇒ Object 



101
102
103
 
# File 'lib/fhir_models/fhir/resources/ResearchDefinition.rb', line 101

def resourceType
  'ResearchDefinition'
end