org.hl7.fhir.dstu2016may.model

Class BackboneElement

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.Element

org.hl7.fhir.dstu2016may.model.BackboneElement

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Direct Known Subclasses:

AllergyIntolerance.AllergyIntoleranceReactionComponent, Appointment.AppointmentParticipantComponent, AuditEvent.AuditEventAgentComponent, AuditEvent.AuditEventAgentNetworkComponent, AuditEvent.AuditEventEntityComponent, AuditEvent.AuditEventEntityDetailComponent, AuditEvent.AuditEventSourceComponent, Bundle.BundleEntryComponent, Bundle.BundleEntryRequestComponent, Bundle.BundleEntryResponseComponent, Bundle.BundleEntrySearchComponent, Bundle.BundleLinkComponent, CarePlan.CarePlanActivityComponent, CarePlan.CarePlanActivityDetailComponent, CarePlan.CarePlanParticipantComponent, CarePlan.CarePlanRelatedPlanComponent, CareTeam.CareTeamParticipantComponent, Claim.CoverageComponent, Claim.DetailComponent, Claim.DiagnosisComponent, Claim.ItemsComponent, Claim.MissingTeethComponent, Claim.OnsetComponent, Claim.PayeeComponent, Claim.ProcedureComponent, Claim.ProsthesisComponent, Claim.RelatedClaimsComponent, Claim.SubDetailComponent, ClaimResponse.AddedItemAdjudicationComponent, ClaimResponse.AddedItemComponent, ClaimResponse.AddedItemDetailAdjudicationComponent, ClaimResponse.AddedItemsDetailComponent, ClaimResponse.CoverageComponent, ClaimResponse.DetailAdjudicationComponent, ClaimResponse.ErrorsComponent, ClaimResponse.ItemAdjudicationComponent, ClaimResponse.ItemDetailComponent, ClaimResponse.ItemsComponent, ClaimResponse.NotesComponent, ClaimResponse.SubdetailAdjudicationComponent, ClaimResponse.SubDetailComponent, ClinicalImpression.ClinicalImpressionFindingComponent, ClinicalImpression.ClinicalImpressionInvestigationsComponent, ClinicalImpression.ClinicalImpressionRuledOutComponent, CodeSystem.CodeSystemContactComponent, CodeSystem.CodeSystemFilterComponent, CodeSystem.CodeSystemPropertyComponent, CodeSystem.ConceptDefinitionComponent, CodeSystem.ConceptDefinitionDesignationComponent, CodeSystem.ConceptDefinitionPropertyComponent, Communication.CommunicationPayloadComponent, CommunicationRequest.CommunicationRequestPayloadComponent, CompartmentDefinition.CompartmentDefinitionContactComponent, CompartmentDefinition.CompartmentDefinitionResourceComponent, Composition.CompositionAttesterComponent, Composition.CompositionEventComponent, Composition.SectionComponent, ConceptMap.ConceptMapContactComponent, ConceptMap.OtherElementComponent, ConceptMap.SourceElementComponent, ConceptMap.TargetElementComponent, Condition.ConditionEvidenceComponent, Condition.ConditionStageComponent, Conformance.ConformanceContactComponent, Conformance.ConformanceDocumentComponent, Conformance.ConformanceImplementationComponent, Conformance.ConformanceMessagingComponent, Conformance.ConformanceMessagingEndpointComponent, Conformance.ConformanceMessagingEventComponent, Conformance.ConformanceRestComponent, Conformance.ConformanceRestOperationComponent, Conformance.ConformanceRestResourceComponent, Conformance.ConformanceRestResourceSearchParamComponent, Conformance.ConformanceRestSecurityCertificateComponent, Conformance.ConformanceRestSecurityComponent, Conformance.ConformanceSoftwareComponent, Conformance.ResourceInteractionComponent, Conformance.SystemInteractionComponent, Contract.AgentComponent, Contract.ComputableLanguageComponent, Contract.FriendlyLanguageComponent, Contract.LegalLanguageComponent, Contract.SignatoryComponent, Contract.TermAgentComponent, Contract.TermComponent, Contract.TermValuedItemComponent, Contract.ValuedItemComponent, DataElement.DataElementContactComponent, DataElement.DataElementMappingComponent, DetectedIssue.DetectedIssueMitigationComponent, DeviceComponent.DeviceComponentProductionSpecificationComponent, DeviceMetric.DeviceMetricCalibrationComponent, DiagnosticOrder.DiagnosticOrderEventComponent, DiagnosticOrder.DiagnosticOrderItemComponent, DiagnosticReport.DiagnosticReportImageComponent, DocumentManifest.DocumentManifestContentComponent, DocumentManifest.DocumentManifestRelatedComponent, DocumentReference.DocumentReferenceContentComponent, DocumentReference.DocumentReferenceContextComponent, DocumentReference.DocumentReferenceContextRelatedComponent, DocumentReference.DocumentReferenceRelatesToComponent, EligibilityResponse.BenefitComponent, EligibilityResponse.BenefitsComponent, EligibilityResponse.ErrorsComponent, Encounter.EncounterHospitalizationComponent, Encounter.EncounterLocationComponent, Encounter.EncounterParticipantComponent, Encounter.EncounterStatusHistoryComponent, EpisodeOfCare.EpisodeOfCareStatusHistoryComponent, ExpansionProfile.CodeSystemExcludeCodeSystemComponent, ExpansionProfile.CodeSystemExcludeComponent, ExpansionProfile.CodeSystemIncludeCodeSystemComponent, ExpansionProfile.CodeSystemIncludeComponent, ExpansionProfile.DesignationExcludeComponent, ExpansionProfile.DesignationExcludeDesignationComponent, ExpansionProfile.DesignationIncludeComponent, ExpansionProfile.DesignationIncludeDesignationComponent, ExpansionProfile.ExpansionProfileCodeSystemComponent, ExpansionProfile.ExpansionProfileContactComponent, ExpansionProfile.ExpansionProfileDesignationComponent, ExplanationOfBenefit.AddedItemAdjudicationComponent, ExplanationOfBenefit.AddedItemComponent, ExplanationOfBenefit.AddedItemDetailAdjudicationComponent, ExplanationOfBenefit.AddedItemsDetailComponent, ExplanationOfBenefit.BenefitBalanceComponent, ExplanationOfBenefit.BenefitComponent, ExplanationOfBenefit.CoverageComponent, ExplanationOfBenefit.DetailAdjudicationComponent, ExplanationOfBenefit.DetailComponent, ExplanationOfBenefit.DiagnosisComponent, ExplanationOfBenefit.ItemAdjudicationComponent, ExplanationOfBenefit.ItemsComponent, ExplanationOfBenefit.MissingTeethComponent, ExplanationOfBenefit.NotesComponent, ExplanationOfBenefit.OnsetComponent, ExplanationOfBenefit.PayeeComponent, ExplanationOfBenefit.ProcedureComponent, ExplanationOfBenefit.ProsthesisComponent, ExplanationOfBenefit.RelatedClaimsComponent, ExplanationOfBenefit.SubDetailAdjudicationComponent, ExplanationOfBenefit.SubDetailComponent, FamilyMemberHistory.FamilyMemberHistoryConditionComponent, Goal.GoalOutcomeComponent, Group.GroupCharacteristicComponent, Group.GroupMemberComponent, GuidanceResponse.GuidanceResponseActionBehaviorComponent, GuidanceResponse.GuidanceResponseActionComponent, GuidanceResponse.GuidanceResponseActionRelatedActionComponent, HealthcareService.HealthcareServiceAvailableTimeComponent, HealthcareService.HealthcareServiceNotAvailableComponent, ImagingExcerpt.InstanceComponent, ImagingExcerpt.InstanceDicomComponent, ImagingExcerpt.SeriesComponent, ImagingExcerpt.SeriesDicomComponent, ImagingExcerpt.StudyComponent, ImagingExcerpt.StudyDicomComponent, ImagingExcerpt.StudyViewableComponent, ImagingObjectSelection.FramesComponent, ImagingObjectSelection.InstanceComponent, ImagingObjectSelection.SeriesComponent, ImagingObjectSelection.StudyComponent, ImagingStudy.ImagingStudySeriesComponent, ImagingStudy.ImagingStudySeriesInstanceComponent, Immunization.ImmunizationExplanationComponent, Immunization.ImmunizationReactionComponent, Immunization.ImmunizationVaccinationProtocolComponent, ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent, ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent, ImmunizationRecommendation.ImmunizationRecommendationRecommendationProtocolComponent, ImplementationGuide.ImplementationGuideContactComponent, ImplementationGuide.ImplementationGuideDependencyComponent, ImplementationGuide.ImplementationGuideGlobalComponent, ImplementationGuide.ImplementationGuidePackageComponent, ImplementationGuide.ImplementationGuidePackageResourceComponent, ImplementationGuide.ImplementationGuidePageComponent, Library.LibraryCodeSystemComponent, Library.LibraryLibraryComponent, Library.LibraryModelComponent, Library.LibraryValueSetComponent, Linkage.LinkageItemComponent, ListResource.ListEntryComponent, Location.LocationPositionComponent, Measure.MeasureGroupComponent, Measure.MeasureGroupPopulationComponent, Measure.MeasureGroupStratifierComponent, Measure.MeasureSupplementalDataComponent, MeasureReport.MeasureReportGroupComponent, MeasureReport.MeasureReportGroupPopulationComponent, MeasureReport.MeasureReportGroupStratifierComponent, MeasureReport.MeasureReportGroupStratifierGroupComponent, MeasureReport.MeasureReportGroupStratifierGroupPopulationComponent, MeasureReport.MeasureReportGroupSupplementalDataComponent, MeasureReport.MeasureReportGroupSupplementalDataGroupComponent, Medication.MedicationPackageComponent, Medication.MedicationPackageContentComponent, Medication.MedicationProductBatchComponent, Medication.MedicationProductComponent, Medication.MedicationProductIngredientComponent, MedicationAdministration.MedicationAdministrationDosageComponent, MedicationDispense.MedicationDispenseDosageInstructionComponent, MedicationDispense.MedicationDispenseSubstitutionComponent, MedicationOrder.MedicationOrderDispenseRequestComponent, MedicationOrder.MedicationOrderDosageInstructionComponent, MedicationOrder.MedicationOrderSubstitutionComponent, MedicationStatement.MedicationStatementDosageComponent, MessageHeader.MessageDestinationComponent, MessageHeader.MessageHeaderResponseComponent, MessageHeader.MessageSourceComponent, ModuleDefinition.ModuleDefinitionCodeSystemComponent, ModuleDefinition.ModuleDefinitionDataCodeFilterComponent, ModuleDefinition.ModuleDefinitionDataComponent, ModuleDefinition.ModuleDefinitionDataDateFilterComponent, ModuleDefinition.ModuleDefinitionLibraryComponent, ModuleDefinition.ModuleDefinitionModelComponent, ModuleDefinition.ModuleDefinitionParameterComponent, ModuleDefinition.ModuleDefinitionValueSetComponent, NamingSystem.NamingSystemContactComponent, NamingSystem.NamingSystemUniqueIdComponent, NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent, NutritionOrder.NutritionOrderEnteralFormulaComponent, NutritionOrder.NutritionOrderOralDietComponent, NutritionOrder.NutritionOrderOralDietNutrientComponent, NutritionOrder.NutritionOrderOralDietTextureComponent, NutritionOrder.NutritionOrderSupplementComponent, Observation.ObservationComponentComponent, Observation.ObservationReferenceRangeComponent, Observation.ObservationRelatedComponent, OperationDefinition.OperationDefinitionContactComponent, OperationDefinition.OperationDefinitionParameterBindingComponent, OperationDefinition.OperationDefinitionParameterComponent, OperationOutcome.OperationOutcomeIssueComponent, Order.OrderWhenComponent, Organization.OrganizationContactComponent, Parameters.ParametersParameterComponent, Patient.AnimalComponent, Patient.ContactComponent, Patient.PatientCommunicationComponent, Patient.PatientLinkComponent, PaymentReconciliation.DetailsComponent, PaymentReconciliation.NotesComponent, Person.PersonLinkComponent, Practitioner.PractitionerPractitionerRoleComponent, Practitioner.PractitionerQualificationComponent, PractitionerRole.PractitionerRoleAvailableTimeComponent, PractitionerRole.PractitionerRoleNotAvailableComponent, Procedure.ProcedureFocalDeviceComponent, Procedure.ProcedurePerformerComponent, ProcessRequest.ItemsComponent, ProcessResponse.ProcessResponseNotesComponent, Protocol.ProtocolStepActivityComponent, Protocol.ProtocolStepActivityComponentComponent, Protocol.ProtocolStepActivityDetailComponent, Protocol.ProtocolStepComponent, Protocol.ProtocolStepNextComponent, Protocol.ProtocolStepPreconditionComponent, Protocol.ProtocolStepPreconditionConditionComponent, Provenance.ProvenanceAgentComponent, Provenance.ProvenanceAgentRelatedAgentComponent, Provenance.ProvenanceEntityComponent, Questionnaire.QuestionnaireItemComponent, Questionnaire.QuestionnaireItemEnableWhenComponent, Questionnaire.QuestionnaireItemOptionComponent, QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent, QuestionnaireResponse.QuestionnaireResponseItemComponent, RiskAssessment.RiskAssessmentPredictionComponent, SearchParameter.SearchParameterContactComponent, Sequence.SequenceQualityComponent, Sequence.SequenceReferenceSeqComponent, Sequence.SequenceRepositoryComponent, Sequence.SequenceStructureVariationComponent, Sequence.SequenceStructureVariationInnerComponent, Sequence.SequenceStructureVariationOuterComponent, Sequence.SequenceVariationComponent, Specimen.SpecimenCollectionComponent, Specimen.SpecimenContainerComponent, Specimen.SpecimenTreatmentComponent, StructureDefinition.StructureDefinitionContactComponent, StructureDefinition.StructureDefinitionDifferentialComponent, StructureDefinition.StructureDefinitionMappingComponent, StructureDefinition.StructureDefinitionSnapshotComponent, StructureMap.StructureMapContactComponent, StructureMap.StructureMapGroupComponent, StructureMap.StructureMapGroupInputComponent, StructureMap.StructureMapGroupRuleComponent, StructureMap.StructureMapGroupRuleDependentComponent, StructureMap.StructureMapGroupRuleSourceComponent, StructureMap.StructureMapGroupRuleTargetComponent, StructureMap.StructureMapGroupRuleTargetParameterComponent, StructureMap.StructureMapStructureComponent, Subscription.SubscriptionChannelComponent, Substance.SubstanceIngredientComponent, Substance.SubstanceInstanceComponent, SupplyRequest.SupplyRequestWhenComponent, Task.ParameterComponent, Task.TaskOutputComponent, TestScript.SetupActionAssertComponent, TestScript.SetupActionAssertRuleComponent, TestScript.SetupActionAssertRuleParamComponent, TestScript.SetupActionAssertRulesetComponent, TestScript.SetupActionAssertRulesetRuleComponent, TestScript.SetupActionAssertRulesetRuleParamComponent, TestScript.SetupActionComponent, TestScript.SetupActionOperationComponent, TestScript.SetupActionOperationRequestHeaderComponent, TestScript.TeardownActionComponent, TestScript.TestActionComponent, TestScript.TestScriptContactComponent, TestScript.TestScriptDestinationComponent, TestScript.TestScriptFixtureComponent, TestScript.TestScriptMetadataCapabilityComponent, TestScript.TestScriptMetadataComponent, TestScript.TestScriptMetadataLinkComponent, TestScript.TestScriptOriginComponent, TestScript.TestScriptRuleComponent, TestScript.TestScriptRuleParamComponent, TestScript.TestScriptRulesetComponent, TestScript.TestScriptRulesetRuleComponent, TestScript.TestScriptRulesetRuleParamComponent, TestScript.TestScriptSetupComponent, TestScript.TestScriptTeardownComponent, TestScript.TestScriptTestComponent, TestScript.TestScriptVariableComponent, ValueSet.ConceptReferenceComponent, ValueSet.ConceptReferenceDesignationComponent, ValueSet.ConceptSetComponent, ValueSet.ConceptSetFilterComponent, ValueSet.ValueSetComposeComponent, ValueSet.ValueSetContactComponent, ValueSet.ValueSetExpansionComponent, ValueSet.ValueSetExpansionContainsComponent, ValueSet.ValueSetExpansionParameterComponent, VisionPrescription.VisionPrescriptionDispenseComponent

public abstract class BackboneElement
extends Element
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

Base definition for all elements that are defined inside a resource - but not those in a data type.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Extension>	modifierExtension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it.

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element

extension, id

Constructor Summary

Constructors

Constructor and Description
BackboneElement() Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
Extension	addModifierExtension()
BackboneElement	addModifierExtension(Extension t)
abstract BackboneElement	copy()
void	copyValues(BackboneElement dst)
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
List<Extension>	getModifierExtension()
Base[]	getProperty(int hash, String name, boolean checkValid)
boolean	hasModifierExtension()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
void	setProperty(int hash, String name, Base value)
void	setProperty(String name, Base value)

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element

addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Field Detail

modifierExtension

protected List<Extension> modifierExtension

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Constructor Detail

BackboneElement

public BackboneElement()

Constructor

Method Detail

getModifierExtension

public List<Extension> getModifierExtension()

Specified by:

getModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Returns:

modifierExtension (May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.)

hasModifierExtension

public boolean hasModifierExtension()

Specified by:

hasModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension

public Extension addModifierExtension()

Specified by:

addModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Returns:

modifierExtension (May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.)

addModifierExtension

public BackboneElement addModifierExtension(Extension t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class Element

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class Element

copy

public abstract BackboneElement copy()

Specified by:

copy in class Element

copyValues

public void copyValues(BackboneElement dst)

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Element