Class: FHIR::StructureDefinition

Inherits:
Model
  • Object
show all
Extended by:
Deprecate
Includes:
Hashable, Json, Xml
Defined in:
lib/fhir_models/fhir_ext/structure_definition_compare.rb,
lib/fhir_models/fhir_ext/structure_definition.rb,
lib/fhir_models/fhir/resources/StructureDefinition.rb

Overview

Extend StructureDefinition for profile comparison code

Defined Under Namespace

Classes: Differential, Mapping, Snapshot

Constant Summary collapse

SEARCH_PARAMS = 
['abstract', 'base', 'base-path', 'context-type', 'date', 'derivation', 'description', 'experimental', 'ext-context', 'identifier', 'jurisdiction', 'keyword', 'kind', 'name', 'path', 'publisher', 'status', 'title', 'type', 'url', 'valueset', 'version']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'StructureDefinition.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'StructureDefinition.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'StructureDefinition.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'=>'StructureDefinition.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'StructureDefinition.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'StructureDefinition.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'StructureDefinition.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'StructureDefinition.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'url' => {'type'=>'uri', 'path'=>'StructureDefinition.url', 'min'=>1, 'max'=>1},
  'identifier' => {'type'=>'Identifier', 'path'=>'StructureDefinition.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'version' => {'type'=>'string', 'path'=>'StructureDefinition.version', 'min'=>0, 'max'=>1},
  'name' => {'type'=>'string', 'path'=>'StructureDefinition.name', 'min'=>1, 'max'=>1},
  'title' => {'type'=>'string', 'path'=>'StructureDefinition.title', 'min'=>0, 'max'=>1},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/publication-status'=>['draft', 'active', 'retired', 'unknown']}, 'type'=>'code', 'path'=>'StructureDefinition.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/publication-status'}},
  'experimental' => {'type'=>'boolean', 'path'=>'StructureDefinition.experimental', 'min'=>0, 'max'=>1},
  'date' => {'type'=>'dateTime', 'path'=>'StructureDefinition.date', 'min'=>0, 'max'=>1},
  'publisher' => {'type'=>'string', 'path'=>'StructureDefinition.publisher', 'min'=>0, 'max'=>1},
  'contact' => {'type'=>'ContactDetail', 'path'=>'StructureDefinition.contact', 'min'=>0, 'max'=>Float::INFINITY},
  'description' => {'type'=>'markdown', 'path'=>'StructureDefinition.description', 'min'=>0, 'max'=>1},
  'useContext' => {'type'=>'UsageContext', 'path'=>'StructureDefinition.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'=>'StructureDefinition.jurisdiction', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/jurisdiction'}},
  'purpose' => {'type'=>'markdown', 'path'=>'StructureDefinition.purpose', 'min'=>0, 'max'=>1},
  'copyright' => {'type'=>'markdown', 'path'=>'StructureDefinition.copyright', 'min'=>0, 'max'=>1},
  'keyword' => {'valid_codes'=>{'http://snomed.info/sct'=>[], 'http://loinc.org'=>[]}, 'type'=>'Coding', 'path'=>'StructureDefinition.keyword', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/profile-code'}},
  'fhirVersion' => {'type'=>'id', 'path'=>'StructureDefinition.fhirVersion', 'min'=>0, 'max'=>1},
  'mapping' => {'type'=>'StructureDefinition::Mapping', 'path'=>'StructureDefinition.mapping', 'min'=>0, 'max'=>Float::INFINITY},
  'kind' => {'valid_codes'=>{'http://hl7.org/fhir/structure-definition-kind'=>['primitive-type', 'complex-type', 'resource', 'logical']}, 'type'=>'code', 'path'=>'StructureDefinition.kind', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/structure-definition-kind'}},
  'abstract' => {'type'=>'boolean', 'path'=>'StructureDefinition.abstract', 'min'=>1, 'max'=>1},
  'contextType' => {'valid_codes'=>{'http://hl7.org/fhir/extension-context'=>['resource', 'datatype', 'extension']}, 'type'=>'code', 'path'=>'StructureDefinition.contextType', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/extension-context'}},
  'context' => {'type'=>'string', 'path'=>'StructureDefinition.context', 'min'=>0, 'max'=>Float::INFINITY},
  'contextInvariant' => {'type'=>'string', 'path'=>'StructureDefinition.contextInvariant', 'min'=>0, 'max'=>Float::INFINITY},
  'type' => {'valid_codes'=>{'http://hl7.org/fhir/data-types'=>['Address', 'Age', 'Annotation', 'Attachment', 'BackboneElement', 'CodeableConcept', 'Coding', 'ContactDetail', 'ContactPoint', 'Contributor', 'Count', 'DataRequirement', 'Distance', 'Dosage', 'Duration', 'Element', 'ElementDefinition', 'Extension', 'HumanName', 'Identifier', 'Meta', 'Money', 'Narrative', 'ParameterDefinition', 'Period', 'Quantity', 'Range', 'Ratio', 'Reference', 'RelatedArtifact', 'SampledData', 'Signature', 'SimpleQuantity', 'Timing', 'TriggerDefinition', 'UsageContext', 'base64Binary', 'boolean', 'code', 'date', 'dateTime', 'decimal', 'id', 'instant', 'integer', 'markdown', 'oid', 'positiveInt', 'string', 'time', 'unsignedInt', 'uri', 'uuid', 'xhtml'], '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'=>'StructureDefinition.type', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/defined-types'}},
  'baseDefinition' => {'type'=>'uri', 'path'=>'StructureDefinition.baseDefinition', 'min'=>0, 'max'=>1},
  'derivation' => {'valid_codes'=>{'http://hl7.org/fhir/type-derivation-rule'=>['specialization', 'constraint']}, 'type'=>'code', 'path'=>'StructureDefinition.derivation', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/type-derivation-rule'}},
  'snapshot' => {'type'=>'StructureDefinition::Snapshot', 'path'=>'StructureDefinition.snapshot', 'min'=>0, 'max'=>1},
  'differential' => {'type'=>'StructureDefinition::Differential', 'path'=>'StructureDefinition.differential', 'min'=>0, 'max'=>1}
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Deprecate

deprecate

Methods included from Xml

from_xml, #to_xml, valid?, validate

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

#abstract ⇒ Object

1-1 boolean



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

def abstract
  @abstract
end

#baseDefinition ⇒ Object

0-1 uri



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

def baseDefinition
  @baseDefinition
end

#contact ⇒ Object

0-* [ ContactDetail ]



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

def contact
  @contact
end

#contained ⇒ Object

0-* [ Resource ]



112
113
114
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 112

def contained
  @contained
end

#context ⇒ Object

0-* [ string ]



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

def context
  @context
end

#contextInvariant ⇒ Object

0-* [ string ]



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

def contextInvariant
  @contextInvariant
end

#contextType ⇒ Object

0-1 code



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

def contextType
  @contextType
end

#copyright ⇒ Object

0-1 markdown



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

def copyright
  @copyright
end

#date ⇒ Object

0-1 dateTime



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

def date
  @date
end

#derivation ⇒ Object

0-1 code



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

def derivation
  @derivation
end

#description ⇒ Object

0-1 markdown



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

def description
  @description
end

#differential ⇒ Object

0-1 StructureDefinition::Differential



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

def differential
  @differential
end

#errors ⇒ Object

Returns the value of attribute errors.



10
11
12
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 10

def errors
  @errors
end

#experimental ⇒ Object

0-1 boolean



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

def experimental
  @experimental
end

#extension ⇒ Object

0-* [ Extension ]



113
114
115
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 113

def extension
  @extension
end

#fhirVersion ⇒ Object

0-1 id



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

def fhirVersion
  @fhirVersion
end

#finding ⇒ Object

Returns the value of attribute finding.



9
10
11
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 9

def finding
  @finding
end

#hierarchy ⇒ Object

Returns the value of attribute hierarchy.



12
13
14
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 12

def hierarchy
  @hierarchy
end

#id ⇒ Object

0-1 id



107
108
109
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 107

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



116
117
118
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 116

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



109
110
111
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 109

def implicitRules
  @implicitRules
end

#jurisdiction ⇒ Object

0-* [ CodeableConcept ]



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

def jurisdiction
  @jurisdiction
end

#keyword ⇒ Object

0-* [ Coding ]



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

def keyword
  @keyword
end

#kind ⇒ Object

1-1 code



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

def kind
  @kind
end

#language ⇒ Object

0-1 code



110
111
112
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 110

def language
  @language
end

#mapping ⇒ Object

0-* [ StructureDefinition::Mapping ]



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

def mapping
  @mapping
end

#meta ⇒ Object

0-1 Meta



108
109
110
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 108

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



114
115
116
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 114

def modifierExtension
  @modifierExtension
end

#name ⇒ Object

1-1 string



118
119
120
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 118

def name
  @name
end

#publisher ⇒ Object

0-1 string



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

def publisher
  @publisher
end

#purpose ⇒ Object

0-1 markdown



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

def purpose
  @purpose
end

#snapshot ⇒ Object

0-1 StructureDefinition::Snapshot



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

def snapshot
  @snapshot
end

#status ⇒ Object

1-1 code



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

def status
  @status
end

#text ⇒ Object

0-1 Narrative



111
112
113
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 111

def text
  @text
end

#title ⇒ Object

0-1 string



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

def title
  @title
end

#type ⇒ Object

1-1 code



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

def type
  @type
end

#url ⇒ Object

1-1 uri



115
116
117
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 115

def url
  @url
end

#useContext ⇒ Object

0-* [ UsageContext ]



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

def useContext
  @useContext
end

#version ⇒ Object

0-1 string



117
118
119
 
# File 'lib/fhir_models/fhir/resources/StructureDefinition.rb', line 117

def version
  @version
end

#warnings ⇒ Object

Returns the value of attribute warnings.



11
12
13
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 11

def warnings
  @warnings
end

Instance Method Details

#compatible?(another_definition) ⇒ Boolean

Checks whether or not “another_definition” is compatible with this definition. If they have conflicting elements, restrictions, bindings, modifying extensions, etc.

Returns:

  • (Boolean) 


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/fhir_models/fhir_ext/structure_definition_compare.rb', line 12

def compatible?(another_definition)
  @errors = []
  @warnings = []

  @finding = FHIR::StructureDefinitionFinding.new
  @finding.resourceType = snapshot.element[0].path
  @finding.profileIdA = id
  @finding.profileIdB = another_definition.id if another_definition.respond_to?(:id)

  if !(another_definition.is_a? FHIR::StructureDefinition)
    @errors << @finding.error('', '', 'Not a StructureDefinition', 'StructureDefinition', another_definition.class.name.to_s)
    return false
  elsif another_definition.snapshot.element[0].path != snapshot.element[0].path
    @errors << @finding.error('', '', 'Incompatible resourceType', @finding.resourceType, another_definition.snapshot.element[0].path.to_s)
    return false
  end

  left_elements = Array.new(snapshot.element)
  right_elements = Array.new(another_definition.snapshot.element)

  left_paths = left_elements.map(&:path)
  right_paths = right_elements.map(&:path)

  # StructureDefinitions don't always include all base attributes (for example, of a ContactPoint)
  # if nothing is modified from the base definition, so we have to add them in if they are missing.
  base_definition = FHIR::Definitions.get_resource_definition(snapshot.element[0].path)
  base_elements = base_definition.snapshot.element

  left_missing = right_paths - left_paths
  # left_missing_roots = left_missing.map{|e| e.split('.')[0..-2].join('.') }.uniq
  add_missing_elements(id, left_missing, left_elements, base_elements)

  right_missing = left_paths - right_paths
  # right_missing_roots = right_missing.map{|e| e.split('.')[0..-2].join('.') }.uniq
  add_missing_elements(another_definition.id, right_missing, right_elements, base_elements)

  # update paths
  left_paths = left_elements.map(&:path)
  right_paths = right_elements.map(&:path)

  # recalculate the missing attributes
  left_missing = right_paths - left_paths
  right_missing = left_paths - right_paths

  # generate warnings for missing fields (ignoring extensions)
  left_missing.each do |e|
    next if e.include? 'extension'
    elem = get_element_by_path(e, right_elements)
    if !elem.min.nil? && elem.min > 0
      @errors << @finding.error(e, 'min', 'Missing REQUIRED element', 'Missing', elem.min.to_s)
    elsif elem.isModifier == true
      @errors << @finding.error(e, 'isModifier', 'Missing MODIFIER element', 'Missing', elem.isModifier.to_s)
    else
      @warnings << @finding.warning(e, '', 'Missing element', 'Missing', 'Defined')
    end
  end
  right_missing.each do |e|
    next if e.include? 'extension'
    elem = get_element_by_path(e, left_elements)
    if !elem.min.nil? && elem.min > 0
      @errors << @finding.error(e, 'min', 'Missing REQUIRED element', elem.min.to_s, 'Missing')
    elsif elem.isModifier == true
      @errors << @finding.error(e, 'isModifier', 'Missing MODIFIER element', elem.isModifier.to_s, 'Missing')
    else
      @warnings << @finding.warning(e, '', 'Missing element', 'Defined', 'Missing')
    end
  end

  left_extensions = []
  right_extensions = []

  # compare elements, starting with the elements in this definition
  left_elements.each do |x|
    if x.path.include? 'extension'
      # handle extensions separately
      left_extensions << x
    else
      y = get_element_by_path(x.path, right_elements)
      compare_element_definitions(x, y, another_definition)
    end
  end

  # now compare elements defined in the other definition, if we haven't already looked at them
  right_elements.each do |y|
    if y.path.include? 'extension'
      # handle extensions separately
      right_extensions << y
    elsif left_missing.include? y.path
      x = get_element_by_path(y.path, left_elements)
      compare_element_definitions(x, y, another_definition)
    end
  end

  # finally, compare the extensions.
  checked_extensions = []
  left_extensions.each do |x|
    y = get_extension(x.name, right_extensions)
    unless y.nil?
      # both profiles share an extension with the same name
      checked_extensions << x.name
      compare_extension_definition(x, y, another_definition)
    end
    y = get_extension(x.type[0].profile, right_extensions)
    next unless !y.nil? && x.name != y.name
    # both profiles share the same extension definition but with a different name
    checked_extensions << x.name
    checked_extensions << y.name
    compare_element_definitions(x, y, another_definition)
  end
  right_extensions.each do |y|
    next if checked_extensions.include?(y.name)
    x = get_extension(y.name, left_extensions)
    unless x.nil?
      # both profiles share an extension with the same name
      checked_extensions << y.name
      compare_extension_definition(x, y, another_definition)
    end
    x = get_extension(y.type[0].profile, left_extensions)
    next unless !x.nil? && x.name != y.name && !checked_extensions.include?(x.name)
    # both profiles share the same extension definition but with a different name
    checked_extensions << x.name
    checked_extensions << y.name
    compare_element_definitions(x, y, another_definition)
  end
  @errors.flatten!
  @warnings.flatten!
  @errors.size.zero?
end

#data_type?(data_type_code, value) ⇒ Boolean

data_type_code == a FHIR DataType code (see hl7.org/fhir/2015May/datatypes.html) value == the representation of the value

Returns:

  • (Boolean) 


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 251

def data_type?(data_type_code, value)
  # FHIR models covers any base Resources
  if FHIR::RESOURCES.include?(data_type_code)
    definition = FHIR::Definitions.resource_definition(data_type_code)
    unless definition.nil?
      ret_val = false
      begin
        # klass = Module.const_get("FHIR::#{data_type_code}")
        # ret_val = definition.validates_resource?(klass.new(deep_copy(value)))
        ret_val = definition.validates_hash?(value)
        unless ret_val
          @errors += definition.errors
          @warnings += definition.warnings
        end
      rescue
        @errors << "Unable to verify #{data_type_code} as a FHIR Resource."
      end
      return ret_val
    end
  end

  # Remaining data types: handle special cases before checking type StructureDefinitions
  case data_type_code.downcase
  when 'domainresource'
    true # we don't have to verify domain resource, because it will be included in the snapshot
  when 'resource'
    resource_type = value['resourceType']
    definition = FHIR::Definitions.resource_definition(resource_type)
    if !definition.nil?
      ret_val = false
      begin
        # klass = Module.const_get("FHIR::#{resource_type}")
        # ret_val = definition.validates_resource?(klass.new(deep_copy(value)))
        ret_val = definition.validates_hash?(value)
        unless ret_val
          @errors += definition.errors
          @warnings += definition.warnings
        end
      rescue
        @errors << "Unable to verify #{resource_type} as a FHIR Resource."
      end
      ret_val
    else
      @errors << "Unable to find base Resource definition: #{resource_type}"
      false
    end
  when *FHIR::PRIMITIVES.keys.map(&:downcase)
    FHIR.primitive?(datatype: data_type_code, value: value)
  else
    # Eliminate endless loop on Element is an Element
    return true if data_type_code == 'Element' && id == 'Element'

    definition = FHIR::Definitions.type_definition(data_type_code)
    definition = FHIR::Definitions.resource_definition(data_type_code) if definition.nil?
    if !definition.nil?
      ret_val = false
      begin
        # klass = Module.const_get("FHIR::#{data_type_code}")
        # ret_val = definition.validates_resource?(klass.new(deep_copy(value)))
        ret_val = definition.validates_hash?(value)
        unless ret_val
          @errors += definition.errors
          @warnings += definition.warnings
        end
      rescue
        @errors << "Unable to verify #{data_type_code} as a FHIR type."
      end
      ret_val
    else
      @errors << "Unable to find base type definition: #{data_type_code}"
      false
    end
  end
end

#describe_element(element) ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 77

def describe_element(element)
  if element.path.end_with?('.extension', '.modifierExtension') && element.sliceName
    "#{element.path} (#{element.sliceName})"
  else
    element.path
  end
end

#get_element_by_path(path, elements = snapshot.element) ⇒ Object 



142
143
144
 
# File 'lib/fhir_models/fhir_ext/structure_definition_compare.rb', line 142

def get_element_by_path(path, elements = snapshot.element)
  elements.detect { |element| element.path == path }
end

#get_extension(extension, elements = snapshot.element) ⇒ Object 



146
147
148
149
150
151
152
153
 
# File 'lib/fhir_models/fhir_ext/structure_definition_compare.rb', line 146

def get_extension(extension, elements = snapshot.element)
  elements.each do |element|
    if element.path.include?('extension') || element.type.map(&:code).include?('Extension')
      return element if element.name == extension || element.type.map(&:profile).include?(extension)
    end
  end
  nil
end

#resourceType ⇒ Object 



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

def resourceType
  'StructureDefinition'
end

#some_type_of_xml_or_json?(code) ⇒ Boolean

Returns:

  • (Boolean) 


370
371
372
373
374
375
376
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 370

def some_type_of_xml_or_json?(code)
  m = code.downcase
  return true if m == 'xml' || m == 'json'
  return true if m.start_with?('application/', 'text/') && m.end_with?('json', 'xml')
  return true if m.start_with?('application/xml', 'text/xml', 'application/json', 'text/json')
  false
end

#validate_resource(resource) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 22

def validate_resource(resource)
  @errors = []
  @warnings = []
  if resource.is_a?(FHIR::Model)
    valid_json?(resource.to_json) if resource
  else
    @errors << "#{resource.class} is not a resource."
  end
  @errors
end

#validates_hash?(hash) ⇒ Boolean

Returns:

  • (Boolean) 


33
34
35
36
37
38
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 33

def validates_hash?(hash)
  @errors = []
  @warnings = []
  valid_json?(hash) if hash
  @errors
end

#validates_resource?(resource) ⇒ Boolean 

Profile Validation

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 18

def validates_resource?(resource)
  validate_resource(resource).empty?
end

#verify_cardinality(element, nodes) ⇒ Object 



238
239
240
241
242
243
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 238

def verify_cardinality(element, nodes)
  # Check the cardinality
  min = element.min
  max = element.max == '*' ? Float::INFINITY : element.max.to_i
  @errors << "#{describe_element(element)} failed cardinality test (#{min}..#{max}) -- found #{nodes.size}" if (nodes.size < min) || (nodes.size > max)
end

#verify_fixed_value(element, value) ⇒ Object 



245
246
247
 
# File 'lib/fhir_models/fhir_ext/structure_definition.rb', line 245

def verify_fixed_value(element, value)
  @errors << "#{describe_element(element)} value of '#{value}' did not match fixed value: #{element.fixed}" if !element.fixed.nil? && element.fixed != value
end