This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Modeling and Methodology Work Group | Maturity Level: N/A | Ballot Status: Informative |
StructureDefinition for BackboneElement
{ "resourceType": "StructureDefinition", "id": "BackboneElement", "meta": { "lastUpdated": "2018-04-03T12:05:46.262+10:00" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status", "valueString": "Normative" } ], "url": "http://hl7.org/fhir/StructureDefinition/BackboneElement", "name": "BackboneElement", "status": "draft", "date": "2018-04-03T12:05:46+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.", "fhirVersion": "3.3.0", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": true, "type": "BackboneElement", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element", "derivation": "specialization", "snapshot": { "element": [ { "id": "BackboneElement", "path": "BackboneElement", "short": "Base for elements defined inside a resource", "definition": "Base definition for all elements that are defined inside a resource - but not those in a data type.", "min": 0, "max": "*", "base": { "path": "BackboneElement", "min": 0, "max": "*" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "BackboneElement.id", "path": "BackboneElement.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "BackboneElement.extension", "path": "BackboneElement.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "BackboneElement.modifierExtension", "path": "BackboneElement.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "id": "BackboneElement", "path": "BackboneElement", "short": "Base for elements defined inside a resource", "definition": "Base definition for all elements that are defined inside a resource - but not those in a data type.", "min": 0, "max": "*", "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "BackboneElement.modifierExtension", "path": "BackboneElement.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.