Package org.hl7.fhir.dstu3.model

Class BackboneElement

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.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:

Account.CoverageComponent, Account.GuarantorComponent, ActivityDefinition.ActivityDefinitionDynamicValueComponent, ActivityDefinition.ActivityDefinitionParticipantComponent, AdverseEvent.AdverseEventSuspectEntityComponent, AllergyIntolerance.AllergyIntoleranceReactionComponent, Appointment.AppointmentParticipantComponent, AuditEvent.AuditEventAgentComponent, AuditEvent.AuditEventAgentNetworkComponent, AuditEvent.AuditEventEntityComponent, AuditEvent.AuditEventEntityDetailComponent, AuditEvent.AuditEventSourceComponent, Bundle.BundleEntryComponent, Bundle.BundleEntryRequestComponent, Bundle.BundleEntryResponseComponent, Bundle.BundleEntrySearchComponent, Bundle.BundleLinkComponent, CapabilityStatement.CapabilityStatementDocumentComponent, CapabilityStatement.CapabilityStatementImplementationComponent, CapabilityStatement.CapabilityStatementMessagingComponent, CapabilityStatement.CapabilityStatementMessagingEndpointComponent, CapabilityStatement.CapabilityStatementMessagingEventComponent, CapabilityStatement.CapabilityStatementMessagingSupportedMessageComponent, CapabilityStatement.CapabilityStatementRestComponent, CapabilityStatement.CapabilityStatementRestOperationComponent, CapabilityStatement.CapabilityStatementRestResourceComponent, CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent, CapabilityStatement.CapabilityStatementRestSecurityCertificateComponent, CapabilityStatement.CapabilityStatementRestSecurityComponent, CapabilityStatement.CapabilityStatementSoftwareComponent, CapabilityStatement.ResourceInteractionComponent, CapabilityStatement.SystemInteractionComponent, CarePlan.CarePlanActivityComponent, CarePlan.CarePlanActivityDetailComponent, CareTeam.CareTeamParticipantComponent, ChargeItem.ChargeItemParticipantComponent, Claim.AccidentComponent, Claim.CareTeamComponent, Claim.DetailComponent, Claim.DiagnosisComponent, Claim.InsuranceComponent, Claim.ItemComponent, Claim.PayeeComponent, Claim.ProcedureComponent, Claim.RelatedClaimComponent, Claim.SpecialConditionComponent, Claim.SubDetailComponent, ClaimResponse.AddedItemComponent, ClaimResponse.AddedItemsDetailComponent, ClaimResponse.AdjudicationComponent, ClaimResponse.ErrorComponent, ClaimResponse.InsuranceComponent, ClaimResponse.ItemComponent, ClaimResponse.ItemDetailComponent, ClaimResponse.NoteComponent, ClaimResponse.PaymentComponent, ClaimResponse.SubDetailComponent, ClinicalImpression.ClinicalImpressionFindingComponent, ClinicalImpression.ClinicalImpressionInvestigationComponent, CodeSystem.CodeSystemFilterComponent, CodeSystem.ConceptDefinitionComponent, CodeSystem.ConceptDefinitionDesignationComponent, CodeSystem.ConceptPropertyComponent, CodeSystem.PropertyComponent, Communication.CommunicationPayloadComponent, CommunicationRequest.CommunicationRequestPayloadComponent, CommunicationRequest.CommunicationRequestRequesterComponent, CompartmentDefinition.CompartmentDefinitionResourceComponent, Composition.CompositionAttesterComponent, Composition.CompositionEventComponent, Composition.CompositionRelatesToComponent, Composition.SectionComponent, ConceptMap.ConceptMapGroupComponent, ConceptMap.ConceptMapGroupUnmappedComponent, ConceptMap.OtherElementComponent, ConceptMap.SourceElementComponent, ConceptMap.TargetElementComponent, Condition.ConditionEvidenceComponent, Condition.ConditionStageComponent, Consent.ConsentActorComponent, Consent.ConsentDataComponent, Consent.ConsentPolicyComponent, Consent.ExceptActorComponent, Consent.ExceptComponent, Consent.ExceptDataComponent, Contract.AgentComponent, Contract.ComputableLanguageComponent, Contract.FriendlyLanguageComponent, Contract.LegalLanguageComponent, Contract.SignatoryComponent, Contract.TermAgentComponent, Contract.TermComponent, Contract.TermValuedItemComponent, Contract.ValuedItemComponent, Coverage.GroupComponent, DataElement.DataElementMappingComponent, DetectedIssue.DetectedIssueMitigationComponent, Device.DeviceUdiComponent, DeviceComponent.DeviceComponentProductionSpecificationComponent, DeviceMetric.DeviceMetricCalibrationComponent, DeviceRequest.DeviceRequestRequesterComponent, DiagnosticReport.DiagnosticReportImageComponent, DiagnosticReport.DiagnosticReportPerformerComponent, DocumentManifest.DocumentManifestContentComponent, DocumentManifest.DocumentManifestRelatedComponent, DocumentReference.DocumentReferenceContentComponent, DocumentReference.DocumentReferenceContextComponent, DocumentReference.DocumentReferenceContextRelatedComponent, DocumentReference.DocumentReferenceRelatesToComponent, EligibilityResponse.BenefitComponent, EligibilityResponse.BenefitsComponent, EligibilityResponse.ErrorsComponent, EligibilityResponse.InsuranceComponent, Encounter.ClassHistoryComponent, Encounter.DiagnosisComponent, Encounter.EncounterHospitalizationComponent, Encounter.EncounterLocationComponent, Encounter.EncounterParticipantComponent, Encounter.StatusHistoryComponent, EpisodeOfCare.DiagnosisComponent, EpisodeOfCare.EpisodeOfCareStatusHistoryComponent, ExpansionProfile.DesignationExcludeComponent, ExpansionProfile.DesignationExcludeDesignationComponent, ExpansionProfile.DesignationIncludeComponent, ExpansionProfile.DesignationIncludeDesignationComponent, ExpansionProfile.ExpansionProfileDesignationComponent, ExpansionProfile.ExpansionProfileExcludedSystemComponent, ExpansionProfile.ExpansionProfileFixedVersionComponent, ExplanationOfBenefit.AccidentComponent, ExplanationOfBenefit.AddedItemComponent, ExplanationOfBenefit.AddedItemsDetailComponent, ExplanationOfBenefit.AdjudicationComponent, ExplanationOfBenefit.BenefitBalanceComponent, ExplanationOfBenefit.BenefitComponent, ExplanationOfBenefit.CareTeamComponent, ExplanationOfBenefit.DetailComponent, ExplanationOfBenefit.DiagnosisComponent, ExplanationOfBenefit.InsuranceComponent, ExplanationOfBenefit.ItemComponent, ExplanationOfBenefit.NoteComponent, ExplanationOfBenefit.PayeeComponent, ExplanationOfBenefit.PaymentComponent, ExplanationOfBenefit.ProcedureComponent, ExplanationOfBenefit.RelatedClaimComponent, ExplanationOfBenefit.SubDetailComponent, ExplanationOfBenefit.SupportingInformationComponent, FamilyMemberHistory.FamilyMemberHistoryConditionComponent, Goal.GoalTargetComponent, GraphDefinition.GraphDefinitionLinkComponent, GraphDefinition.GraphDefinitionLinkTargetCompartmentComponent, GraphDefinition.GraphDefinitionLinkTargetComponent, Group.GroupCharacteristicComponent, Group.GroupMemberComponent, HealthcareService.HealthcareServiceAvailableTimeComponent, HealthcareService.HealthcareServiceNotAvailableComponent, ImagingManifest.InstanceComponent, ImagingManifest.SeriesComponent, ImagingManifest.StudyComponent, ImagingStudy.ImagingStudySeriesComponent, ImagingStudy.ImagingStudySeriesInstanceComponent, Immunization.ImmunizationExplanationComponent, Immunization.ImmunizationPractitionerComponent, Immunization.ImmunizationReactionComponent, Immunization.ImmunizationVaccinationProtocolComponent, ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent, ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent, ImmunizationRecommendation.ImmunizationRecommendationRecommendationProtocolComponent, ImplementationGuide.ImplementationGuideDependencyComponent, ImplementationGuide.ImplementationGuideGlobalComponent, ImplementationGuide.ImplementationGuidePackageComponent, ImplementationGuide.ImplementationGuidePackageResourceComponent, ImplementationGuide.ImplementationGuidePageComponent, Linkage.LinkageItemComponent, ListResource.ListEntryComponent, Location.LocationPositionComponent, Measure.MeasureGroupComponent, Measure.MeasureGroupPopulationComponent, Measure.MeasureGroupStratifierComponent, Measure.MeasureSupplementalDataComponent, MeasureReport.MeasureReportGroupComponent, MeasureReport.MeasureReportGroupPopulationComponent, MeasureReport.MeasureReportGroupStratifierComponent, MeasureReport.StratifierGroupComponent, MeasureReport.StratifierGroupPopulationComponent, Medication.MedicationIngredientComponent, Medication.MedicationPackageBatchComponent, Medication.MedicationPackageComponent, Medication.MedicationPackageContentComponent, MedicationAdministration.MedicationAdministrationDosageComponent, MedicationAdministration.MedicationAdministrationPerformerComponent, MedicationDispense.MedicationDispensePerformerComponent, MedicationDispense.MedicationDispenseSubstitutionComponent, MedicationRequest.MedicationRequestDispenseRequestComponent, MedicationRequest.MedicationRequestRequesterComponent, MedicationRequest.MedicationRequestSubstitutionComponent, MessageDefinition.MessageDefinitionAllowedResponseComponent, MessageDefinition.MessageDefinitionFocusComponent, MessageHeader.MessageDestinationComponent, MessageHeader.MessageHeaderResponseComponent, MessageHeader.MessageSourceComponent, NamingSystem.NamingSystemUniqueIdComponent, NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent, NutritionOrder.NutritionOrderEnteralFormulaComponent, NutritionOrder.NutritionOrderOralDietComponent, NutritionOrder.NutritionOrderOralDietNutrientComponent, NutritionOrder.NutritionOrderOralDietTextureComponent, NutritionOrder.NutritionOrderSupplementComponent, Observation.ObservationComponentComponent, Observation.ObservationReferenceRangeComponent, Observation.ObservationRelatedComponent, OperationDefinition.OperationDefinitionOverloadComponent, OperationDefinition.OperationDefinitionParameterBindingComponent, OperationDefinition.OperationDefinitionParameterComponent, OperationOutcome.OperationOutcomeIssueComponent, Organization.OrganizationContactComponent, Parameters.ParametersParameterComponent, Patient.AnimalComponent, Patient.ContactComponent, Patient.PatientCommunicationComponent, Patient.PatientLinkComponent, PaymentReconciliation.DetailsComponent, PaymentReconciliation.NotesComponent, Person.PersonLinkComponent, PlanDefinition.PlanDefinitionActionComponent, PlanDefinition.PlanDefinitionActionConditionComponent, PlanDefinition.PlanDefinitionActionDynamicValueComponent, PlanDefinition.PlanDefinitionActionParticipantComponent, PlanDefinition.PlanDefinitionActionRelatedActionComponent, PlanDefinition.PlanDefinitionGoalComponent, PlanDefinition.PlanDefinitionGoalTargetComponent, Practitioner.PractitionerQualificationComponent, PractitionerRole.PractitionerRoleAvailableTimeComponent, PractitionerRole.PractitionerRoleNotAvailableComponent, Procedure.ProcedureFocalDeviceComponent, Procedure.ProcedurePerformerComponent, ProcedureRequest.ProcedureRequestRequesterComponent, ProcessRequest.ItemsComponent, ProcessResponse.ProcessResponseProcessNoteComponent, Provenance.ProvenanceAgentComponent, Provenance.ProvenanceEntityComponent, Questionnaire.QuestionnaireItemComponent, Questionnaire.QuestionnaireItemEnableWhenComponent, Questionnaire.QuestionnaireItemOptionComponent, QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent, QuestionnaireResponse.QuestionnaireResponseItemComponent, ReferralRequest.ReferralRequestRequesterComponent, RequestGroup.RequestGroupActionComponent, RequestGroup.RequestGroupActionConditionComponent, RequestGroup.RequestGroupActionRelatedActionComponent, ResearchStudy.ResearchStudyArmComponent, RiskAssessment.RiskAssessmentPredictionComponent, SearchParameter.SearchParameterComponentComponent, Sequence.SequenceQualityComponent, Sequence.SequenceReferenceSeqComponent, Sequence.SequenceRepositoryComponent, Sequence.SequenceVariantComponent, Specimen.SpecimenCollectionComponent, Specimen.SpecimenContainerComponent, Specimen.SpecimenProcessingComponent, StructureDefinition.StructureDefinitionDifferentialComponent, StructureDefinition.StructureDefinitionMappingComponent, StructureDefinition.StructureDefinitionSnapshotComponent, StructureMap.StructureMapGroupComponent, StructureMap.StructureMapGroupInputComponent, StructureMap.StructureMapGroupRuleComponent, StructureMap.StructureMapGroupRuleDependentComponent, StructureMap.StructureMapGroupRuleSourceComponent, StructureMap.StructureMapGroupRuleTargetComponent, StructureMap.StructureMapGroupRuleTargetParameterComponent, StructureMap.StructureMapStructureComponent, Subscription.SubscriptionChannelComponent, Substance.SubstanceIngredientComponent, Substance.SubstanceInstanceComponent, SupplyDelivery.SupplyDeliverySuppliedItemComponent, SupplyRequest.SupplyRequestOrderedItemComponent, SupplyRequest.SupplyRequestRequesterComponent, Task.ParameterComponent, Task.TaskOutputComponent, Task.TaskRequesterComponent, Task.TaskRestrictionComponent, TestReport.SetupActionAssertComponent, TestReport.SetupActionComponent, TestReport.SetupActionOperationComponent, TestReport.TeardownActionComponent, TestReport.TestActionComponent, TestReport.TestReportParticipantComponent, TestReport.TestReportSetupComponent, TestReport.TestReportTeardownComponent, TestReport.TestReportTestComponent, TestScript.ActionAssertRuleComponent, TestScript.ActionAssertRuleParamComponent, TestScript.ActionAssertRulesetComponent, TestScript.ActionAssertRulesetRuleComponent, TestScript.ActionAssertRulesetRuleParamComponent, TestScript.RuleParamComponent, TestScript.RulesetRuleComponent, TestScript.RulesetRuleParamComponent, TestScript.SetupActionAssertComponent, TestScript.SetupActionComponent, TestScript.SetupActionOperationComponent, TestScript.SetupActionOperationRequestHeaderComponent, TestScript.TeardownActionComponent, TestScript.TestActionComponent, TestScript.TestScriptDestinationComponent, TestScript.TestScriptFixtureComponent, TestScript.TestScriptMetadataCapabilityComponent, TestScript.TestScriptMetadataComponent, TestScript.TestScriptMetadataLinkComponent, TestScript.TestScriptOriginComponent, TestScript.TestScriptRuleComponent, TestScript.TestScriptRulesetComponent, TestScript.TestScriptSetupComponent, TestScript.TestScriptTeardownComponent, TestScript.TestScriptTestComponent, TestScript.TestScriptVariableComponent, ValueSet.ConceptReferenceComponent, ValueSet.ConceptReferenceDesignationComponent, ValueSet.ConceptSetComponent, ValueSet.ConceptSetFilterComponent, ValueSet.ValueSetComposeComponent, 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	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.dstu3.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
BackboneElement()	Constructor

Method Summary

Modifier and Type	Method	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()
Extension	getModifierExtensionFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
boolean	hasModifierExtension()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
BackboneElement	setModifierExtension(List<Extension> theModifierExtension)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, 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, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

Field Details

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 Details

BackboneElement

public BackboneElement()

Constructor

Method Details

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

setModifierExtension

public BackboneElement setModifierExtension(List<Extension> theModifierExtension)

Returns:

Returns a reference to this for easy method chaining

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

addModifierExtension

public BackboneElement addModifierExtension(Extension t)

getModifierExtensionFirstRep

public Extension getModifierExtensionFirstRep()

Returns:

The first repetition of repeating field modifierExtension, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

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

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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()

Specified by:

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

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