DSTU2 STU 3 Ballot
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R4B R4 R3 R2

1.22.0 2.26.0 BackboneElement BackboneElement

The base definition for elements defined as part of a resource definition. Data Type elements do not use this type. For instance,
FHIR Infrastructure FHIR Infrastructure Work Group Work Group Maturity Level : N/A Maturity Level : N/A Ballot Status : DSTU 2 Ballot Status : STU 3

The base definition for elements defined as part of a resource definition. Data Type elements do not use this type. For instance, Patient.contact is an element that is defined as part of the patient resource, so it automatically has the type is an element that is defined as part of the patient resource, so it automatically has the type BackboneElement . Note that the descendent types of .

Note that the descendent types of BackboneElement are all declared implicitly as part of the definitions of the resources. are all declared implicitly as part of the definitions of the resources.

1.22.0.1 Content 2.26.0.1 Content

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . BackboneElement Element Base for elements defined inside a resource Base for elements defined inside a resource
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored Extensions that cannot be ignored

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram ( Legend )

Element Extensions - as described for all elements: additional information that is not part of the basic definition of the resource / type Extensions - as described for all elements: additional information that is not part of the basic definition of the resource / type extension : : Extension 0..* 0..* BackboneElement 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 (this element modifies the meaning of other elements) 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 (this element modifies the meaning of other elements) modifierExtension : : Extension [0..*] [0..*]

XML Template XML Template <

<[name] xmlns="http://hl7.org/fhir"> doco

 <!-- from Element: extension -->
 <</modifierExtension>

 <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension>

</[name]>

JSON Template JSON Template  {


{doco

  // from Element: extension
  (Modifier Extensions - see JSON page)
}

Turtle Template



@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:BackboneElement.modifierExtension [ Extension ], ... ; # 0..* Extensions that cannot be ignored
]

Changes since DSTU2


BackboneElement No Changes

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . BackboneElement Element Base for elements defined inside a resource Base for elements defined inside a resource
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored Extensions that cannot be ignored

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram ( Legend )

Element Extensions - as described for all elements: additional information that is not part of the basic definition of the resource / type Extensions - as described for all elements: additional information that is not part of the basic definition of the resource / type extension : : Extension 0..* 0..* BackboneElement 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 (this element modifies the meaning of other elements) 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 (this element modifies the meaning of other elements) modifierExtension : : Extension [0..*] [0..*]

XML Template XML Template <

<[name] xmlns="http://hl7.org/fhir"> doco

 <!-- from Element: extension -->
 <</modifierExtension>

 <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension>

</[name]>

JSON Template JSON Template {

{doco

  // from Element: extension
  (Modifier Extensions - see JSON page)
}

Turtle Template


@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:BackboneElement.modifierExtension [ Extension ], ... ; # 0..* Extensions that cannot be ignored
]

Changes since DSTU2

BackboneElement No Changes

See the Full Difference for further information

1.22.0.2 Specializations 2.26.0.2 Specializations This table lists all the specializations of

This table lists all the specializations of BackboneElement that are defined, and the path at which they are defined. that are defined, and the path at which they are defined.

AllergyIntolerance. Reaction Appointment. Participant AuditEvent.event AuditEvent. Event AuditEvent. Participant AuditEvent. Network AuditEvent. Source AuditEvent. Object AuditEvent. Detail Bundle. Link Bundle. Entry Bundle. Search Bundle. Request Bundle. Response CarePlan. RelatedPlan CarePlan. Participant CarePlan. Activity Claim. Detail Claim. SubDetail Claim. Prosthesis Claim. MissingTeeth ClaimResponse. Items ClaimResponse. ItemAdjudication ClaimResponse. ItemDetail ClaimResponse. DetailAdjudication ClaimResponse. SubDetail ClaimResponse. SubdetailAdjudication ClaimResponse. AddedItem ClaimResponse. AddedItemAdjudication ClaimResponse. AddedItemsDetail ClaimResponse. AddedItemDetailAdjudication ClaimResponse. Errors ClaimResponse. Notes ClaimResponse. Coverage Communication. Payload Composition. Attester Composition. Event Composition. Section ConceptMap. Contact ConceptMap. SourceElement ConceptMap. TargetElement Condition. Stage Condition. Evidence Conformance. Contact Conformance. Software Conformance. Implementation Conformance. Rest Conformance. Security Conformance. Certificate Conformance. Resource Conformance. ResourceInteraction Conformance. SearchParam Conformance. SystemInteraction Conformance. Operation Conformance. Messaging Conformance. Endpoint Conformance. Event Contract. Term Contract. TermActor Contract. TermValuedItem Contract. FriendlyLanguage Contract. LegalLanguage Contract. ComputableLanguage DataElement. Contact DataElement. Mapping DetectedIssue. Mitigation DeviceComponent. ProductionSpecification Immunization. Explanation Immunization. Reaction Immunization. VaccinationProtocol ImmunizationRecommendation. Recommendation ImmunizationRecommendation. DateCriterion ImmunizationRecommendation. Protocol ImplementationGuide. Contact ImplementationGuide. Dependency ImplementationGuide. Package ImplementationGuide. Resource List. Entry MedicationDispense. DosageInstruction MedicationOrder. DosageInstruction MedicationOrder. DispenseRequest MedicationStatement. Dosage MessageHeader. Response MessageHeader. MessageSource MessageHeader. MessageDestination NamingSystem. Contact NamingSystem. UniqueId NutritionOrder. OralDiet NutritionOrder. Nutrient NutritionOrder. Texture NutritionOrder. Supplement NutritionOrder. EnteralFormula NutritionOrder. Administration Observation. ReferenceRange Observation. Related Observation. Component OperationDefinition. Contact OperationDefinition. Parameter OperationDefinition. Binding OperationOutcome. Issue Order Order.when Order. When Organization. Contact Patient. Contact Patient. Animal Patient. Communication Patient. Link Procedure. Performer Procedure. FocalDevice ProcessRequest. Items ProcessResponse. Notes Provenance. Agent Provenance. RelatedAgent Provenance. Entity Questionnaire. Group Specimen. Container StructureDefinition. Contact StructureDefinition. Mapping StructureDefinition. Snapshot StructureDefinition. Differential Subscription. Channel ValueSet. ConceptSet ValueSet. Filter ValueSet. Expansion ValueSet. Parameter ValueSet. Contains VisionPrescription. Dispense © HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100. Links: Search | Version History | Table of Contents | Compare to DSTU1
Path
ActivityDefinition
Type Name ActivityDefinition.dynamicValue
AllergyIntolerance
AllergyIntolerance.reaction
Appointment
Appointment.participant
AuditEvent
AuditEvent.participant AuditEvent.agent
AuditEvent.participant.network AuditEvent.agent.network
AuditEvent.source
AuditEvent.object AuditEvent.entity
AuditEvent.object.detail AuditEvent.entity.detail
Bundle
Bundle.link
Bundle.entry
Bundle.entry.search
Bundle.entry.request
Bundle.entry.response
CarePlan
CarePlan.relatedPlan
CarePlan.participant CarePlan.activity
CarePlan.activity CarePlan.activity.detail
CarePlan.activity.detail CareTeam
CarePlan. Detail CareTeam.participant
Claim
Claim.related
Claim.payee
Claim. Payee Claim.information
Claim.diagnosis
Claim. Diagnosis Claim.procedure
Claim.coverage
Claim. Coverage Claim.accident
Claim.item
Claim. Items Claim.item.careTeam
Claim.item.detail
Claim.item.detail.subDetail
Claim.item.prosthesis
Claim.missingTeeth
ClaimResponse
ClaimResponse.item
ClaimResponse.item.adjudication
ClaimResponse.item.detail
ClaimResponse.item.detail.adjudication ClaimResponse.item.detail.subDetail
ClaimResponse.item.detail.subDetail ClaimResponse.addItem
ClaimResponse.item.detail.subDetail.adjudication ClaimResponse.addItem.detail
ClaimResponse.addItem ClaimResponse.error
ClaimResponse.addItem.adjudication ClaimResponse.payment
ClaimResponse.addItem.detail ClaimResponse.note
ClaimResponse.addItem.detail.adjudication ClaimResponse.coverage
ClaimResponse.error ClinicalImpression
ClaimResponse.note ClinicalImpression.investigations
ClaimResponse.coverage ClinicalImpression.finding
ClinicalImpression CodeSystem
ClinicalImpression.investigations CodeSystem.contact
ClinicalImpression. Investigations CodeSystem.filter
ClinicalImpression.finding CodeSystem.property
ClinicalImpression. Finding CodeSystem.concept
ClinicalImpression.ruledOut CodeSystem.concept.designation
ClinicalImpression. RuledOut CodeSystem.concept.property
Communication
Communication.payload
CommunicationRequest
CommunicationRequest.payload
CompartmentDefinition
CommunicationRequest. Payload CompartmentDefinition.contact
CompartmentDefinition.resource
Composition
Composition.attester
Composition.event
Composition.section
ConceptMap
ConceptMap.contact
ConceptMap.element ConceptMap.group
ConceptMap.element.target ConceptMap.group.element
ConceptMap.element.target.dependsOn ConceptMap.group.element.target
ConceptMap. OtherElement ConceptMap.group.element.target.dependsOn
Condition
Condition.stage
Condition.evidence
Conformance
Conformance.contact
Conformance.software
Conformance.implementation
Conformance.rest
Conformance.rest.security
Conformance.rest.security.certificate
Conformance.rest.resource
Conformance.rest.resource.interaction
Conformance.rest.resource.searchParam
Conformance.rest.interaction
Conformance.rest.operation
Conformance.messaging
Conformance.messaging.endpoint
Conformance.messaging.event
Conformance.document
Consent Conformance. Document
Contract Consent.except
Contract.actor Consent.except.actor
Contract. Actor Consent.except.data
Contract.valuedItem Contract
Contract. ValuedItem Contract.agent
Contract.signer
Contract. Signatory Contract.valuedItem
Contract.term
Contract.term.actor Contract.term.agent
Contract.term.valuedItem
Contract.friendly
Contract.legal
Contract.rule
DataElement
DataElement.contact
DataElement.mapping
DetectedIssue
DetectedIssue.mitigation
DeviceComponent
DeviceComponent.productionSpecification
DeviceMetric
DeviceMetric.calibration
DiagnosticReport
DeviceMetric. Calibration DiagnosticReport.image
DiagnosticOrder DocumentManifest
DiagnosticOrder.event DocumentManifest.content
DiagnosticOrder. Event DocumentManifest.related
DocumentReference
DiagnosticOrder.item DocumentReference.relatesTo
DiagnosticOrder. Item DocumentReference.content
DocumentReference.context
DocumentReference.context.related
DiagnosticReport EligibilityResponse
DiagnosticReport.image EligibilityResponse.benefitBalance
DiagnosticReport. Image EligibilityResponse.benefitBalance.financial
EligibilityResponse.error
DocumentManifest Encounter
DocumentManifest.content Encounter.statusHistory
DocumentManifest. Content Encounter.participant
DocumentManifest.related Encounter.hospitalization
DocumentManifest. Related Encounter.location
DocumentReference EpisodeOfCare
DocumentReference.relatesTo EpisodeOfCare.statusHistory
ExpansionProfile DocumentReference. RelatesTo
DocumentReference.content ExpansionProfile.contact
DocumentReference. Content ExpansionProfile.codeSystem
DocumentReference.context ExpansionProfile.codeSystem.include
DocumentReference. Context ExpansionProfile.codeSystem.include.codeSystem
DocumentReference.context.related ExpansionProfile.codeSystem.exclude
DocumentReference. Related ExpansionProfile.codeSystem.exclude.codeSystem
Encounter ExpansionProfile.designation
Encounter.statusHistory ExpansionProfile.designation.include
Encounter. StatusHistory ExpansionProfile.designation.include.designation
Encounter.participant ExpansionProfile.designation.exclude
Encounter. Participant ExpansionProfile.designation.exclude.designation
ExplanationOfBenefit
Encounter.hospitalization ExplanationOfBenefit.related
Encounter. Hospitalization ExplanationOfBenefit.payee
Encounter.location ExplanationOfBenefit.information
Encounter. Location ExplanationOfBenefit.diagnosis
EpisodeOfCare ExplanationOfBenefit.procedure
EpisodeOfCare.statusHistory ExplanationOfBenefit.coverage
EpisodeOfCare. StatusHistory ExplanationOfBenefit.accident
EpisodeOfCare.careTeam ExplanationOfBenefit.item
EpisodeOfCare. CareTeam ExplanationOfBenefit.item.careTeam
FamilyMemberHistory ExplanationOfBenefit.item.adjudication
FamilyMemberHistory.condition ExplanationOfBenefit.item.detail
FamilyMemberHistory. Condition ExplanationOfBenefit.item.detail.subDetail
Goal ExplanationOfBenefit.item.prosthesis
Goal.outcome ExplanationOfBenefit.addItem
Goal. Outcome ExplanationOfBenefit.addItem.detail
Group ExplanationOfBenefit.missingTeeth
Group.characteristic ExplanationOfBenefit.payment
Group. Characteristic ExplanationOfBenefit.note
Group.member ExplanationOfBenefit.benefitBalance
Group. Member ExplanationOfBenefit.benefitBalance.financial
HealthcareService FamilyMemberHistory
HealthcareService.serviceType FamilyMemberHistory.condition
Goal
HealthcareService. ServiceType Goal.outcome
Group
HealthcareService.availableTime Group.characteristic
HealthcareService. AvailableTime Group.member
GuidanceResponse
HealthcareService.notAvailable GuidanceResponse.action
HealthcareService. NotAvailable GuidanceResponse.action.relatedAction
ImagingObjectSelection HealthcareService
ImagingObjectSelection.study HealthcareService.availableTime
ImagingObjectSelection. Study HealthcareService.notAvailable
ImagingObjectSelection.study.series ImagingManifest
ImagingObjectSelection. Series ImagingManifest.study
ImagingObjectSelection.study.series.instance ImagingManifest.study.baseLocation
ImagingObjectSelection. Instance ImagingManifest.study.series
ImagingObjectSelection.study.series.instance.frames ImagingManifest.study.series.baseLocation
ImagingObjectSelection. Frames ImagingManifest.study.series.instance
ImagingStudy
ImagingStudy.series ImagingStudy.baseLocation
ImagingStudy. Series ImagingStudy.series
ImagingStudy.series.instance ImagingStudy.series.baseLocation
ImagingStudy. Instance ImagingStudy.series.instance
Immunization
Immunization.explanation
Immunization.reaction
Immunization.vaccinationProtocol
ImmunizationRecommendation
ImmunizationRecommendation.recommendation
ImmunizationRecommendation.recommendation.dateCriterion
ImmunizationRecommendation.recommendation.protocol
ImplementationGuide
ImplementationGuide.contact
ImplementationGuide.dependency
ImplementationGuide.package
ImplementationGuide.package.resource
ImplementationGuide.global
ImplementationGuide. Global ImplementationGuide.page
ImplementationGuide.page Linkage
ImplementationGuide. Page Linkage.item
List
List.entry
Location
Location.position
Measure
Location. Position Measure.group
Measure.group.population
Measure.group.stratifier
Measure.supplementalData
Medication MeasureReport
Medication.product MeasureReport.group
Medication. Product MeasureReport.group.population
Medication.product.ingredient MeasureReport.group.stratifier
Medication. Ingredient MeasureReport.group.stratifier.group
Medication.product.batch MeasureReport.group.stratifier.group.population
Medication. Batch MeasureReport.group.supplementalData
Medication.package MeasureReport.group.supplementalData.group
Medication
Medication. Package Medication.product
Medication.package.content Medication.product.ingredient
Medication. Content Medication.product.batch
Medication.package
Medication.package.content
MedicationAdministration
MedicationAdministration.dosage
MedicationAdministration. Dosage MedicationAdministration.eventHistory
MedicationDispense
MedicationDispense.dosageInstruction
MedicationDispense.substitution
MedicationDispense. Substitution MedicationDispense.eventHistory
MedicationOrder
MedicationOrder.dosageInstruction
MedicationOrder.dispenseRequest
MedicationOrder.substitution
MedicationOrder. Substitution MedicationOrder.eventHistory
MedicationStatement
MedicationStatement.dosage
MessageHeader
MessageHeader.response
MessageHeader.source
MessageHeader.destination
NamingSystem
NamingSystem.contact
NamingSystem.uniqueId
NutritionOrder NutritionRequest
NutritionOrder.oralDiet NutritionRequest.oralDiet
NutritionOrder.oralDiet.nutrient NutritionRequest.oralDiet.nutrient
NutritionOrder.oralDiet.texture NutritionRequest.oralDiet.texture
NutritionOrder.supplement NutritionRequest.supplement
NutritionOrder.enteralFormula NutritionRequest.enteralFormula
NutritionOrder.enteralFormula.administration NutritionRequest.enteralFormula.administration
Observation
Observation.referenceRange
Observation.related
Observation.component
OperationDefinition
OperationDefinition.contact
OperationDefinition.parameter
OperationDefinition.parameter.binding
OperationOutcome
OperationOutcome.issue
Organization
Organization.contact
Patient
Patient.contact
Patient.animal
Patient.communication
Patient.link
PaymentReconciliation
PaymentReconciliation.detail
PaymentReconciliation. Details PaymentReconciliation.note
PaymentReconciliation.note Person
PaymentReconciliation. Notes Person.link
Person PlanDefinition
Person.link PlanDefinition.actionDefinition
Person. Link PlanDefinition.actionDefinition.condition
PlanDefinition.actionDefinition.relatedAction
PlanDefinition.actionDefinition.dynamicValue
Practitioner
Practitioner.practitionerRole Practitioner.role
Practitioner. Practitioner.qualification
PractitionerRole
Practitioner.qualification PractitionerRole.availableTime
Practitioner. Qualification PractitionerRole.notAvailable
Procedure
Procedure.performer
Procedure.focalDevice
ProcessRequest
ProcessRequest.item
ProcessResponse
ProcessResponse.notes
Provenance
Provenance.agent
Provenance.agent.relatedAgent
Provenance.entity
Questionnaire
Questionnaire.group Questionnaire.item
Questionnaire.group.question Questionnaire.item.enableWhen
Questionnaire. Question Questionnaire.item.option
QuestionnaireResponse
QuestionnaireResponse.group QuestionnaireResponse.item
QuestionnaireResponse. Group QuestionnaireResponse.item.answer
QuestionnaireResponse.group.question RiskAssessment
QuestionnaireResponse. Question RiskAssessment.prediction
QuestionnaireResponse.group.question.answer SearchParameter
QuestionnaireResponse. Answer SearchParameter.contact
RiskAssessment Sequence
RiskAssessment.prediction Sequence.referenceSeq
RiskAssessment. Prediction Sequence.variant
SearchParameter Sequence.quality
SearchParameter.contact Sequence.repository
SearchParameter. Contact Sequence.structureVariant
Specimen Sequence.structureVariant.outer
Specimen.collection Sequence.structureVariant.inner
Specimen Specimen. Collection
Specimen.treatment Specimen.collection
Specimen. Treatment Specimen.treatment
Specimen.container
StructureDefinition
StructureDefinition.contact
StructureDefinition.mapping
StructureDefinition.snapshot
StructureDefinition.differential
Subscription StructureMap
Subscription.channel StructureMap.contact
Substance StructureMap.structure
Substance.instance StructureMap.group
Substance. Instance StructureMap.group.input
Substance.ingredient StructureMap.group.rule
Substance. Ingredient StructureMap.group.rule.source
SupplyRequest StructureMap.group.rule.target
SupplyRequest.when StructureMap.group.rule.target.parameter
SupplyRequest. When StructureMap.group.rule.dependent
TestScript Subscription
TestScript.contact Subscription.channel
Substance TestScript. Contact
TestScript.metadata Substance.instance
TestScript. Metadata Substance.ingredient
TestScript.metadata.link SupplyRequest
TestScript. Link SupplyRequest.when
TestScript.metadata.capability Task
TestScript. Capability Task.fulfillment
TestScript.fixture Task.input
TestScript. Fixture Task.output
TestScript.variable TestScript
TestScript. Variable TestScript.contact
TestScript.setup TestScript.origin
TestScript. Setup TestScript.destination
TestScript.setup.action TestScript.metadata
TestScript. Action TestScript.metadata.link
TestScript.setup.action.operation TestScript.metadata.capability
TestScript. Operation TestScript.fixture
TestScript.setup.action.operation.requestHeader TestScript.variable
TestScript. RequestHeader TestScript.rule
TestScript.setup.action.assert TestScript.rule.param
TestScript. Assert TestScript.ruleset
TestScript.test TestScript.ruleset.rule
TestScript. Test TestScript.ruleset.rule.param
TestScript.test.action TestScript.setup
TestScript. Action TestScript.setup.action
TestScript.teardown TestScript.setup.action.operation
TestScript. Teardown TestScript.setup.action.operation.requestHeader
TestScript.teardown.action TestScript.setup.action.assert
TestScript. Action TestScript.setup.action.assert.rule
ValueSet TestScript.setup.action.assert.rule.param
ValueSet.contact TestScript.setup.action.assert.ruleset
ValueSet. Contact TestScript.setup.action.assert.ruleset.rule
ValueSet.codeSystem TestScript.setup.action.assert.ruleset.rule.param
ValueSet. CodeSystem TestScript.test
ValueSet.codeSystem.concept TestScript.test.action
ValueSet. ConceptDefinition TestScript.teardown
ValueSet.codeSystem.concept.designation TestScript.teardown.action
ValueSet ValueSet. Designation
ValueSet.compose ValueSet.contact
ValueSet. Compose ValueSet.compose
ValueSet.compose.include
ValueSet.compose.include.concept
ValueSet. ConceptReference ValueSet.compose.include.concept.designation
ValueSet.compose.include.filter
ValueSet.expansion
ValueSet.expansion.parameter
ValueSet.expansion.contains
VisionPrescription
VisionPrescription.dispense