Class: FHIR::STU3::SearchParameter

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

Defined Under Namespace

Classes: Component

Constant Summary collapse

SEARCH_PARAMS = 
['base', 'code', 'component', 'date', 'derived-from', 'description', 'jurisdiction', 'name', 'publisher', 'status', 'target', 'type', 'url', 'version']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'SearchParameter.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'SearchParameter.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'SearchParameter.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', 'pt', 'pt-BR', 'ru', 'ru-RU', 'sr', 'sr-SP', 'sv', 'sv-SE', 'te', 'zh', 'zh-CN', 'zh-HK', 'zh-SG', 'zh-TW']}, 'type'=>'code', 'path'=>'SearchParameter.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'SearchParameter.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'SearchParameter.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'SearchParameter.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'SearchParameter.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'url' => {'type'=>'uri', 'path'=>'SearchParameter.url', 'min'=>1, 'max'=>1},
  'version' => {'type'=>'string', 'path'=>'SearchParameter.version', 'min'=>0, 'max'=>1},
  'name' => {'type'=>'string', 'path'=>'SearchParameter.name', 'min'=>1, 'max'=>1},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/publication-status'=>['draft', 'active', 'retired', 'unknown']}, 'type'=>'code', 'path'=>'SearchParameter.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/publication-status'}},
  'experimental' => {'type'=>'boolean', 'path'=>'SearchParameter.experimental', 'min'=>0, 'max'=>1},
  'date' => {'type'=>'dateTime', 'path'=>'SearchParameter.date', 'min'=>0, 'max'=>1},
  'publisher' => {'type'=>'string', 'path'=>'SearchParameter.publisher', 'min'=>0, 'max'=>1},
  'contact' => {'type'=>'ContactDetail', 'path'=>'SearchParameter.contact', 'min'=>0, 'max'=>Float::INFINITY},
  'useContext' => {'type'=>'UsageContext', 'path'=>'SearchParameter.useContext', 'min'=>0, 'max'=>Float::INFINITY},
  'jurisdiction' => {'valid_codes'=>{'urn:iso:std:iso:3166'=>['AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AN', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BU', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CS', 'CT', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DD', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DY', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FQ', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'HV', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'JT', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MI', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NH', 'NI', 'NL', 'NO', 'NP', 'NQ', 'NR', 'NT', 'NU', 'NZ', 'OM', 'PA', 'PC', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PU', 'PW', 'PY', 'PZ', 'QA', 'RE', 'RH', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SU', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TP', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VD', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WK', 'WS', 'YD', 'YE', 'YT', 'YU', 'ZA', 'ZM', 'ZR', 'ZW'], 'http://unstats.un.org/unsd/methods/m49/m49.htm'=>['001', '002', '014', '017', '015', '018', '011', '019', '419', '029', '013', '005', '021', '142', '143', '030', '034', '035', '145', '150', '151', '154', '039', '155', '009', '053', '054', '057', '061'], 'https://www.usps.com/'=>['AK', 'AL', 'AR', 'AS', 'AZ', 'CA', 'CO', 'CT', 'DC', 'DE', 'FL', 'FM', 'GA', 'GU', 'HI', 'IA', 'ID', 'IL', 'IN', 'KS', 'KY', 'LA', 'MA', 'MD', 'ME', 'MH', 'MI', 'MN', 'MO', 'MP', 'MS', 'MT', 'NC', 'ND', 'NE', 'NH', 'NJ', 'NM', 'NV', 'NY', 'OH', 'OK', 'OR', 'PA', 'PR', 'PW', 'RI', 'SC', 'SD', 'TN', 'TX', 'UM', 'UT', 'VA', 'VI', 'VT', 'WA', 'WI', 'WV', 'WY'], nil=>[]}, 'type'=>'CodeableConcept', 'path'=>'SearchParameter.jurisdiction', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/jurisdiction'}},
  'purpose' => {'type'=>'markdown', 'path'=>'SearchParameter.purpose', 'min'=>0, 'max'=>1},
  'code' => {'type'=>'code', 'path'=>'SearchParameter.code', 'min'=>1, 'max'=>1},
  'base' => {'valid_codes'=>{'http://hl7.org/fhir/resource-types'=>['Account', 'ActivityDefinition', 'AdverseEvent', 'AllergyIntolerance', 'Appointment', 'AppointmentResponse', 'AuditEvent', 'Basic', 'Binary', 'BodySite', 'Bundle', 'CapabilityStatement', 'CarePlan', 'CareTeam', 'ChargeItem', 'Claim', 'ClaimResponse', 'ClinicalImpression', 'CodeSystem', 'Communication', 'CommunicationRequest', 'CompartmentDefinition', 'Composition', 'ConceptMap', 'Condition', 'Consent', 'Contract', 'Coverage', 'DataElement', 'DetectedIssue', 'Device', 'DeviceComponent', 'DeviceMetric', 'DeviceRequest', 'DeviceUseStatement', 'DiagnosticReport', 'DocumentManifest', 'DocumentReference', 'DomainResource', 'EligibilityRequest', 'EligibilityResponse', 'Encounter', 'Endpoint', 'EnrollmentRequest', 'EnrollmentResponse', 'EpisodeOfCare', 'ExpansionProfile', 'ExplanationOfBenefit', 'FamilyMemberHistory', 'Flag', 'Goal', 'GraphDefinition', 'Group', 'GuidanceResponse', 'HealthcareService', 'ImagingManifest', 'ImagingStudy', 'Immunization', 'ImmunizationRecommendation', 'ImplementationGuide', 'Library', 'Linkage', 'List', 'Location', 'Measure', 'MeasureReport', 'Media', 'Medication', 'MedicationAdministration', 'MedicationDispense', 'MedicationRequest', 'MedicationStatement', 'MessageDefinition', 'MessageHeader', 'NamingSystem', 'NutritionOrder', 'Observation', 'OperationDefinition', 'OperationOutcome', 'Organization', 'Parameters', 'Patient', 'PaymentNotice', 'PaymentReconciliation', 'Person', 'PlanDefinition', 'Practitioner', 'PractitionerRole', 'Procedure', 'ProcedureRequest', 'ProcessRequest', 'ProcessResponse', 'Provenance', 'Questionnaire', 'QuestionnaireResponse', 'ReferralRequest', 'RelatedPerson', 'RequestGroup', 'ResearchStudy', 'ResearchSubject', 'Resource', 'RiskAssessment', 'Schedule', 'SearchParameter', 'Sequence', 'ServiceDefinition', 'Slot', 'Specimen', 'StructureDefinition', 'StructureMap', 'Subscription', 'Substance', 'SupplyDelivery', 'SupplyRequest', 'Task', 'TestReport', 'TestScript', 'ValueSet', 'VisionPrescription']}, 'type'=>'code', 'path'=>'SearchParameter.base', 'min'=>1, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/resource-types'}},
  'type' => {'valid_codes'=>{'http://hl7.org/fhir/search-param-type'=>['number', 'date', 'string', 'token', 'reference', 'composite', 'quantity', 'uri']}, 'type'=>'code', 'path'=>'SearchParameter.type', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/search-param-type'}},
  'derivedFrom' => {'type'=>'uri', 'path'=>'SearchParameter.derivedFrom', 'min'=>0, 'max'=>1},
  'description' => {'type'=>'markdown', 'path'=>'SearchParameter.description', 'min'=>1, 'max'=>1},
  'expression' => {'type'=>'string', 'path'=>'SearchParameter.expression', 'min'=>0, 'max'=>1},
  'xpath' => {'type'=>'string', 'path'=>'SearchParameter.xpath', 'min'=>0, 'max'=>1},
  'xpathUsage' => {'valid_codes'=>{'http://hl7.org/fhir/search-xpath-usage'=>['normal', 'phonetic', 'nearby', 'distance', 'other']}, 'type'=>'code', 'path'=>'SearchParameter.xpathUsage', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/search-xpath-usage'}},
  'target' => {'valid_codes'=>{'http://hl7.org/fhir/resource-types'=>['Account', 'ActivityDefinition', 'AdverseEvent', 'AllergyIntolerance', 'Appointment', 'AppointmentResponse', 'AuditEvent', 'Basic', 'Binary', 'BodySite', 'Bundle', 'CapabilityStatement', 'CarePlan', 'CareTeam', 'ChargeItem', 'Claim', 'ClaimResponse', 'ClinicalImpression', 'CodeSystem', 'Communication', 'CommunicationRequest', 'CompartmentDefinition', 'Composition', 'ConceptMap', 'Condition', 'Consent', 'Contract', 'Coverage', 'DataElement', 'DetectedIssue', 'Device', 'DeviceComponent', 'DeviceMetric', 'DeviceRequest', 'DeviceUseStatement', 'DiagnosticReport', 'DocumentManifest', 'DocumentReference', 'DomainResource', 'EligibilityRequest', 'EligibilityResponse', 'Encounter', 'Endpoint', 'EnrollmentRequest', 'EnrollmentResponse', 'EpisodeOfCare', 'ExpansionProfile', 'ExplanationOfBenefit', 'FamilyMemberHistory', 'Flag', 'Goal', 'GraphDefinition', 'Group', 'GuidanceResponse', 'HealthcareService', 'ImagingManifest', 'ImagingStudy', 'Immunization', 'ImmunizationRecommendation', 'ImplementationGuide', 'Library', 'Linkage', 'List', 'Location', 'Measure', 'MeasureReport', 'Media', 'Medication', 'MedicationAdministration', 'MedicationDispense', 'MedicationRequest', 'MedicationStatement', 'MessageDefinition', 'MessageHeader', 'NamingSystem', 'NutritionOrder', 'Observation', 'OperationDefinition', 'OperationOutcome', 'Organization', 'Parameters', 'Patient', 'PaymentNotice', 'PaymentReconciliation', 'Person', 'PlanDefinition', 'Practitioner', 'PractitionerRole', 'Procedure', 'ProcedureRequest', 'ProcessRequest', 'ProcessResponse', 'Provenance', 'Questionnaire', 'QuestionnaireResponse', 'ReferralRequest', 'RelatedPerson', 'RequestGroup', 'ResearchStudy', 'ResearchSubject', 'Resource', 'RiskAssessment', 'Schedule', 'SearchParameter', 'Sequence', 'ServiceDefinition', 'Slot', 'Specimen', 'StructureDefinition', 'StructureMap', 'Subscription', 'Substance', 'SupplyDelivery', 'SupplyRequest', 'Task', 'TestReport', 'TestScript', 'ValueSet', 'VisionPrescription']}, 'type'=>'code', 'path'=>'SearchParameter.target', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/resource-types'}},
  'comparator' => {'valid_codes'=>{'http://hl7.org/fhir/search-comparator'=>['eq', 'ne', 'gt', 'lt', 'ge', 'le', 'sa', 'eb', 'ap']}, 'type'=>'code', 'path'=>'SearchParameter.comparator', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/search-comparator'}},
  'modifier' => {'valid_codes'=>{'http://hl7.org/fhir/search-modifier-code'=>['missing', 'exact', 'contains', 'not', 'text', 'in', 'not-in', 'below', 'above', 'type']}, 'type'=>'code', 'path'=>'SearchParameter.modifier', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/search-modifier-code'}},
  'chain' => {'type'=>'string', 'path'=>'SearchParameter.chain', 'min'=>0, 'max'=>Float::INFINITY},
  'component' => {'type'=>'SearchParameter::Component', 'path'=>'SearchParameter.component', 'min'=>0, '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, #each_element, #equals?, #hash, #initialize, #method_missing, #mismatch, #primitive?, #to_reference, #valid?, #validate, #validate_profile

Constructor Details

This class inherits a constructor from FHIR::STU3::Model

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class FHIR::STU3::Model

Instance Attribute Details

#base ⇒ Object

1-* [ code ]



84
85
86
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 84

def base
  @base
end

#chain ⇒ Object

0-* [ string ]



94
95
96
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 94

def chain
  @chain
end

#code ⇒ Object

1-1 code



83
84
85
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 83

def code
  @code
end

#comparator ⇒ Object

0-* [ code ]



92
93
94
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 92

def comparator
  @comparator
end

#component ⇒ Object

0-* [ SearchParameter::Component ]



95
96
97
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 95

def component
  @component
end

#contact ⇒ Object

0-* [ ContactDetail ]



79
80
81
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 79

def contact
  @contact
end

#contained ⇒ Object

0-* [ Resource ]



69
70
71
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 69

def contained
  @contained
end

#date ⇒ Object

0-1 dateTime



77
78
79
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 77

def date
  @date
end

#derivedFrom ⇒ Object

0-1 uri



86
87
88
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 86

def derivedFrom
  @derivedFrom
end

#description ⇒ Object

1-1 markdown



87
88
89
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 87

def description
  @description
end

#experimental ⇒ Object

0-1 boolean



76
77
78
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 76

def experimental
  @experimental
end

#expression ⇒ Object

0-1 string



88
89
90
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 88

def expression
  @expression
end

#extension ⇒ Object

0-* [ Extension ]



70
71
72
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 70

def extension
  @extension
end

#id ⇒ Object

0-1 id



64
65
66
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 64

def id
  @id
end

#implicitRules ⇒ Object

0-1 uri



66
67
68
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 66

def implicitRules
  @implicitRules
end

#jurisdiction ⇒ Object

0-* [ CodeableConcept ]



81
82
83
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 81

def jurisdiction
  @jurisdiction
end

#language ⇒ Object

0-1 code



67
68
69
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 67

def language
  @language
end

#meta ⇒ Object

0-1 Meta



65
66
67
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 65

def meta
  @meta
end

#modifier ⇒ Object

0-* [ code ]



93
94
95
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 93

def modifier
  @modifier
end

#modifierExtension ⇒ Object

0-* [ Extension ]



71
72
73
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 71

def modifierExtension
  @modifierExtension
end

#name ⇒ Object

1-1 string



74
75
76
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 74

def name
  @name
end

#publisher ⇒ Object

0-1 string



78
79
80
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 78

def publisher
  @publisher
end

#purpose ⇒ Object

0-1 markdown



82
83
84
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 82

def purpose
  @purpose
end

#status ⇒ Object

1-1 code



75
76
77
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 75

def status
  @status
end

#target ⇒ Object

0-* [ code ]



91
92
93
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 91

def target
  @target
end

#text ⇒ Object

0-1 Narrative



68
69
70
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 68

def text
  @text
end

#type ⇒ Object

1-1 code



85
86
87
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 85

def type
  @type
end

#url ⇒ Object

1-1 uri



72
73
74
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 72

def url
  @url
end

#useContext ⇒ Object

0-* [ UsageContext ]



80
81
82
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 80

def useContext
  @useContext
end

#version ⇒ Object

0-1 string



73
74
75
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 73

def version
  @version
end

#xpath ⇒ Object

0-1 string



89
90
91
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 89

def xpath
  @xpath
end

#xpathUsage ⇒ Object

0-1 code



90
91
92
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 90

def xpathUsage
  @xpathUsage
end

Instance Method Details

#resourceType ⇒ Object 



97
98
99
 
# File 'lib/fhir_stu3_models/fhir/resources/SearchParameter.rb', line 97

def resourceType
  'SearchParameter'
end