FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
ElementDefinition
Base StructureDefinition for ElementDefinition Type
- type Profile on ElementDefinition
- FHIR STU3
- status Draft
-
versionnone
The canonical from this resource does not match any claim in this context and conflicts with a claim from another scope.
http://hl7.org/fhir
Canonical claims are used to verify ownership of your canonical URLs.
ElementDefinition | I | Element | Element idElementDefinition Definition of an element in a resource or extension DefinitionCaptures constraints on each element within the resource, profile, or extension.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
path | Σ | 1..1 | string | Element idElementDefinition.path Path of the element in the hierarchy of elements DefinitionThe path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension. Note that FHIR strings may not exceed 1MB in size
|
representation | Σ | 0..* | codeBinding | Element idElementDefinition.representation xmlAttr | xmlText | typeAttr | cdaText | xhtml DefinitionCodes that define how this element is represented in instances, when the deviation varies from the normal case. In resources, this is rarely used except for special cases where the representation deviates from the normal, and can only be done in the base standard (and profiles must reproduce what the base standard does). This element is used quite commonly in Logical models when the logical models represent a specific serialization format (e.g. CDA, v2 etc). How a property is represented when serialized. ?? (required)Constraints
|
sliceName | Σ | 0..1 | string | Element idElementDefinition.sliceName Name for this particular element (in a set of slices) DefinitionThe name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element. May also be used for code generation purposes. 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.).
|
label | Σ | 0..1 | string | Element idElementDefinition.label Name for element to display with or prompt for element DefinitionA single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form. See also the extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-question)[extension-elementdefinition-question.html].
|
code | Σ | 0..* | Coding | Element idElementDefinition.code Corresponding codes in terminologies DefinitionA code that has the same meaning as the element in a particular terminology. Links the meaning of an element to an external terminology, and is very useful for searching and indexing. The concept SHALL be properly aligned with the data element definition and other constraints, 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. The mappings may be used to provide more or less granular or structured equivalences in the code system. Codes that indicate the meaning of a data element. ?? (example)Constraints
|
slicing | Σ I | 0..1 | Element | Element idElementDefinition.slicing This element is sliced - slices follow DefinitionIndicates 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). The first element in the sequence, the one that carries the slicing, is the definition that applies to all the slices. This is based on the unconstrained element, but can apply any constraints as appropriate. This may include the common constraints on the children of the element.
|
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.slicing.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.slicing.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
discriminator | Σ | 0..* | Element | Element idElementDefinition.slicing.discriminator Element values that are used to distinguish the slices DefinitionDesignates 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. 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 must be "@type".
|
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.slicing.discriminator.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.slicing.discriminator.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
type | Σ | 1..1 | codeBinding | Element idElementDefinition.slicing.discriminator.type value | exists | pattern | type | profile DefinitionHow the element value is interpreted when discrimination is evaluated. How an element value is interpreted when discrimination is evaluated ?? (required)Constraints
|
path | Σ | 1..1 | string | Element idElementDefinition.slicing.discriminator.path Path to element value DefinitionA FHIRPath expression, using a restricted subset of FHIRPath, that is used to identify the element on which discrimination is based. The only FHIRPath functions that are allowed are resolve(), and extension(url).
|
description | Σ I | 0..1 | string | Element idElementDefinition.slicing.description Text description of how slicing works (or not) DefinitionA 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. If it's really not possible to differentiate them, the design should be re-evaluated to make the content usable.
|
ordered | Σ | 0..1 | boolean | Element idElementDefinition.slicing.ordered If elements must be in same order as slices DefinitionIf the matching elements have to occur in the same order as defined in the profile. 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.
false
|
rules | Σ | 1..1 | codeBinding | Element idElementDefinition.slicing.rules closed | open | openAtEnd DefinitionWhether 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. 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. How slices are interpreted when evaluating an instance. ?? (required)Constraints
|
short | Σ | 0..1 | string | Element idElementDefinition.short Concise definition for space-constrained presentation DefinitionA concise description of what this element means (e.g. for use in autogenerated summaries). May change the term to provide language more appropriate to the context of the profile or to reflect slicing.
|
definition | Σ | 0..1 | markdown | Element idElementDefinition.definition Full formal definition as narrative text Alternate namesDescription DefinitionProvides 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. To allow a user to state the usage of an element in a particular context. 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.
|
comment | Σ | 0..1 | markdown | Element idElementDefinition.comment Comments about the use of this element DefinitionExplanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element.
|
requirements | Σ | 0..1 | markdown | Element idElementDefinition.requirements Why this resource has been created DefinitionThis 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. 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.
|
alias | Σ | 0..* | string | Element idElementDefinition.alias Other names Alternate namessynonym, other name DefinitionIdentifies additional names by which this element might also be known. Allows for better easier recognition of the element by multiple communities, including international communities. Note that FHIR strings may not exceed 1MB in size
|
min | Σ I | 0..1 | unsignedInt | Element idElementDefinition.min Minimum Cardinality DefinitionThe minimum number of times this element SHALL appear in the instance.
|
max | Σ I | 0..1 | string | Element idElementDefinition.max Maximum Cardinality (a number or *) DefinitionThe maximum number of times this element is permitted to appear in the instance. Note that FHIR strings may not exceed 1MB in size
|
base | Σ | 0..1 | Element | Element idElementDefinition.base Base definition information for tools DefinitionInformation about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. This information is provided when the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.base.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.base.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
path | Σ | 1..1 | string | Element idElementDefinition.base.path Path that identifies the base element DefinitionThe 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. Note that FHIR strings may not exceed 1MB in size
|
min | Σ | 1..1 | unsignedInt | Element idElementDefinition.base.min Min cardinality of the base element DefinitionMinimum cardinality of the base element identified by the path. 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).
|
max | Σ | 1..1 | string | Element idElementDefinition.base.max Max cardinality of the base element DefinitionMaximum cardinality of the base element identified by the path. This is provided to code generation, since the serialization representation in JSON differs depending on whether the base element has max > 1. Also, some forms of code generation may differ.
|
contentReference | Σ I | 0..1 | uri | Element idElementDefinition.contentReference Reference to definition of content for the element DefinitionIdentifies the identity of an element defined elsewhere in the profile whose content rules should be applied to the current element. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
type | Σ I | 0..* | Element | Element idElementDefinition.type Data type and Profile for this element DefinitionThe data type or resource that the value of this element is permitted to be. The Type of the element can be left blank in a differential constraint, in which case the type is inherited from the resource. Abstract types are not permitted to appear as a type when multiple types are listed. (I.e. Abstract types cannot be part of a choice).
|
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.type.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.type.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
code | Σ | 1..1 | uriBinding | Element idElementDefinition.type.code Data type or Resource (reference to definition) DefinitionURL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models. If the element is a reference to another resource, this element contains "Reference", and the targetProfile element defines what resources can be referenced. The targetProfile 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. Either a resource or a data type, including logical model types ?? (extensible)Constraints
|
profile | Σ | 0..1 | uri | Element idElementDefinition.type.profile Profile (StructureDefinition) to apply (or IG) DefinitionIdentifies a profile structure or implementation Guide that SHALL hold for the datatype this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
targetProfile | Σ | 0..1 | uri | Element idElementDefinition.type.targetProfile Profile (StructureDefinition) to apply to reference target (or IG) DefinitionIdentifies a profile structure or implementation Guide that SHALL hold for the target of the reference this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
aggregation | Σ I | 0..* | codeBinding | Element idElementDefinition.type.aggregation contained | referenced | bundled - how aggregated DefinitionIf 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. How resource references can be aggregated. ?? (required)Constraints
|
versioning | Σ | 0..1 | codeBinding | Element idElementDefinition.type.versioning either | independent | specific DefinitionWhether this reference needs to be version specific or version independent, or whether either can be used. The base specification never makes a rule as to which form is allowed, but implementation guides may do this. Whether a reference needs to be version specific or version independent, or whether either can be used ?? (required)Constraints
either
|
defaultValue[x] | Σ I | 0..1 | Element idElementDefinition.defaultValue[x] Specified value if missing from instance DefinitionThe value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). 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.
| |
defaultValueBase64Binary | base64Binary | Data type | ||
defaultValueBoolean | boolean | Data type | ||
defaultValueCode | code | Data type | ||
defaultValueDate | date | Data type | ||
defaultValueDateTime | dateTime | Data type | ||
defaultValueDecimal | decimal | Data type | ||
defaultValueId | id | Data type | ||
defaultValueInstant | instant | Data type | ||
defaultValueInteger | integer | Data type | ||
defaultValueMarkdown | markdown | Data type | ||
defaultValueOid | oid | Data type | ||
defaultValuePositiveInt | positiveInt | Data type | ||
defaultValueString | string | Data type | ||
defaultValueTime | time | Data type | ||
defaultValueUnsignedInt | unsignedInt | Data type | ||
defaultValueUri | uri | Data type | ||
defaultValueAddress | Address | Data type | ||
defaultValueAge | Age | Data type | ||
defaultValueAnnotation | Annotation | Data type | ||
defaultValueAttachment | Attachment | Data type | ||
defaultValueCodeableConcept | CodeableConcept | Data type | ||
defaultValueCoding | Coding | Data type | ||
defaultValueContactPoint | ContactPoint | Data type | ||
defaultValueCount | Count | Data type | ||
defaultValueDistance | Distance | Data type | ||
defaultValueDuration | Duration | Data type | ||
defaultValueHumanName | HumanName | Data type | ||
defaultValueIdentifier | Identifier | Data type | ||
defaultValueMoney | Money | Data type | ||
defaultValuePeriod | Period | Data type | ||
defaultValueQuantity | Quantity | Data type | ||
defaultValueRange | Range | Data type | ||
defaultValueRatio | Ratio | Data type | ||
defaultValueSampledData | SampledData | Data type | ||
defaultValueSignature | Signature | Data type | ||
defaultValueTiming | Timing | Data type | ||
defaultValueMeta | Meta | Data type | ||
defaultValueReference | Reference() | Data type | ||
meaningWhenMissing | Σ I | 0..1 | markdown | Element idElementDefinition.meaningWhenMissing Implicit meaning when this element is missing DefinitionThe Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing'. 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.
|
orderMeaning | Σ | 0..1 | string | Element idElementDefinition.orderMeaning What the order of the elements means DefinitionIf present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning. This element can only be asserted on repeating elements and can only be introduced when defining resources or data types. It can be further refined profiled elements but if absent in the base type, a profile cannot assert meaning.
|
fixed[x] | Σ I | 0..1 | Element idElementDefinition.fixed[x] Value must be exactly this DefinitionSpecifies 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. This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.
| |
fixedBase64Binary | base64Binary | Data type | ||
fixedBoolean | boolean | Data type | ||
fixedCode | code | Data type | ||
fixedDate | date | Data type | ||
fixedDateTime | dateTime | Data type | ||
fixedDecimal | decimal | Data type | ||
fixedId | id | Data type | ||
fixedInstant | instant | Data type | ||
fixedInteger | integer | Data type | ||
fixedMarkdown | markdown | Data type | ||
fixedOid | oid | Data type | ||
fixedPositiveInt | positiveInt | Data type | ||
fixedString | string | Data type | ||
fixedTime | time | Data type | ||
fixedUnsignedInt | unsignedInt | Data type | ||
fixedUri | uri | Data type | ||
fixedAddress | Address | Data type | ||
fixedAge | Age | Data type | ||
fixedAnnotation | Annotation | Data type | ||
fixedAttachment | Attachment | Data type | ||
fixedCodeableConcept | CodeableConcept | Data type | ||
fixedCoding | Coding | Data type | ||
fixedContactPoint | ContactPoint | Data type | ||
fixedCount | Count | Data type | ||
fixedDistance | Distance | Data type | ||
fixedDuration | Duration | Data type | ||
fixedHumanName | HumanName | Data type | ||
fixedIdentifier | Identifier | Data type | ||
fixedMoney | Money | Data type | ||
fixedPeriod | Period | Data type | ||
fixedQuantity | Quantity | Data type | ||
fixedRange | Range | Data type | ||
fixedRatio | Ratio | Data type | ||
fixedSampledData | SampledData | Data type | ||
fixedSignature | Signature | Data type | ||
fixedTiming | Timing | Data type | ||
fixedMeta | Meta | Data type | ||
fixedReference | Reference() | Data type | ||
pattern[x] | Σ I | 0..1 | Element idElementDefinition.pattern[x] Value must have at least these property values DefinitionSpecifies 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.). 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 STU period.
| |
patternBase64Binary | base64Binary | Data type | ||
patternBoolean | boolean | Data type | ||
patternCode | code | Data type | ||
patternDate | date | Data type | ||
patternDateTime | dateTime | Data type | ||
patternDecimal | decimal | Data type | ||
patternId | id | Data type | ||
patternInstant | instant | Data type | ||
patternInteger | integer | Data type | ||
patternMarkdown | markdown | Data type | ||
patternOid | oid | Data type | ||
patternPositiveInt | positiveInt | Data type | ||
patternString | string | Data type | ||
patternTime | time | Data type | ||
patternUnsignedInt | unsignedInt | Data type | ||
patternUri | uri | Data type | ||
patternAddress | Address | Data type | ||
patternAge | Age | Data type | ||
patternAnnotation | Annotation | Data type | ||
patternAttachment | Attachment | Data type | ||
patternCodeableConcept | CodeableConcept | Data type | ||
patternCoding | Coding | Data type | ||
patternContactPoint | ContactPoint | Data type | ||
patternCount | Count | Data type | ||
patternDistance | Distance | Data type | ||
patternDuration | Duration | Data type | ||
patternHumanName | HumanName | Data type | ||
patternIdentifier | Identifier | Data type | ||
patternMoney | Money | Data type | ||
patternPeriod | Period | Data type | ||
patternQuantity | Quantity | Data type | ||
patternRange | Range | Data type | ||
patternRatio | Ratio | Data type | ||
patternSampledData | SampledData | Data type | ||
patternSignature | Signature | Data type | ||
patternTiming | Timing | Data type | ||
patternMeta | Meta | Data type | ||
patternReference | Reference() | Data type | ||
example | Σ | 0..* | Element | Element idElementDefinition.example Example value (as defined for type) DefinitionA sample value for this element demonstrating the type of information that would typically be found in the element. Examples 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.example.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.example.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
label | Σ | 1..1 | string | Element idElementDefinition.example.label Describes the purpose of this example DefinitionDescribes the purpose of this example amoung the set of examples. Note that FHIR strings may not exceed 1MB in size
|
value[x] | Σ | 1..1 | Element idElementDefinition.example.value[x] Value of Example (one of allowed types) DefinitionThe actual value for the element, which must be one of the types allowed for this element.
| |
valueBase64Binary | base64Binary | Data type | ||
valueBoolean | boolean | Data type | ||
valueCode | code | Data type | ||
valueDate | date | Data type | ||
valueDateTime | dateTime | Data type | ||
valueDecimal | decimal | Data type | ||
valueId | id | Data type | ||
valueInstant | instant | Data type | ||
valueInteger | integer | Data type | ||
valueMarkdown | markdown | Data type | ||
valueOid | oid | Data type | ||
valuePositiveInt | positiveInt | Data type | ||
valueString | string | Data type | ||
valueTime | time | Data type | ||
valueUnsignedInt | unsignedInt | Data type | ||
valueUri | uri | Data type | ||
valueAddress | Address | Data type | ||
valueAge | Age | Data type | ||
valueAnnotation | Annotation | Data type | ||
valueAttachment | Attachment | Data type | ||
valueCodeableConcept | CodeableConcept | Data type | ||
valueCoding | Coding | Data type | ||
valueContactPoint | ContactPoint | Data type | ||
valueCount | Count | Data type | ||
valueDistance | Distance | Data type | ||
valueDuration | Duration | Data type | ||
valueHumanName | HumanName | Data type | ||
valueIdentifier | Identifier | Data type | ||
valueMoney | Money | Data type | ||
valuePeriod | Period | Data type | ||
valueQuantity | Quantity | Data type | ||
valueRange | Range | Data type | ||
valueRatio | Ratio | Data type | ||
valueSampledData | SampledData | Data type | ||
valueSignature | Signature | Data type | ||
valueTiming | Timing | Data type | ||
valueMeta | Meta | Data type | ||
valueReference | Reference() | Data type | ||
minValue[x] | Σ | 0..1 | Element idElementDefinition.minValue[x] Minimum Allowed Value (for some types) DefinitionThe minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. 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 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.
| |
minValueDate | date | Data type | ||
minValueDateTime | dateTime | Data type | ||
minValueInstant | instant | Data type | ||
minValueTime | time | Data type | ||
minValueDecimal | decimal | Data type | ||
minValueInteger | integer | Data type | ||
minValuePositiveInt | positiveInt | Data type | ||
minValueUnsignedInt | unsignedInt | Data type | ||
minValueQuantity | Quantity | Data type | ||
maxValue[x] | Σ | 0..1 | Element idElementDefinition.maxValue[x] Maximum Allowed Value (for some types) DefinitionThe maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. 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 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.
| |
maxValueDate | date | Data type | ||
maxValueDateTime | dateTime | Data type | ||
maxValueInstant | instant | Data type | ||
maxValueTime | time | Data type | ||
maxValueDecimal | decimal | Data type | ||
maxValueInteger | integer | Data type | ||
maxValuePositiveInt | positiveInt | Data type | ||
maxValueUnsignedInt | unsignedInt | Data type | ||
maxValueQuantity | Quantity | Data type | ||
maxLength | Σ | 0..1 | integer | Element idElementDefinition.maxLength Max length for strings DefinitionIndicates 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. 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.
|
condition | Σ | 0..* | id | Element idElementDefinition.condition Reference to invariant about presence DefinitionA reference to an invariant that may make additional statements about the cardinality or value in the instance. RFC 4122
|
constraint | Σ | 0..* | Element | Element idElementDefinition.constraint Condition that must evaluate to true DefinitionFormal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance. Constraints should be declared on the "context" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint.
|
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.constraint.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.constraint.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
key | Σ I | 1..1 | id | Element idElementDefinition.constraint.key Target of 'condition' reference above DefinitionAllows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality. RFC 4122
|
requirements | Σ | 0..1 | string | Element idElementDefinition.constraint.requirements Why this constraint is necessary or appropriate DefinitionDescription of why this constraint is necessary or appropriate. To be used if the reason for the constraint may not be intuitive to all implementers.
|
severity | Σ | 1..1 | codeBinding | Element idElementDefinition.constraint.severity error | warning DefinitionIdentifies the impact constraint violation has on the conformance of the instance. This allows constraints to be asserted as "shall" (error) and "should" (warning). SHALL applications comply with this constraint? ?? (required)Constraints
|
human | Σ | 1..1 | string | Element idElementDefinition.constraint.human Human description of constraint DefinitionText that can be used to describe the constraint in messages identifying that the constraint has been violated. Should be expressed in business terms as much as possible.
|
expression | Σ | 1..1 | string | Element idElementDefinition.constraint.expression FHIRPath expression of constraint DefinitionA FHIRPath expression of constraint that can be executed to see if this constraint is met. Used by validation tooling tests of the validity of the resource. Note that FHIR strings may not exceed 1MB in size
|
xpath | Σ | 0..1 | string | Element idElementDefinition.constraint.xpath XPath expression of constraint DefinitionAn XPath expression of constraint that can be executed to see if this constraint is met. Used in Schematron tests of the validity of the resource. 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. Note: we are considering deprecating the xpath element. Implementer feedback is welcome.
|
source | Σ | 0..1 | uri | Element idElementDefinition.constraint.source Reference to original source of constraint DefinitionA reference to the original source of the constraint, for traceability purposes. This is used when, e.g. rendering, where it is not useful to present inherited constraints when rendering the snapshot.
|
mustSupport | Σ | 0..1 | boolean | Element idElementDefinition.mustSupport If the element must supported DefinitionIf 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. Allows a profile to set expectations for system capabilities beyond merely respecting cardinality constraints. "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, 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.
false
|
isModifier | Σ | 0..1 | boolean | Element idElementDefinition.isModifier If this modifies the meaning of other elements DefinitionIf 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. Allows elements to be introduced into a specification that can't safely be ignored by applications that don't recognize them. 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.
false
|
isSummary | Σ | 0..1 | boolean | Element idElementDefinition.isSummary Include when _summary = true? DefinitionWhether the element should be included if a client requests a search with the parameter _summary=true. Allow clients to search through large resources quickly. 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. When a request is made with _summary=true, serailisers only include elements marked as 'isSummary = true'. Other than Attachment.data, all data type properties are included in the summary form. Modifier elements or elements with minimum cardinality = 1 must be marked as summary elements.
false
|
binding | Σ I | 0..1 | Element | Element idElementDefinition.binding ValueSet details if this is coded DefinitionBinds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri). For a CodeableConcept, when no codes are allowed - only text, use a binding of strength "required" with a description explaining that no coded values are allowed and what sort of information to put in the "text" element.
|
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.binding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.binding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
strength | Σ | 1..1 | codeBinding | Element idElementDefinition.binding.strength required | extensible | preferred | example Alternate namesconformance, extensibility DefinitionIndicates 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. For further discussion, see Using Terminologies. Indication of the degree of conformance expectations associated with a binding. ?? (required)Constraints
|
description | Σ I | 0..1 | string | Element idElementDefinition.binding.description Human explanation of the value set DefinitionDescribes the intended use of this particular set of codes. Note that FHIR strings may not exceed 1MB in size
|
valueSet[x] | Σ I | 0..1 | Element idElementDefinition.binding.valueSet[x] Source of value set DefinitionPoints to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri. For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.
| |
valueSetUri | uri | Data type | ||
valueSetReference | Reference(ValueSet) | Data type | ||
mapping | Σ | 0..* | Element | Element idElementDefinition.mapping Map element to another set of definitions DefinitionIdentifies a concept from an external specification that roughly corresponds to this element. Provides guidance to implementers familiar with or converting content from other specifications. Mappings are not necessarily specific enough for safe translation.
|
id | 0..1 | string | There are no (further) constraints on this element Element idElementDefinition.mapping.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idElementDefinition.mapping.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
identity | Σ | 1..1 | id | Element idElementDefinition.mapping.identity Reference to mapping declaration DefinitionAn internal reference to the definition of a mapping. RFC 4122
|
language | Σ | 0..1 | codeBinding | Element idElementDefinition.mapping.language Computable language of mapping DefinitionIdentifies the computable language in which mapping.map is expressed. If omitted, then there can be no expectation of computational interpretation of the mapping. The mime type of an attachment. Any valid mime type is allowed. ?? (required)Constraints
|
map | Σ | 1..1 | string | Element idElementDefinition.mapping.map Details of the mapping DefinitionExpresses what part of the target specification corresponds to this element. 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.
|
comment | Σ | 0..1 | string | Element idElementDefinition.mapping.comment Comments about the mapping or its use DefinitionComments that provide information about the mapping or its use. Note that FHIR strings may not exceed 1MB in size
|