Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the ext-R3-TestScript.ruleset extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | STU3: Optional Extension Element - found in all resources. |
| Short | STU3: Assert ruleset used within the test script (new)Optional Extensions Element |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 2. Extension.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional 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. |
| Control | 20..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:resource | |
| Slice Name | resource |
| Definition | STU3: |
| Short | STU3: Assert ruleset resource reference (new)Additional content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 6. Extension.extension:resource.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | resource |
| 8. Extension.extension:resource.value[x] | |
| Definition | Reference to the resource (containing the contents of the ruleset needed for assertions). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Assert ruleset resource referenceValue of extension |
| Control | 10..1 This element is affected by the following invariants: ext-1 |
| Type | Reference(Cross-version Profile for STU3.Resource for use in FHIR R5, Resource), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Extension.extension:rule | |
| Slice Name | rule |
| Definition | STU3: |
| Short | STU3: The referenced rule within the ruleset (new)Additional content defined by implementations |
| Comments | Element |
| Control | 10..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 12. Extension.extension:rule.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional 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. |
| Control | 10..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. Extension.extension:rule.extension:ruleId | |
| Slice Name | ruleId |
| Definition | STU3: |
| Short | STU3: Id of referenced rule within the ruleset (new)Additional content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 16. Extension.extension:rule.extension:ruleId.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | ruleId |
| 18. Extension.extension:rule.extension:ruleId.value[x] | |
| Definition | Id of the referenced rule within the external ruleset template. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Id of referenced rule within the rulesetValue of extension |
| Control | 10..1 This element is affected by the following invariants: ext-1 |
| Type | id, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Extension.extension:rule.extension:param | |
| Slice Name | param |
| Definition | STU3: |
| Short | STU3: Ruleset rule parameter template (new)Additional content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 22. Extension.extension:rule.extension:param.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional 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. |
| Control | 10..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. Extension.extension:rule.extension:param.extension:name | |
| Slice Name | name |
| Definition | STU3: |
| Short | STU3: Parameter name matching external assert ruleset rule parameter (new)Additional content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 26. Extension.extension:rule.extension:param.extension:name.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | name |
| 28. Extension.extension:rule.extension:param.extension:name.value[x] | |
| Definition | Descriptive name for this parameter that matches the external assert ruleset rule parameter name. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Parameter name matching external assert ruleset rule parameterValue of extension |
| Comments | The external rule template would be looking for the parameter by this name. |
| Control | 10..1 This element is affected by the following invariants: ext-1 |
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. Extension.extension:rule.extension:param.extension:value | |
| Slice Name | value |
| Definition | STU3: |
| Short | STU3: Parameter value defined either explicitly or dynamically (new)Additional content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 32. Extension.extension:rule.extension:param.extension:value.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | value |
| 34. Extension.extension:rule.extension:param.extension:value.value[x] | |
| Definition | The value for the parameter that will be passed on to the external ruleset rule template. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Parameter value defined either explicitly or dynamicallyValue of extension |
| Comments | This value can be overwritten by the assert.ruleset.rule.param.value i.e. TestScript.ruleset.rule.param.value will be used if assert.ruleset.rule.param.value is not specified. The param value can be a string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before supplying this value to the external rule template. |
| Control | 0..1 This element is affected by the following invariants: ext-1 |
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. Extension.extension:rule.extension:param.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | param |
| 38. Extension.extension:rule.extension:param.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..01 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. Extension.extension:rule.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | rule |
| 42. Extension.extension:rule.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..01 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://hl7.org/fhir/3.0/StructureDefinition/extension-TestScript.ruleset |
| 46. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..01 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | STU3: |
| Short | STU3: Assert ruleset used within the test script (new) |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| 2. Extension.extension | |
| Control | 2..* |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:resource | |
| Slice Name | resource |
| Definition | STU3: |
| Short | STU3: Assert ruleset resource reference (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 6. Extension.extension:resource.url | |
| Control | 1..1 |
| Fixed Value | resource |
| 8. Extension.extension:resource.value[x] | |
| Definition | Reference to the resource (containing the contents of the ruleset needed for assertions). |
| Short | Assert ruleset resource reference |
| Control | 1..1 |
| Type | Reference(Cross-version Profile for STU3.Resource for use in FHIR R5, Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 10. Extension.extension:rule | |
| Slice Name | rule |
| Definition | STU3: |
| Short | STU3: The referenced rule within the ruleset (new) |
| Comments | Element |
| Control | 1..* |
| Requirements | Element |
| 12. Extension.extension:rule.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. Extension.extension:rule.extension:ruleId | |
| Slice Name | ruleId |
| Definition | STU3: |
| Short | STU3: Id of referenced rule within the ruleset (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 16. Extension.extension:rule.extension:ruleId.url | |
| Control | 1..1 |
| Fixed Value | ruleId |
| 18. Extension.extension:rule.extension:ruleId.value[x] | |
| Definition | Id of the referenced rule within the external ruleset template. |
| Short | Id of referenced rule within the ruleset |
| Control | 1..1 |
| Type | id |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. Extension.extension:rule.extension:param | |
| Slice Name | param |
| Definition | STU3: |
| Short | STU3: Ruleset rule parameter template (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 22. Extension.extension:rule.extension:param.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. Extension.extension:rule.extension:param.extension:name | |
| Slice Name | name |
| Definition | STU3: |
| Short | STU3: Parameter name matching external assert ruleset rule parameter (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 26. Extension.extension:rule.extension:param.extension:name.url | |
| Control | 1..1 |
| Fixed Value | name |
| 28. Extension.extension:rule.extension:param.extension:name.value[x] | |
| Definition | Descriptive name for this parameter that matches the external assert ruleset rule parameter name. |
| Short | Parameter name matching external assert ruleset rule parameter |
| Comments | The external rule template would be looking for the parameter by this name. |
| Control | 1..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. Extension.extension:rule.extension:param.extension:value | |
| Slice Name | value |
| Definition | STU3: |
| Short | STU3: Parameter value defined either explicitly or dynamically (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 32. Extension.extension:rule.extension:param.extension:value.url | |
| Control | 1..1 |
| Fixed Value | value |
| 34. Extension.extension:rule.extension:param.extension:value.value[x] | |
| Definition | The value for the parameter that will be passed on to the external ruleset rule template. |
| Short | Parameter value defined either explicitly or dynamically |
| Comments | This value can be overwritten by the assert.ruleset.rule.param.value i.e. TestScript.ruleset.rule.param.value will be used if assert.ruleset.rule.param.value is not specified. The param value can be a string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before supplying this value to the external rule template. |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. Extension.extension:rule.extension:param.url | |
| Control | 1..1 |
| Fixed Value | param |
| 38. Extension.extension:rule.extension:param.value[x] | |
| Control | 0..0 |
| 40. Extension.extension:rule.url | |
| Control | 1..1 |
| Fixed Value | rule |
| 42. Extension.extension:rule.value[x] | |
| Control | 0..0 |
| 44. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/3.0/StructureDefinition/extension-TestScript.ruleset |
| 46. Extension.value[x] | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | STU3: |
| Short | STU3: Assert ruleset used within the test script (new) |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 2. Extension.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 2..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.extension:resource | |
| Slice Name | resource |
| Definition | STU3: |
| Short | STU3: Assert ruleset resource reference (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. Extension.extension:resource.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 10. Extension.extension:resource.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Extension.extension:resource.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | resource |
| 14. Extension.extension:resource.value[x] | |
| Definition | Reference to the resource (containing the contents of the ruleset needed for assertions). |
| Short | Assert ruleset resource reference |
| Control | 1..1 This element is affected by the following invariants: ext-1 |
| Type | Reference(Cross-version Profile for STU3.Resource for use in FHIR R5, Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Extension.extension:rule | |
| Slice Name | rule |
| Definition | STU3: |
| Short | STU3: The referenced rule within the ruleset (new) |
| Comments | Element |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. Extension.extension:rule.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 20. Extension.extension:rule.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.extension:rule.extension:ruleId | |
| Slice Name | ruleId |
| Definition | STU3: |
| Short | STU3: Id of referenced rule within the ruleset (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 24. Extension.extension:rule.extension:ruleId.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 26. Extension.extension:rule.extension:ruleId.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. Extension.extension:rule.extension:ruleId.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | ruleId |
| 30. Extension.extension:rule.extension:ruleId.value[x] | |
| Definition | Id of the referenced rule within the external ruleset template. |
| Short | Id of referenced rule within the ruleset |
| Control | 1..1 This element is affected by the following invariants: ext-1 |
| Type | id |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. Extension.extension:rule.extension:param | |
| Slice Name | param |
| Definition | STU3: |
| Short | STU3: Ruleset rule parameter template (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 34. Extension.extension:rule.extension:param.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 36. Extension.extension:rule.extension:param.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 38. Extension.extension:rule.extension:param.extension:name | |
| Slice Name | name |
| Definition | STU3: |
| Short | STU3: Parameter name matching external assert ruleset rule parameter (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 40. Extension.extension:rule.extension:param.extension:name.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 42. Extension.extension:rule.extension:param.extension:name.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. Extension.extension:rule.extension:param.extension:name.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | name |
| 46. Extension.extension:rule.extension:param.extension:name.value[x] | |
| Definition | Descriptive name for this parameter that matches the external assert ruleset rule parameter name. |
| Short | Parameter name matching external assert ruleset rule parameter |
| Comments | The external rule template would be looking for the parameter by this name. |
| Control | 1..1 This element is affected by the following invariants: ext-1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. Extension.extension:rule.extension:param.extension:value | |
| Slice Name | value |
| Definition | STU3: |
| Short | STU3: Parameter value defined either explicitly or dynamically (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Requirements | Element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 50. Extension.extension:rule.extension:param.extension:value.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 52. Extension.extension:rule.extension:param.extension:value.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. Extension.extension:rule.extension:param.extension:value.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | value |
| 56. Extension.extension:rule.extension:param.extension:value.value[x] | |
| Definition | The value for the parameter that will be passed on to the external ruleset rule template. |
| Short | Parameter value defined either explicitly or dynamically |
| Comments | This value can be overwritten by the assert.ruleset.rule.param.value i.e. TestScript.ruleset.rule.param.value will be used if assert.ruleset.rule.param.value is not specified. The param value can be a string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before supplying this value to the external rule template. |
| Control | 0..1 This element is affected by the following invariants: ext-1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Extension.extension:rule.extension:param.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | param |
| 60. Extension.extension:rule.extension:param.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..0 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. Extension.extension:rule.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | rule |
| 64. Extension.extension:rule.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..0 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://hl7.org/fhir/3.0/StructureDefinition/extension-TestScript.ruleset |
| 68. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..0 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r3.r5#0.1.0 based on FHIR 5.0.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change