Class: FHIR::R4::StructureDefinition

Inherits:
Model
  • Object
show all
Includes:
CommonStructureDefinition, Hashable, Json, Xml
Defined in:
lib/fhir_models/r4/generated/resources/StructureDefinition.rb

Defined Under Namespace

Classes: Context, Differential, Mapping, Snapshot

Constant Summary collapse

SEARCH_PARAMS = 
['abstract', 'base', 'base-path', 'context', 'context-quantity', 'context-type', 'context-type-quantity', 'context-type-value', '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', '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'=>'StructureDefinition.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', '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' => {'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://terminology.hl7.org/CodeSystem/definition-use'=>['fhir-structure', 'custom-resource', 'dam', 'wire-format', 'archetype', 'template']}, 'type'=>'Coding', 'path'=>'StructureDefinition.keyword', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/definition-use'}},
  'fhirVersion' => {'valid_codes'=>{'http://hl7.org/fhir/FHIR-version'=>['0.01', '0.05', '0.06', '0.11', '0.0.80', '0.0.81', '0.0.82', '0.4.0', '0.5.0', '1.0.0', '1.0.1', '1.0.2', '1.1.0', '1.4.0', '1.6.0', '1.8.0', '3.0.0', '3.0.1', '3.3.0', '3.5.0', '4.0.0', '4.0.1']}, 'type'=>'code', 'path'=>'StructureDefinition.fhirVersion', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/FHIR-version'}},
  '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},
  'context' => {'type'=>'StructureDefinition::Context', 'path'=>'StructureDefinition.context', 'min'=>0, 'max'=>Float::INFINITY},
  'contextInvariant' => {'type'=>'string', 'path'=>'StructureDefinition.contextInvariant', 'min'=>0, 'max'=>Float::INFINITY},
  'type' => {'type'=>'uri', 'path'=>'StructureDefinition.type', 'min'=>1, 'max'=>1},
  'baseDefinition' => {'type'=>'canonical', '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}
}

Constants included from FHIR::R4

PRIMITIVES, RESOURCES, 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

Instance Attribute Summary collapse

Attributes included from CommonStructureDefinition

#errors, #finding, #hierarchy, #warnings

Instance Method Summary collapse

Methods included from CommonStructureDefinition

#data_type?, #describe_element, included, #some_type_of_xml_or_json?, #validate_resource, #validates_hash?, #validates_resource?, #verify_cardinality, #verify_fixed_value

Methods included from Deprecate

#deprecate

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 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

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



155
156
157
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 155

def abstract
  @abstract
end

#baseDefinition ⇒ Object

0-1 canonical



159
160
161
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 159

def baseDefinition
  @baseDefinition
end

#contact ⇒ Object

0-* [ ContactDetail ]



145
146
147
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 145

def contact
  @contact
end

#contained ⇒ Object

0-* [ Resource ]



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

def contained
  @contained
end

#context ⇒ Object

0-* [ StructureDefinition::Context ]



156
157
158
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 156

def context
  @context
end

#contextInvariant ⇒ Object

0-* [ string ]



157
158
159
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 157

def contextInvariant
  @contextInvariant
end

#copyright ⇒ Object

0-1 markdown



150
151
152
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 150

def copyright
  @copyright
end

#date ⇒ Object

0-1 dateTime



143
144
145
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 143

def date
  @date
end

#derivation ⇒ Object

0-1 code



160
161
162
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 160

def derivation
  @derivation
end

#description ⇒ Object

0-1 markdown



146
147
148
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 146

def description
  @description
end

#differential ⇒ Object

0-1 StructureDefinition::Differential



162
163
164
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 162

def differential
  @differential
end

#experimental ⇒ Object

0-1 boolean



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

def experimental
  @experimental
end

#extension ⇒ Object

0-* [ Extension ]



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

def extension
  @extension
end

#fhirVersion ⇒ Object

0-1 code



152
153
154
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 152

def fhirVersion
  @fhirVersion
end

#id ⇒ Object

0-1 id



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

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



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

def implicitRules
  @implicitRules
end

#jurisdiction ⇒ Object

0-* [ CodeableConcept ]



148
149
150
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 148

def jurisdiction
  @jurisdiction
end

#keyword ⇒ Object

0-* [ Coding ]



151
152
153
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 151

def keyword
  @keyword
end

#kind ⇒ Object

1-1 code



154
155
156
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 154

def kind
  @kind
end

#language ⇒ Object

0-1 code



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

def language
  @language
end

#mapping ⇒ Object

0-* [ StructureDefinition::Mapping ]



153
154
155
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 153

def mapping
  @mapping
end

#meta ⇒ Object

0-1 Meta



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

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#name ⇒ Object

1-1 string



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

def name
  @name
end

#publisher ⇒ Object

0-1 string



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

def publisher
  @publisher
end

#purpose ⇒ Object

0-1 markdown



149
150
151
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 149

def purpose
  @purpose
end

#snapshot ⇒ Object

0-1 StructureDefinition::Snapshot



161
162
163
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 161

def snapshot
  @snapshot
end

#status ⇒ Object

1-1 code



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

def status
  @status
end

#text ⇒ Object

0-1 Narrative



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

def text
  @text
end

#title ⇒ Object

0-1 string



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

def title
  @title
end

#type ⇒ Object

1-1 uri



158
159
160
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 158

def type
  @type
end

#url ⇒ Object

1-1 uri



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

def url
  @url
end

#useContext ⇒ Object

0-* [ UsageContext ]



147
148
149
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 147

def useContext
  @useContext
end

#version ⇒ Object

0-1 string



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

def version
  @version
end

Instance Method Details

#resourceType ⇒ Object 



164
165
166
 
# File 'lib/fhir_models/r4/generated/resources/StructureDefinition.rb', line 164

def resourceType
  'StructureDefinition'
end