FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Clinical Decision Support icon Work Group  Maturity Level: 3 Trial Use Use Context: Country: World

Definitions for the fhirpath-patch Profile.

Parameters
Element Id Parameters
Definition

This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources.

Short Display Operation Request or Response
Cardinality 0..*
Comments

The parameters that may be used are defined by the OperationDefinition resource.

Parameters.id
Element Id Parameters.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short Display Logical id of this artifact
Cardinality 0..1
Type id
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Parameters.meta
Element Id Parameters.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Display Metadata about the resource
Cardinality 0..1
Type Meta
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.implicitRules
Element Id Parameters.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short Display A set of rules under which this content was created
Cardinality 0..1
Type uri
Is Modifier true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation)
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.language
Element Id Parameters.language
Definition

The base language in which the resource is written.

Short Display Language of the resource content
Cardinality 0..1
Terminology Binding IETF language tag for a human language
The codes SHALL be taken from All Languages
Type code
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter
Element Id Parameters.parameter
Definition

A parameter passed to or received from the operation.

Short Display One root level parameter for each patch operation
Cardinality 0..*
Type BackboneElement
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or children or bothhasValue() or (children().count() > id.count())
inv-1RuleA parameter must have one and only one of (value, resource, part)(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter.id
Element Id Parameters.parameter.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 Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
Parameters.parameter.extension
Element Id Parameters.parameter.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 Display Additional content defined by implementations
Cardinality 0..*
Type Extension
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.modifierExtension
Element Id Parameters.parameter.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content, modifiers
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.name
Element Id Parameters.parameter.name
Definition

The name of the parameter (reference to the operation definition).

Short Display Name from the definition
Cardinality 1..1
Type string
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.value[x]
Element Id Parameters.parameter.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 0..1 This element is affected by the following invariants: inv-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
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.resource
Element Id Parameters.parameter.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1 This element is affected by the following invariants: inv-1
Type Resource
Comments

This may be a resource defined in the FHIR specification, or an additional resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part
Element Id Parameters.parameter.part
Definition

A named part of a multi-part parameter.

Short Display Each parameter to the operation is a part. See documentation for rules about which parts are required
Cardinality 1..7 This element is affected by the following invariants: inv-1
Type See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Closed
  • discriminators: value:name
Parameters.parameter.part(type)
Element Id Parameters.parameter.part:type
Definition

A named part of a multi-part parameter.

Short Display Operation to perform: add | insert | delete | replace | move
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type BackboneElement
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.id
Element Id Parameters.parameter.part:type.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 Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
Parameters.parameter.part.extension
Element Id Parameters.parameter.part:type.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 Display Additional content defined by implementations
Cardinality 0..*
Type Extension
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.modifierExtension
Element Id Parameters.parameter.part:type.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content, modifiers
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.name
Element Id Parameters.parameter.part:type.name
Definition

The name of the parameter (reference to the operation definition).

Short Display Name from the definition
Cardinality 1..1
Type string
Fixed Value type
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.value[x]
Element Id Parameters.parameter.part:type.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type code
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Closed
  • discriminators: type:$this
Parameters.parameter.part.value[x](valueCode)
Element Id Parameters.parameter.part:type.value[x]:valueCode
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Terminology Binding null
The codes SHALL be taken from Patch Operation
Type code
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.resource
Element Id Parameters.parameter.part:type.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1 This element is affected by the following invariants: inv-1
Type Resource
Comments

This may be a resource defined in the FHIR specification, or an additional resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part.part
Element Id Parameters.parameter.part:type.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Cardinality 0..* This element is affected by the following invariants: inv-1
Type See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part(path)
Element Id Parameters.parameter.part:path
Definition

A named part of a multi-part parameter.

Short Display Path - where to perform the operation
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type BackboneElement
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.id
Element Id Parameters.parameter.part:path.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 Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
Parameters.parameter.part.extension
Element Id Parameters.parameter.part:path.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 Display Additional content defined by implementations
Cardinality 0..*
Type Extension
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.modifierExtension
Element Id Parameters.parameter.part:path.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content, modifiers
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.name
Element Id Parameters.parameter.part:path.name
Definition

The name of the parameter (reference to the operation definition).

Short Display Name from the definition
Cardinality 1..1
Type string
Fixed Value path
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.value[x]
Element Id Parameters.parameter.part:path.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type string
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Closed
  • discriminators: type:$this
Parameters.parameter.part.value[x](valueString)
Element Id Parameters.parameter.part:path.value[x]:valueString
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type string
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.resource
Element Id Parameters.parameter.part:path.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1 This element is affected by the following invariants: inv-1
Type Resource
Comments

This may be a resource defined in the FHIR specification, or an additional resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part.part
Element Id Parameters.parameter.part:path.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Cardinality 0..* This element is affected by the following invariants: inv-1
Type See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part(name)
Element Id Parameters.parameter.part:name
Definition

A named part of a multi-part parameter.

Short Display name of the property to add (add operation only)
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type BackboneElement
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.id
Element Id Parameters.parameter.part: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 Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
Parameters.parameter.part.extension
Element Id Parameters.parameter.part: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 Display Additional content defined by implementations
Cardinality 0..*
Type Extension
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.modifierExtension
Element Id Parameters.parameter.part:name.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content, modifiers
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.name
Element Id Parameters.parameter.part:name.name
Definition

The name of the parameter (reference to the operation definition).

Short Display Name from the definition
Cardinality 1..1
Type string
Fixed Value name
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.value[x]
Element Id Parameters.parameter.part:name.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type string
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Closed
  • discriminators: type:$this
Parameters.parameter.part.value[x](valueString)
Element Id Parameters.parameter.part:name.value[x]:valueString
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type string
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.resource
Element Id Parameters.parameter.part:name.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1 This element is affected by the following invariants: inv-1
Type Resource
Comments

This may be a resource defined in the FHIR specification, or an additional resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part.part
Element Id Parameters.parameter.part:name.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Cardinality 0..* This element is affected by the following invariants: inv-1
Type See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part(value)
Element Id Parameters.parameter.part:value
Definition

A named part of a multi-part parameter.

Short Display Value to add (or replace) - any valid datatype
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type BackboneElement
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.id
Element Id Parameters.parameter.part: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 Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
Parameters.parameter.part.extension
Element Id Parameters.parameter.part: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 Display Additional content defined by implementations
Cardinality 0..*
Type Extension
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.modifierExtension
Element Id Parameters.parameter.part:value.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content, modifiers
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.name
Element Id Parameters.parameter.part:value.name
Definition

The name of the parameter (reference to the operation definition).

Short Display Name from the definition
Cardinality 1..1
Type string
Fixed Value value
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.value[x]
Element Id Parameters.parameter.part:value.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-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
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.resource
Element Id Parameters.parameter.part:value.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1 This element is affected by the following invariants: inv-1
Type Resource
Comments

This may be a resource defined in the FHIR specification, or an additional resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part.part
Element Id Parameters.parameter.part:value.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Cardinality 0..* This element is affected by the following invariants: inv-1
Type See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part(index)
Element Id Parameters.parameter.part:index
Definition

A named part of a multi-part parameter.

Short Display Index at which insert (insert operation only)
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type BackboneElement
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.id
Element Id Parameters.parameter.part:index.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 Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
Parameters.parameter.part.extension
Element Id Parameters.parameter.part:index.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 Display Additional content defined by implementations
Cardinality 0..*
Type Extension
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.modifierExtension
Element Id Parameters.parameter.part:index.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content, modifiers
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.name
Element Id Parameters.parameter.part:index.name
Definition

The name of the parameter (reference to the operation definition).

Short Display Name from the definition
Cardinality 1..1
Type string
Fixed Value index
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.value[x]
Element Id Parameters.parameter.part:index.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type integer
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Closed
  • discriminators: type:$this
Parameters.parameter.part.value[x](valueInteger)
Element Id Parameters.parameter.part:index.value[x]:valueInteger
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type integer
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.resource
Element Id Parameters.parameter.part:index.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1 This element is affected by the following invariants: inv-1
Type Resource
Comments

This may be a resource defined in the FHIR specification, or an additional resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part.part
Element Id Parameters.parameter.part:index.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Cardinality 0..* This element is affected by the following invariants: inv-1
Type See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part(source)
Element Id Parameters.parameter.part:source
Definition

A named part of a multi-part parameter.

Short Display List index to move from (move operation only)
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type BackboneElement
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.id
Element Id Parameters.parameter.part:source.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 Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
Parameters.parameter.part.extension
Element Id Parameters.parameter.part:source.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 Display Additional content defined by implementations
Cardinality 0..*
Type Extension
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.modifierExtension
Element Id Parameters.parameter.part:source.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content, modifiers
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.name
Element Id Parameters.parameter.part:source.name
Definition

The name of the parameter (reference to the operation definition).

Short Display Name from the definition
Cardinality 1..1
Type string
Fixed Value source
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.value[x]
Element Id Parameters.parameter.part:source.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type integer
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Closed
  • discriminators: type:$this
Parameters.parameter.part.value[x](valueInteger)
Element Id Parameters.parameter.part:source.value[x]:valueInteger
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type integer
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.resource
Element Id Parameters.parameter.part:source.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1 This element is affected by the following invariants: inv-1
Type Resource
Comments

This may be a resource defined in the FHIR specification, or an additional resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part.part
Element Id Parameters.parameter.part:source.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Cardinality 0..* This element is affected by the following invariants: inv-1
Type See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part(destination)
Element Id Parameters.parameter.part:destination
Definition

A named part of a multi-part parameter.

Short Display List index to move to (move operation only)
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type BackboneElement
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.id
Element Id Parameters.parameter.part:destination.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 Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
Parameters.parameter.part.extension
Element Id Parameters.parameter.part:destination.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 Display Additional content defined by implementations
Cardinality 0..*
Type Extension
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.modifierExtension
Element Id Parameters.parameter.part:destination.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content, modifiers
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.

Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.name
Element Id Parameters.parameter.part:destination.name
Definition

The name of the parameter (reference to the operation definition).

Short Display Name from the definition
Cardinality 1..1
Type string
Fixed Value destination
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.value[x]
Element Id Parameters.parameter.part:destination.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type integer
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Closed
  • discriminators: type:$this
Parameters.parameter.part.value[x](valueInteger)
Element Id Parameters.parameter.part:destination.value[x]:valueInteger
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 1..1 This element is affected by the following invariants: inv-1
Type integer
[x] Note See Choice of Datatypes for further information about how to use [x]
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Parameters.parameter.part.resource
Element Id Parameters.parameter.part:destination.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1 This element is affected by the following invariants: inv-1
Type Resource
Comments

This may be a resource defined in the FHIR specification, or an additional resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part.part
Element Id Parameters.parameter.part:destination.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Cardinality 0..* This element is affected by the following invariants: inv-1
Type See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Constraints
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())