{
"description": "Identifies how the ElementDefinition data type is used when it appears within a data element",
"_filename": "StructureDefinition-elementdefinition-de.json",
"package_name": "hl7.fhir.r2.core",
"date": "2015-02-28",
"publisher": "Health Level Seven International (Orders and Observations)",
"fhirVersion": "1.0.2",
"name": "DataElement constraint on ElementDefinition data type",
"abstract": false,
"type": null,
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.2",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "eld-13",
"human": "Types must be unique by the combination of code and profile",
"xpath": "not(exists(for $type in f:type return $type/preceding-sibling::f:type[f:code/@value=$type/f:code/@value and f:profile/@value = $type/f:profile/@value]))",
"severity": "error"
}, {
"key": "eld-14",
"human": "Constraints must be unique by key",
"xpath": "count(f:constraint) = count(distinct-values(f:constraint/f:key/@value))",
"severity": "error"
}, {
"key": "eld-11",
"human": "Binding can only be present for coded elements, string, and uri",
"xpath": "not(exists(f:binding)) or (count(f:type/f:code) = 0) or f:type/f:code/@value=('code','Coding','CodeableConcept','Quantity','Extension', 'string', 'uri')",
"severity": "error"
}, {
"key": "eld-8",
"human": "Pattern and value are mutually exclusive",
"xpath": "not(exists(f:*[starts-with(local-name(.), 'pattern')])) or not(exists(f:*[starts-with(local-name(.), 'value')]))",
"severity": "error"
}, {
"key": "eld-15",
"human": "default value and meaningWhenMissing are mutually exclusive",
"xpath": "not(exists(f:*[starts-with(local-name(.), 'fixed')])) or not(exists(f:meaningWhenMissing))",
"severity": "error"
}, {
"key": "eld-2",
"human": "Min <= Max",
"xpath": "not(exists(f:min)) or not(exists(f:max)) or (not(f:max/@value) and not(f:min/@value)) or (f:max/@value = '*') or (number(f:max/@value) >= f:min/@value)",
"severity": "error"
}, {
"key": "eld-7",
"human": "Pattern may only be specified if there is one type",
"xpath": "not(exists(f:*[starts-with(local-name(.), 'pattern')])) or (count(f:type)=1)",
"severity": "error"
}, {
"key": "eld-6",
"human": "Fixed value may only be specified if there is one type",
"xpath": "not(exists(f:*[starts-with(local-name(.), 'fixed')])) or (count(f:type)=1)",
"severity": "error"
}, {
"key": "eld-5",
"human": "Either a namereference or a fixed value (but not both) is permitted",
"xpath": "not(exists(f:nameReference) and exists(f:*[starts-with(local-name(.), 'value')]))",
"severity": "error"
} ],
"path": "ElementDefinition",
"min": 0,
"definition": "Captures constraints on each element within the resource, profile, or extension.",
"short": "Definition of an element in a resource or extension",
"name": "elementdefinition-de",
"mapping": [ {
"map": "RetrieveMetadata response",
"identity": "dex"
}, {
"map": "OM1",
"identity": "v2"
}, {
"map": "Observation[classCode=OBS, moodCode=DEFN]",
"identity": "rim"
}, {
"map": "Data_Element",
"identity": "iso11179"
} ],
"type": [ {
"code": "ElementDefinition"
} ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition"
},
"isSummary": true
}, {
"path": "ElementDefinition.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.id"
}
}, {
"path": "ElementDefinition.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ "url" ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.extension"
}
}, {
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.extension"
},
"name": "Question",
"path": "ElementDefinition.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/elementdefinition-question" ]
} ],
"short": "Extension",
"definition": "An Extension"
}, {
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.extension"
},
"name": "AllowedUnits",
"path": "ElementDefinition.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" ]
} ],
"short": "Extension",
"definition": "An Extension"
}, {
"path": "ElementDefinition.path",
"min": 1,
"definition": "The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource or extension.",
"short": "The path of the element (see the Detailed Descriptions)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "Name, Identifier & Context",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.path"
},
"isSummary": true
}, {
"path": "ElementDefinition.representation",
"min": 0,
"definition": "Codes that define how this element is represented in instances, when the deviation varies from the normal case.",
"short": "How this element is represented in instances",
"comments": "This is rarely used except for special cases where the representation deviates from the normal, which is done only very reluctantly, and can only be done in the base standard (and profiles must reproduce what the base standard does).",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "How a property is represented on the wire.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/property-representation"
}
},
"max": "0",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.representation"
},
"isSummary": true
}, {
"path": "ElementDefinition.name",
"requirements": "Allows referencing a defined element. May also be used for code generation purposes.",
"min": 0,
"definition": "The name of this element definition (to refer to it from other element definitions using ElementDefinition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.",
"short": "Name for this particular element definition (reference target)",
"comments": "The name SHALL be unique within the structure within the context of the constrained resource element. (Though to avoid confusion, uniqueness across all elements is recommended.).",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.name"
},
"isSummary": true
}, {
"path": "ElementDefinition.label",
"min": 0,
"definition": "The text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.",
"short": "Name for element to display with or prompt for element",
"comments": "Question and label serve similar purposes in they both can be used to prompt for capturing a data element. Whether the question form or label form should be used will depend on the type of instrument being used to capture the information.",
"mapping": [ {
"map": "./code/display",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.label"
},
"isSummary": true
}, {
"path": "ElementDefinition.code",
"requirements": "Links the meaning of an element to an external terminology.",
"min": 0,
"definition": "A code that provides the meaning for the element according to a particular terminology.",
"short": "Defining code",
"comments": "The data element definition and other constraints SHALL be a proper constraint on the meaning (as defined in the code system, including relationships) of any code listed here. Where multiple codes exist in a terminology that could correspond to the data element, the most granular code(s) should be selected, so long as they are not more restrictive than the data element itself.",
"mapping": [ {
"map": "LOINC_NUM",
"identity": "loinc"
}, {
"map": "OM1.7",
"identity": "v2"
}, {
"map": "./code (root or translation)",
"identity": "rim"
}, {
"map": "(Data_Element).data_element_concept.identifier",
"identity": "iso11179"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"description": "Codes that indicate the meaning of a data element.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/observation-codes"
}
},
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "eld-1",
"human": "If there are no discriminators, there must be a definition",
"xpath": "(f:discriminator) or (f:description)",
"severity": "error"
} ],
"path": "ElementDefinition.slicing",
"min": 0,
"definition": "Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).",
"short": "This element is sliced - slices follow",
"comments": "The first element in the sequence, the one that carries the slicing, is the unconstrained element, for reference purposes . This may include the unconstrained children.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "Element"
} ],
"max": "0",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.slicing"
},
"isSummary": true
}, {
"path": "ElementDefinition.slicing.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.slicing.id"
}
}, {
"path": "ElementDefinition.slicing.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.slicing.extension"
}
}, {
"path": "ElementDefinition.slicing.discriminator",
"min": 0,
"definition": "Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.",
"short": "Element values that used to distinguish the slices",
"comments": "If there is no discriminator, the content is hard to process, so this should be avoided. If the base element has a cardinality of ..1, and there is a choice of types, the discriminator most be \"@type\".",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.slicing.discriminator"
},
"isSummary": true
}, {
"path": "ElementDefinition.slicing.description",
"min": 0,
"definition": "A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.",
"short": "Text description of how slicing works (or not)",
"comments": "If it's really not possible to differentiate them, the design should be re-evaluated to make the content usable.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"condition": [ "eld-1" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.slicing.description"
},
"isSummary": true
}, {
"path": "ElementDefinition.slicing.ordered",
"min": 0,
"definition": "If the matching elements have to occur in the same order as defined in the profile.",
"short": "If elements must be in same order as slices",
"comments": "Order should only be required when it is a pressing concern for presentation. Profile authors should consider making the order a feature of the rules about the narrative, not the rules about the data - requiring ordered data makes the profile much less re-usable.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": false,
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.slicing.ordered"
},
"isSummary": true
}, {
"path": "ElementDefinition.slicing.rules",
"min": 1,
"definition": "Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.",
"short": "closed | open | openAtEnd",
"comments": "Allowing additional elements makes for a much for flexible template - it's open for use in wider contexts, but also means that the content of the resource is not closed, and applications have to decide how to handle content not described by the profile.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "How slices are interpreted when evaluating an instance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-slicing-rules"
}
},
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.slicing.rules"
},
"isSummary": true
}, {
"path": "ElementDefinition.short",
"min": 0,
"definition": "A concise description of what this element means (e.g. for use in autogenerated summaries).",
"short": "Concise definition for xml presentation",
"comments": "May change the term to provide language more appropriate to the context of the profile or to reflect slicing.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "N/A",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.short"
},
"isSummary": true
}, {
"path": "ElementDefinition.definition",
"requirements": "To allow a user to state the usage of an element in a particular context.",
"min": 0,
"definition": "Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.",
"short": "Full formal definition as narrative text",
"comments": "It is easy for a different definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing definitions.",
"mapping": [ {
"map": "TERM DEFINITION/DESCRIPTION(S)",
"identity": "loinc"
}, {
"map": "OM1.6, OM1.41",
"identity": "v2"
}, {
"map": "./text",
"identity": "rim"
}, {
"map": "(Designatable_Item).definition.text acceptability=preferred in default context",
"identity": "iso11179"
} ],
"type": [ {
"code": "markdown"
} ],
"alias": [ "Description" ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.definition"
},
"isSummary": true
}, {
"path": "ElementDefinition.comments",
"min": 0,
"definition": "Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.",
"short": "Comments about the use of this element",
"comments": "If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element.",
"mapping": [ {
"map": "COMMENTS",
"identity": "loinc"
}, {
"map": "NTE, OM.32, OM1.33, OM1.39",
"identity": "v2"
}, {
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code",
"identity": "rim"
}, {
"map": "(Administered_Item).explanatory_comment",
"identity": "iso11179"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.comments"
},
"isSummary": true
}, {
"path": "ElementDefinition.requirements",
"min": 0,
"definition": "This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.",
"short": "Why is this needed?",
"comments": "This element does not describe the usage of the element (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"mapping": [ {
"map": "R/O/C",
"identity": "loinc"
}, {
"map": "./inboundRelationship[typeCode=META]/source[classCode=ACT, moodCode=EVN, isCriterionInd=true]/reasonCode/originalText",
"identity": "rim"
}, {
"map": "(Registered_item).document_reference[document_type=requirements].notation",
"identity": "iso11179"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.requirements"
},
"isSummary": true
}, {
"path": "ElementDefinition.alias",
"requirements": "Allows for better easier recognition of the element by multiple communities, including international communities.",
"min": 0,
"definition": "Identifies additional names by which this element might also be known.",
"short": "Other names",
"mapping": [ {
"map": "RELATED NAMES (only some of these apply)",
"identity": "loinc"
}, {
"map": "OM1.8, OM1.52",
"identity": "v2"
}, {
"map": "Not currently expressible",
"identity": "rim"
}, {
"map": "(Designatable_Item).designation.sign acceptability!=preferred or context is other than default",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "synonym", "other name" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.alias"
},
"isSummary": true
}, {
"path": "ElementDefinition.min",
"min": 0,
"definition": "The minimum number of times this element SHALL appear in the instance.",
"short": "Minimum Cardinality",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "Minimum size of data element values?",
"identity": "iso11179"
} ],
"type": [ {
"code": "integer"
} ],
"max": "1",
"condition": [ "eld-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.min"
},
"isSummary": true
}, {
"constraint": [ {
"key": "eld-3",
"human": "Max SHALL be a number or \"*\"",
"xpath": "@value='*' or (normalize-space(@value)!='' and normalize-space(translate(@value, '0123456789',''))='')",
"severity": "error"
} ],
"path": "ElementDefinition.max",
"min": 0,
"definition": "The maximum number of times this element is permitted to appear in the instance.",
"short": "Maximum Cardinality (a number or *)",
"mapping": [ {
"map": "OMC.10",
"identity": "v2"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "Maximum size of data element values?",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"condition": [ "eld-3", "eld-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.max"
},
"isSummary": true
}, {
"path": "ElementDefinition.base",
"min": 0,
"definition": "Information about the base definition of the element, provided to make it unncessary for tools to trace the deviation of the element through the derived and related profiles. This information is only provided where the element definition represents a constraint on another element definition, and must be present if there is a base element definition.",
"short": "Base definition information for tools",
"comments": "The base information does not carry any information that could not be determined from the path and related profiles, but making this determination requires both that the related profiles are available, and that the algorithm to determine them be available. So they are deformalised into this location for tooling convenience, and to ensure that the base information is available without dependencies.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "Element"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.base"
},
"isSummary": true
}, {
"path": "ElementDefinition.base.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.base.id"
}
}, {
"path": "ElementDefinition.base.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.base.extension"
}
}, {
"path": "ElementDefinition.base.path",
"min": 1,
"definition": "The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [[[StructureDefinition]]] without a StructureDefinition.base.",
"short": "Path that identifies the base element",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.base.path"
},
"isSummary": true
}, {
"path": "ElementDefinition.base.min",
"min": 1,
"definition": "Minimum cardinality of the base element identified by the path.",
"short": "Min cardinality of the base element",
"comments": "This is provided for consistency with max, and may affect code generation of mandatory elements of the base resource are generated differently (some reference implementations have done this).",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "integer"
} ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.base.min"
},
"isSummary": true
}, {
"path": "ElementDefinition.base.max",
"min": 1,
"definition": "Maximum cardinality of the base element identified by the path.",
"short": "Max cardinality of the base element",
"comments": "This is provided to code generation, since the wire representation in JSON differs depending on whether the base element has max > 1. Also, some forms of code generation may differ.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.base.max"
},
"isSummary": true
}, {
"constraint": [ {
"key": "eld-4",
"human": "Aggregation may only be specified if one of the allowed types for the element is a resource",
"xpath": "not(exists(f:aggregation)) or exists(f:code[@value = 'Reference'])",
"severity": "error"
} ],
"path": "ElementDefinition.type",
"min": 0,
"definition": "The data type or resource that the value of this element is permitted to be.",
"short": "Data type and Profile for this element",
"comments": "The Type of the element can be left blank, in which case the type is inherited from the resource. The type can only be listed in this field if it is an allowed option in the base resource.",
"mapping": [ {
"map": "valueDomain.dataType",
"identity": "dex"
}, {
"map": "HL7_V2_DATATYPE (translation required), HL7_V3_DATATYPE (translation required)",
"identity": "loinc"
}, {
"map": "OM1.3, OMC.9",
"identity": "v2"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": ".domain.data+Q14type",
"identity": "iso11179"
} ],
"type": [ {
"code": "Element"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "TypeRef"
} ],
"max": "*",
"condition": [ "eld-13" ],
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.type"
},
"isSummary": true
}, {
"path": "ElementDefinition.type.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.type.id"
}
}, {
"path": "ElementDefinition.type.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.type.extension"
}
}, {
"path": "ElementDefinition.type.code",
"min": 1,
"definition": "Name of Data type or Resource that is a(or the) type used for this element.",
"short": "Name of Data type or Resource",
"comments": "If the element is a reference to another resource, this element contains \"Reference\", and the profile element refers to the profile of the allowed target of the resource, which may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/StructureDefinition/Patient). There would be one pair of type/code for each allowed target resource type.",
"mapping": [ {
"map": "HL7_V2_DATATYPE (translation required), HL7_V3_DATATYPE (translation required)",
"identity": "loinc"
}, {
"map": "OM1.3",
"identity": "v2"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": ".domain.data+Q14type",
"identity": "iso11179"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Either a resource or a data type.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/defined-types"
}
},
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.type.code"
},
"isSummary": true
}, {
"path": "ElementDefinition.type.profile",
"min": 0,
"definition": "Identifies a profile structure or implementation Guide that SHALL hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile. When more than one profile is specified, the content must conform to all of them. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.",
"short": "Profile (StructureDefinition) to apply (or IG)",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "uri"
} ],
"max": "0",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.type.profile"
},
"isSummary": true
}, {
"path": "ElementDefinition.type.aggregation",
"min": 0,
"definition": "If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.",
"short": "contained | referenced | bundled - how aggregated",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "n/a",
"identity": "iso11179"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "How resource references can be aggregated.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-aggregation-mode"
}
},
"max": "0",
"condition": [ "eld-4" ],
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.type.aggregation"
},
"isSummary": true
}, {
"path": "ElementDefinition.nameReference",
"min": 0,
"definition": "Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.",
"short": "To another element constraint (by element.name)",
"comments": "If child components of this element are defined, they act as constraints on the referenced slice.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"condition": [ "eld-5" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.nameReference"
},
"isSummary": true
}, {
"path": "ElementDefinition.defaultValue[x]",
"min": 0,
"definition": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').",
"short": "Specified value it missing from instance",
"comments": "Default values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. Specifying a default value means that the property can never been unknown - it must always have a value. Further, the default value can never be changed. For these reasons, default values are (and should be) used extremely sparingly. This element should only be used on child elements of complex data elements.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
}, {
"code": "decimal"
}, {
"code": "base64Binary"
}, {
"code": "instant"
}, {
"code": "string"
}, {
"code": "uri"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "time"
}, {
"code": "code"
}, {
"code": "oid"
}, {
"code": "id"
}, {
"code": "unsignedInt"
}, {
"code": "positiveInt"
}, {
"code": "markdown"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "Identifier"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Period"
}, {
"code": "Ratio"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "HumanName"
}, {
"code": "Address"
}, {
"code": "ContactPoint"
}, {
"code": "Timing"
}, {
"code": "Reference"
}, {
"code": "Meta"
} ],
"max": "1",
"condition": [ "eld-15" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.defaultValue[x]"
},
"isSummary": true
}, {
"path": "ElementDefinition.meaningWhenMissing",
"min": 0,
"definition": "The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing'.",
"short": "Implicit meaning when this element is missing",
"comments": "Implicit meanings for missing values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. An implicit meaning for a missing value can never be changed, and specifying one has the consequence that constraining its use in profiles eliminates use cases as possibilities, not merely moving them out of scope. This element should only be used on child elements of complex data elements.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"condition": [ "eld-15" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.meaningWhenMissing"
},
"isSummary": true
}, {
"path": "ElementDefinition.fixed[x]",
"min": 0,
"definition": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.",
"short": "Value must be exactly this",
"comments": "This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "N/A (only relevant when constraining, which 11179 doesn't do)",
"identity": "iso11179"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
}, {
"code": "decimal"
}, {
"code": "base64Binary"
}, {
"code": "instant"
}, {
"code": "string"
}, {
"code": "uri"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "time"
}, {
"code": "code"
}, {
"code": "oid"
}, {
"code": "id"
}, {
"code": "unsignedInt"
}, {
"code": "positiveInt"
}, {
"code": "markdown"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "Identifier"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Period"
}, {
"code": "Ratio"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "HumanName"
}, {
"code": "Address"
}, {
"code": "ContactPoint"
}, {
"code": "Timing"
}, {
"code": "Reference"
}, {
"code": "Meta"
} ],
"max": "0",
"condition": [ "eld-5", "eld-6", "eld-8" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.fixed[x]"
},
"isSummary": true
}, {
"path": "ElementDefinition.pattern[x]",
"min": 0,
"definition": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).",
"short": "Value must have at least these property values",
"comments": "Mostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the DSTU period.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
}, {
"code": "decimal"
}, {
"code": "base64Binary"
}, {
"code": "instant"
}, {
"code": "string"
}, {
"code": "uri"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "time"
}, {
"code": "code"
}, {
"code": "oid"
}, {
"code": "id"
}, {
"code": "unsignedInt"
}, {
"code": "positiveInt"
}, {
"code": "markdown"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "Identifier"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Period"
}, {
"code": "Ratio"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "HumanName"
}, {
"code": "Address"
}, {
"code": "ContactPoint"
}, {
"code": "Timing"
}, {
"code": "Reference"
}, {
"code": "Meta"
} ],
"max": "0",
"condition": [ "eld-5", "eld-7", "eld-8" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.pattern[x]"
},
"isSummary": true
}, {
"path": "ElementDefinition.example[x]",
"min": 0,
"definition": "A sample value for this element demonstrating the type of information that would typically be captured.",
"short": "Example value: [as defined for type]",
"comments": "This will most commonly be present for data where it's not implicitly obvious from either the data type or value set what the values might be. (I.e. Example values for dates or quantities would generally be unnecessary.) If the example value is fully populated, the publication tool can generate an instance automatically.",
"mapping": [ {
"map": "EXMPL_ANSWERS",
"identity": "loinc"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": ".example",
"identity": "iso11179"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
}, {
"code": "decimal"
}, {
"code": "base64Binary"
}, {
"code": "instant"
}, {
"code": "string"
}, {
"code": "uri"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "time"
}, {
"code": "code"
}, {
"code": "oid"
}, {
"code": "id"
}, {
"code": "unsignedInt"
}, {
"code": "positiveInt"
}, {
"code": "markdown"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "Identifier"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Period"
}, {
"code": "Ratio"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "HumanName"
}, {
"code": "Address"
}, {
"code": "ContactPoint"
}, {
"code": "Timing"
}, {
"code": "Reference"
}, {
"code": "Meta"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.example[x]"
},
"isSummary": true
}, {
"path": "ElementDefinition.minValue[x]",
"min": 0,
"definition": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"short": "Minimum Allowed Value (for some types)",
"comments": "Except for date/date/instant, the type of the minValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of minValue[x] SHALL be either the same, or a a [Duration](datatypes.html#duration) which specifies a relative time limit to the current time. The duration value is positive, and is subtracted from the current clock to determine the minimum allowable value. A minimum value for a Quantity is interpreted as an canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
}, {
"code": "decimal"
}, {
"code": "base64Binary"
}, {
"code": "instant"
}, {
"code": "string"
}, {
"code": "uri"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "time"
}, {
"code": "code"
}, {
"code": "oid"
}, {
"code": "id"
}, {
"code": "unsignedInt"
}, {
"code": "positiveInt"
}, {
"code": "markdown"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "Identifier"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Period"
}, {
"code": "Ratio"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "HumanName"
}, {
"code": "Address"
}, {
"code": "ContactPoint"
}, {
"code": "Timing"
}, {
"code": "Reference"
}, {
"code": "Meta"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.minValue[x]"
},
"isSummary": true
}, {
"path": "ElementDefinition.maxValue[x]",
"min": 0,
"definition": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.",
"short": "Maximum Allowed Value (for some types)",
"comments": "Except for date/date/instant, the type of the maxValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of maxValue[x] SHALL be either the same, or a a [Duration](datatypes.html#duration) which specifies a relative time limit to the current time. The duration value is positive, and is added to the current clock to determine the maximum allowable value. A maximum value for a Quantity is interpreted as an canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
}, {
"code": "decimal"
}, {
"code": "base64Binary"
}, {
"code": "instant"
}, {
"code": "string"
}, {
"code": "uri"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "time"
}, {
"code": "code"
}, {
"code": "oid"
}, {
"code": "id"
}, {
"code": "unsignedInt"
}, {
"code": "positiveInt"
}, {
"code": "markdown"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "Identifier"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Period"
}, {
"code": "Ratio"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "HumanName"
}, {
"code": "Address"
}, {
"code": "ContactPoint"
}, {
"code": "Timing"
}, {
"code": "Reference"
}, {
"code": "Meta"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.maxValue[x]"
},
"isSummary": true
}, {
"path": "ElementDefinition.maxLength",
"min": 0,
"definition": "Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.",
"short": "Max length for strings",
"comments": "Receivers are not required to reject instances that exceed the maximum length. The full length could be stored. In some cases, data might be truncated, though truncation should be undertaken with care and an understanding of the consequences of doing so. If not specified, there is no conformance expectation for length support.",
"mapping": [ {
"map": "OMC.12",
"identity": "v2"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": ".domain.maximum_character_quantity",
"identity": "iso11179"
} ],
"type": [ {
"code": "integer"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.maxLength"
},
"isSummary": true
}, {
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.condition"
},
"path": "ElementDefinition.condition",
"type": [ {
"code": "id"
} ],
"short": "Reference to invariant about presence",
"isSummary": true,
"definition": "A reference to an invariant that may make additional statements about the cardinality or value in the instance."
}, {
"path": "ElementDefinition.constraint",
"min": 0,
"definition": "Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.",
"short": "Condition that must evaluate to true",
"comments": "Constraints should be declared on the \"context\" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint.",
"mapping": [ {
"map": "??",
"identity": "iso11179"
} ],
"type": [ {
"code": "Element"
} ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.constraint"
},
"isSummary": true
}, {
"path": "ElementDefinition.constraint.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.constraint.id"
}
}, {
"path": "ElementDefinition.constraint.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.constraint.extension"
}
}, {
"path": "ElementDefinition.constraint.key",
"min": 1,
"definition": "Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.",
"short": "Target of 'condition' reference above",
"type": [ {
"code": "id"
} ],
"max": "1",
"condition": [ "eld-14" ],
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.constraint.key"
},
"isSummary": true
}, {
"path": "ElementDefinition.constraint.requirements",
"min": 0,
"definition": "Description of why this constraint is necessary or appropriate.",
"short": "Why this constraint necessary or appropriate",
"comments": "To be used if the reason for the constraint may not be intuitive to all implementers.",
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.constraint.requirements"
},
"isSummary": true
}, {
"path": "ElementDefinition.constraint.severity",
"min": 1,
"definition": "Identifies the impact constraint violation has on the conformance of the instance.",
"short": "error | warning",
"comments": "This allows constraints to be asserted as \"shall\" (error) and \"should\" (warning).",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "SHALL applications comply with this constraint?",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/constraint-severity"
}
},
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.constraint.severity"
},
"isSummary": true
}, {
"path": "ElementDefinition.constraint.human",
"min": 1,
"definition": "Text that can be used to describe the constraint in messages identifying that the constraint has been violated.",
"short": "Human description of constraint",
"comments": "Should be expressed in business terms as much as possible.",
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.constraint.human"
},
"isSummary": true
}, {
"path": "ElementDefinition.constraint.xpath",
"requirements": "Used in Schematron tests of the validity of the resource.",
"min": 1,
"definition": "An XPath expression of constraint that can be executed to see if this constraint is met.",
"short": "XPath expression of constraint",
"comments": "Elements SHALL use \"f\" as the namespace prefix for the FHIR namespace, and \"x\" for the xhtml namespace, and SHALL NOT use any other prefixes.",
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.constraint.xpath"
},
"isSummary": true
}, {
"path": "ElementDefinition.mustSupport",
"requirements": "Allows a profile to set expectations for system capabilities beyond merely respecting cardinality constraints.",
"min": 0,
"definition": "If true, implementations that produce or consume resources SHALL provide \"support\" for the element in some meaningful way. If false, the element may be ignored and not supported.",
"short": "If the element must supported",
"comments": "\"Something useful\" is context dependent and impossible to describe in the base FHIR specification. For this reason, tue mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. This is done in [Resource Profiles](profiling.html#mustsupport), where the profile labels an element as mustSupport=true. When a profile does this, it SHALL also make clear exactly what kind of \"support\" is required, as this can mean many things. Note that an element that has the property IsModifier is not necessarily a \"key\" element (e.g. one of the important elements to make use of the resource), nor is it automatically mustSupport - however both of these things are more likely to be true for IsModifier elements than for other elements.",
"mapping": [ {
"map": "??",
"identity": "iso11179"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": false,
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.mustSupport"
},
"isSummary": true
}, {
"path": "ElementDefinition.isModifier",
"requirements": "Allows elements to be introduced into a specification that can't safely be ignored by applications that don't recognize them.",
"min": 0,
"definition": "If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.",
"short": "If this modifies the meaning of other elements",
"comments": "Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set, it cannot be changed in derived profiles. An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear.",
"mapping": [ {
"map": "??",
"identity": "iso11179"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": false,
"max": "0",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.isModifier"
},
"isSummary": true
}, {
"path": "ElementDefinition.isSummary",
"requirements": "Allow clients to search through large resources quickly.",
"min": 0,
"definition": "Whether the element should be included if a client requests a search with the parameter _summary=true.",
"short": "Include when _summary = true?",
"comments": "Some resources include a set of simple metadata, and some very large data. This element is used to reduce the quantity of data returned in searches. Note that servers may pre-cache summarized resources for optimal performance, so servers may not support per-profile use of the isSummary flag.",
"mapping": [ {
"map": "??",
"identity": "iso11179"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": false,
"max": "0",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.isSummary"
},
"isSummary": true
}, {
"constraint": [ {
"key": "eld-10",
"human": "provide either a reference or a description (or both)",
"xpath": "(exists(f:valueSetUri) or exists(f:valueSetReference)) or exists(f:description)",
"severity": "error"
} ],
"path": "ElementDefinition.binding",
"min": 0,
"definition": "Binds to a value set if this element is coded (code, Coding, CodeableConcept).",
"short": "ValueSet details if this is coded",
"mapping": [ {
"map": "ANSWER LIST, NORMATIVE ANSWER LIST",
"identity": "loinc"
}, {
"map": "OM3, OMC.11",
"identity": "v2"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": ".domain",
"identity": "iso11179"
} ],
"type": [ {
"code": "Element"
} ],
"max": "1",
"condition": [ "eld-11" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.binding"
},
"isSummary": true
}, {
"path": "ElementDefinition.binding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.binding.id"
}
}, {
"path": "ElementDefinition.binding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.binding.extension"
}
}, {
"path": "ElementDefinition.binding.strength",
"min": 1,
"definition": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.",
"short": "required | extensible | preferred | example",
"comments": "For further discussion, see [[[Using Terminologies]]].",
"mapping": [ {
"map": "N/A",
"identity": "loinc"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Indication of the degree of conformance expectations associated with a binding.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/binding-strength"
}
},
"alias": [ "conformance", "extensibility" ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.binding.strength"
},
"isSummary": true
}, {
"path": "ElementDefinition.binding.description",
"min": 0,
"definition": "Describes the intended use of this particular set of codes.",
"short": "Human explanation of the value set",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": ".domain.description",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"condition": [ "eld-10" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.binding.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "eld-12",
"human": "URI SHALL start with http:// or https://",
"xpath": "starts-with(string(@value), 'http:') or starts-with(string(@value), 'https:')",
"severity": "error"
} ],
"path": "ElementDefinition.binding.valueSet[x]",
"min": 0,
"definition": "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.",
"short": "Source of value set",
"comments": "For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.",
"mapping": [ {
"map": "valueDomain.valueSet",
"identity": "dex"
}, {
"map": "CODE_TABLE",
"identity": "loinc"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "points to explicit list or expression that evaluates to list of (Enumerated_Value_Domain).member",
"identity": "iso11179"
} ],
"type": [ {
"code": "uri"
}, {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/StructureDefinition/ValueSet" ]
} ],
"max": "1",
"condition": [ "eld-10", "eld-12" ],
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.binding.valueSet[x]"
},
"isSummary": true
}, {
"path": "ElementDefinition.mapping",
"requirements": "Provides guidance to implementers familiar with or converting content from other specifications.",
"min": 0,
"definition": "Identifies a concept from an external specification that roughly corresponds to this element.",
"short": "Map element to another set of definitions",
"comments": "Mappings are not necessarily specific enough for safe translation.",
"mapping": [ {
"map": "mappingSpecification",
"identity": "dex"
}, {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "Registered_item).document_reference[document_type=mapping] Also, .meaning linkage to Data_Element_Concept is done as a mapping to a reference model. (Data_Element_Concepts are all defined in some sort of reference model, be that Object_Class and Property or some other mechanism)",
"identity": "iso11179"
} ],
"type": [ {
"code": "Element"
} ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.mapping"
},
"isSummary": true
}, {
"path": "ElementDefinition.mapping.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.mapping.id"
}
}, {
"path": "ElementDefinition.mapping.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "ElementDefinition.mapping.extension"
}
}, {
"path": "ElementDefinition.mapping.identity",
"min": 1,
"definition": "An internal reference to the definition of a mapping.",
"short": "Reference to mapping declaration",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.mapping.identity"
},
"isSummary": true
}, {
"path": "ElementDefinition.mapping.language",
"min": 0,
"definition": "Identifies the computable language in which mapping.map is expressed.",
"short": "Computable language of mapping",
"comments": "If omitted, then there can be no expectation of computational interpretation of the mapping.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"max": "1",
"base": {
"max": "1",
"min": 0,
"path": "ElementDefinition.mapping.language"
},
"isSummary": true
}, {
"path": "ElementDefinition.mapping.map",
"min": 1,
"definition": "Expresses what part of the target specification corresponds to this element.",
"short": "Details of the mapping",
"comments": "For most mappings, the syntax is undefined. Syntax will be provided for mappings to the RIM. Multiple mappings may be possible and may include constraints on other resource elements that identify when a particular mapping applies.",
"mapping": [ {
"map": "N/A (MIF territory)",
"identity": "rim"
}, {
"map": "ObjectClass, Property (this is one possible data model that can be mapped to - the uri would identify the data model mappingSpecification.mappingScript",
"identity": "iso11179"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"base": {
"max": "1",
"min": 1,
"path": "ElementDefinition.mapping.map"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "52ae72f3-0138-4f6a-8e1f-7f8dcca5f56e",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-de",
"base": "http://hl7.org/fhir/StructureDefinition/ElementDefinition",
"version": null,
"differential": {
"element": [ {
"max": "*",
"min": 0,
"name": "elementdefinition-de",
"path": "ElementDefinition",
"type": [ {
"code": "ElementDefinition"
} ]
}, {
"max": "*",
"min": 0,
"name": "Question",
"path": "ElementDefinition.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/elementdefinition-question" ]
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ "url" ]
}
}, {
"max": "1",
"min": 0,
"name": "AllowedUnits",
"path": "ElementDefinition.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" ]
} ]
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.representation"
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.slicing"
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.short"
}, {
"path": "ElementDefinition.type"
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.type.profile"
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.type.aggregation"
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.nameReference"
}, {
"path": "ElementDefinition.defaultValue[x]",
"comments": "... This element should only be used on child elements of complex data elements."
}, {
"path": "ElementDefinition.meaningWhenMissing",
"comments": "... This element should only be used on child elements of complex data elements."
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.fixed[x]"
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.pattern[x]"
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.isModifier"
}, {
"max": "0",
"min": 0,
"path": "ElementDefinition.isSummary"
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/FHIR",
"system": "other"
} ]
} ],
"constrainedType": "ElementDefinition"
}