HL7.FHIR.US.NDH\NDH usage restriction fhir path - Definitions

National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Extension: RestrictFhirPath - Detailed Descriptions

Active as of 2023-07-30

Definitions for the base-ext-restrictFhirPath extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition	NDH usage restriction to resource element level Optional Extension Element - found in all resources.
2. Extension.extension
Control	0..0*
3. Extension.url
Fixed Value	http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-restrictFhirPath
4. Extension.value[x]
Control	10..1
Type	Choice of: , date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
5. Extension.value[x].language
Control	0..?
Pattern Value	text/fhirpath

Guidance on how to interpret the contents of this table can be found here.

1. Extension

Definition

NDH usage restriction to resource element level

Optional Extension Element - found in all resources.

Control

0..* This element is affected by the following invariants: ele-1

Invariants

Defined on this element
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

0..0*

false

Alternate Names

extensions, user content

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.

Invariants

Defined on this element
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 are unordered and Open, and can be differentiated using the following discriminators:

value @ url

3. Extension.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Control

1..1

Type

uri

XML Representation

In the XML format, this property is represented as an attribute.

Summary

false

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.

Fixed Value

http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-restrictFhirPath

4. Extension.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control

10..1

Type

Choice of: Expression, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Signature, unsignedInt, time

[x] Note

See Choice of Data Types for further information about how to use [x]

Summary

false

Invariants

Defined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

5. Extension.value[x].language

Definition

The media type of the language for the expression.

Control

1..1

Binding

The codes SHALL be taken from ExpressionLanguage; other codes may be used where these codes are not suitable

The media type of the expression language.

Additional Bindings

Purpose

http://www.rfc-editor.org/bcp/bcp13.txt

This primitive element may be present, or absent, or replaced by an extension

Summary

true

Pattern Value

text/fhirpath

Invariants

Defined on this element
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 found here.

1. Extension

Definition

NDH usage restriction to resource element level

Control

0..* This element is affected by the following invariants: ele-1

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.

Control

0..1

Type

string

XML Representation

In the XML format, this property is represented as an attribute.

Summary

false

3. Extension.extension

Definition

An Extension

0..0

false

Invariants

Defined on this element
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 are unordered and Open, and can be differentiated using the following discriminators:

value @ url

4. Extension.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Control

1..1

Type

uri

XML Representation

In the XML format, this property is represented as an attribute.

Summary

false

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.

Fixed Value

http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-restrictFhirPath

5. Extension.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control

1..1

Type

Expression

[x] Note

See Choice of Data Types for further information about how to use [x]

Summary

false

Invariants

Defined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

6. Extension.value[x].id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control

0..1

Type

string

XML Representation

In the XML format, this property is represented as an attribute.

Summary

false

7. Extension.value[x].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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

0..*

false

Alternate Names

extensions, user content

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.

Invariants

Defined on this element
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.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:

value @ url

8. Extension.value[x].description

Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

0..1

This primitive element may be present, or absent, or replaced by an extension

Summary

true

Invariants

Defined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

9. Extension.value[x].name

Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

0..1

This primitive element may be present, or absent, or replaced by an extension

Summary

true

Invariants

Defined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

10. Extension.value[x].language

Definition

The media type of the language for the expression.

Control

1..1

Binding

The codes SHALL be taken from ExpressionLanguage; other codes may be used where these codes are not suitable The media type of the expression language

Additional Bindings

Purpose

http://www.rfc-editor.org/bcp/bcp13.txt

This primitive element may be present, or absent, or replaced by an extension

Summary

true

Pattern Value

text/fhirpath