This
page
is
part
of
the
FHIR
Specification
v6.0.0-ballot3:
Release
6
Ballot
(3rd
Draft)
(see
Ballot
Notes
).
The
current
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
Work
Group
|
|
Use Context : Country: World |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/fhirpath-patch
Describes the valid use of a Parameters resource for a FHIRPath
This
profile
was
published
on
Sat,
Feb
21,
2015
00:00+1100
00:00+0000
as
a
draft
by
Health
Level
Seven,
Inc.
-
FHIR
WG.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from Parameters .
Summary
Mandatory:
0
element
(+22
nested
mandatory
elements)
Fixed
Value:
7
elements
Slices
This structure defines the following Slices :
This indicates the differences between this profile and the base Parameters structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
Parameters | |||
|
0..* | BackboneElement |
One
root
level
parameter
for
each
patch
operation
|
|
|
1 .. 7 |
Each
parameter
to
the
operation
is
a
part.
See
documentation
for
rules
about
which
parts
are
required
Slice: Unordered, Closed by value:name |
||
|
1..1 | BackboneElement | Operation to perform: add | insert | delete | replace | move | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: type |
|
|
1..1 | code |
If
parameter
is
a
data
type
Binding: Patch Operation ( required ) |
|
|
1..1 | BackboneElement | Path - where to perform the operation | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: path |
|
|
1..1 | string | If parameter is a data type | |
|
1..1 | BackboneElement | name of the property to add (add operation only) | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: name |
|
|
1..1 | string | If parameter is a data type | |
|
1..1 | BackboneElement | Value to add (or replace) - any valid datatype | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: value |
|
|
1..1 | 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 , VirtualServiceDetail , Dosage , Meta | If parameter is a data type | |
|
1..1 | BackboneElement | Index at which insert (insert operation only) | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: index |
|
|
1..1 | integer | If parameter is a data type | |
|
1..1 | BackboneElement | List index to move from (move operation only) | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: source |
|
|
1..1 | integer | If parameter is a data type | |
|
1..1 | BackboneElement | List index to move to (move operation only) | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: destination |
|
|
1..1 | integer | If parameter is a data type | |
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Parameters structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
0..* | Parameters |
Operation
Request
or
Response
|
|||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required
|
|||||
|
Σ
C
|
0..* | BackboneElement |
One
root
level
parameter
for
each
patch
operation
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string | Name from the definition | ||||
|
Σ
C
|
0..1 | If parameter is a data type | |||||
|
base64Binary | |||||||
|
boolean | |||||||
|
canonical (Any) | |||||||
|
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 (Any) | |||||||
|
SampledData | |||||||
|
Signature | |||||||
|
Timing | |||||||
|
ContactDetail | |||||||
|
DataRequirement | |||||||
|
Expression | |||||||
|
ParameterDefinition | |||||||
|
RelatedArtifact | |||||||
|
TriggerDefinition | |||||||
|
UsageContext | |||||||
|
Availability | |||||||
|
ExtendedContactDetail | |||||||
| VirtualServiceDetail | |||||||
![]() ![]() ![]() ![]() |
Dosage | |||||||
|
Meta | |||||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
1 .. 7 | See parameter (Parameters) |
Each
parameter
to
the
operation
is
a
part.
See
documentation
for
rules
about
which
parts
are
required
Slice: Unordered, Closed by value:name |
||||
| Content/Rules for all slices | |||||||
| 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name from the definition | ||||
![]() ![]() ![]() ![]() ![]() |
Σ
C
![]() | 0..1 | If parameter is a data type | |||||
![]() ![]() ![]() ![]() ![]() ![]() | base64Binary | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | canonical (Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | 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 (Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | SampledData | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Signature | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Timing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | ContactDetail | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | DataRequirement | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Expression | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | ParameterDefinition | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | RelatedArtifact | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | TriggerDefinition | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | UsageContext | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Availability | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | ExtendedContactDetail | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | VirtualServiceDetail | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Dosage | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Meta | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ
C
![]() | 0..1 | Resource | If parameter is a whole resource | ||||
![]() ![]() ![]() ![]() ![]() |
Σ
C
![]() | 0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
| ||||
|
Σ
C
|
1..1 | BackboneElement |
Operation
to
perform:
add
|
insert
|
delete
|
replace
|
move
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: type |
||||
|
Σ
C
|
1 .. 1 | code |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | code |
If
parameter
is
a
data
type
Binding: Patch Operation ( required ) |
||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
Path
-
where
to
perform
the
operation
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: path |
||||
|
Σ
C
|
1 .. 1 | string |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | string | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
name
of
the
property
to
add
(add
operation
only)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: name |
||||
|
Σ
C
|
1 .. 1 | string |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | string | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
Value
to
add
(or
replace)
-
any
valid
datatype
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: value |
||||
|
Σ
C
|
1..1 | If parameter is a data type | |||||
|
base64Binary | |||||||
|
boolean | |||||||
|
canonical (Any) | |||||||
|
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 (Any) | |||||||
|
SampledData | |||||||
|
Signature | |||||||
|
Timing | |||||||
|
ContactDetail | |||||||
|
DataRequirement | |||||||
|
Expression | |||||||
|
ParameterDefinition | |||||||
|
RelatedArtifact | |||||||
|
TriggerDefinition | |||||||
|
UsageContext | |||||||
|
Availability | |||||||
|
ExtendedContactDetail | |||||||
| VirtualServiceDetail | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Dosage | |||||||
|
Meta | |||||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
Index
at
which
insert
(insert
operation
only)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: index |
||||
|
Σ
C
|
1 .. 1 | integer |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | integer | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
List
index
to
move
from
(move
operation
only)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: source |
||||
|
Σ
C
|
1 .. 1 | integer |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | integer | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
List
index
to
move
to
(move
operation
only)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: destination |
||||
|
Σ
C
|
1 .. 1 | integer |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | integer | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
||||||||
<!-- FHIRPathPatchProfile --><Parameters xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
<<implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <parameter> I 0..* BackboneElement <!-- I 0..* One root level parameter for each patch operation --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <value[x]><!-- I 0..1 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|If parameter is a data type</value[x]>UsageContext|Availability|ExtendedContactDetail|VirtualServiceDetail|Dosage| Meta If parameter is a data type --></value[x]> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <-- part sliced by value:name in the specified orderClosed--> <part> I 1..1 BackboneElement <!-- I 1..1 Operation to perform: add | insert | delete | replace | move --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueCode sliced by type:$this in the specified orderClosed--> <valueCode value="[code]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 Path - where to perform the operation --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueString sliced by type:$this in the specified orderClosed--> <valueString value="[string]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 name of the property to add (add operation only) --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueString sliced by type:$this in the specified orderClosed--> <valueString value="[string]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 Value to add (or replace) - any valid datatype --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <value[x]><!-- I 1..1 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|| </value[x]>TriggerDefinition|UsageContext|Availability|ExtendedContactDetail| VirtualServiceDetail|Dosage|Meta If parameter is a data type --></value[x]> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 Index at which insert (insert operation only) --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueInteger sliced by type:$this in the specified orderClosed--> <valueInteger value="[integer]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 List index to move from (move operation only) --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueInteger sliced by type:$this in the specified orderClosed--> <valueInteger value="[integer]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 List index to move to (move operation only) --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueInteger sliced by type:$this in the specified orderClosed--> <valueInteger value="[integer]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> </parameter> </Parameters>
{ // FHIRPathPatchProfile
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"parameter" : [{ BackboneElement }] // IOne root level parameter for each patch operation
}
This structure is derived from Parameters .
Summary
Mandatory:
0
element
(+22
nested
mandatory
elements)
Fixed
Value:
7
elements
Slices
This structure defines the following Slices :
Differential View
This indicates the differences between this profile and the base Parameters structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
Parameters | |||
|
0..* | BackboneElement |
One
root
level
parameter
for
each
patch
operation
|
|
|
1 .. 7 |
Each
parameter
to
the
operation
is
a
part.
See
documentation
for
rules
about
which
parts
are
required
Slice: Unordered, Closed by value:name |
||
|
1..1 | BackboneElement | Operation to perform: add | insert | delete | replace | move | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: type |
|
|
1..1 | code |
If
parameter
is
a
data
type
Binding: Patch Operation ( required ) |
|
|
1..1 | BackboneElement | Path - where to perform the operation | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: path |
|
|
1..1 | string | If parameter is a data type | |
|
1..1 | BackboneElement | name of the property to add (add operation only) | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: name |
|
|
1..1 | string | If parameter is a data type | |
|
1..1 | BackboneElement | Value to add (or replace) - any valid datatype | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: value |
|
|
1..1 | 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 , VirtualServiceDetail , Dosage , Meta | If parameter is a data type | |
|
1..1 | BackboneElement | Index at which insert (insert operation only) | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: index |
|
|
1..1 | integer | If parameter is a data type | |
|
1..1 | BackboneElement | List index to move from (move operation only) | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: source |
|
|
1..1 | integer | If parameter is a data type | |
|
1..1 | BackboneElement | List index to move to (move operation only) | |
|
1..1 | string |
Name
from
the
definition
Fixed Value: destination |
|
|
1..1 | integer | If parameter is a data type | |
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Parameters structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
0..* | Parameters |
Operation
Request
or
Response
|
|||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required
|
|||||
|
Σ
C
|
0..* | BackboneElement |
One
root
level
parameter
for
each
patch
operation
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string | Name from the definition | ||||
|
Σ
C
|
0..1 | If parameter is a data type | |||||
|
base64Binary | |||||||
|
boolean | |||||||
|
canonical (Any) | |||||||
|
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 (Any) | |||||||
|
SampledData | |||||||
|
Signature | |||||||
|
Timing | |||||||
|
ContactDetail | |||||||
|
DataRequirement | |||||||
|
Expression | |||||||
|
ParameterDefinition | |||||||
|
RelatedArtifact | |||||||
|
TriggerDefinition | |||||||
|
UsageContext | |||||||
|
Availability | |||||||
|
ExtendedContactDetail | |||||||
| VirtualServiceDetail | |||||||
![]() ![]() ![]() ![]() |
Dosage | |||||||
|
Meta | |||||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
1 .. 7 | See parameter (Parameters) |
Each
parameter
to
the
operation
is
a
part.
See
documentation
for
rules
about
which
parts
are
required
Slice: Unordered, Closed by value:name |
||||
| Content/Rules for all slices | |||||||
| 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name from the definition | ||||
![]() ![]() ![]() ![]() ![]() |
Σ
C
![]() | 0..1 | If parameter is a data type | |||||
![]() ![]() ![]() ![]() ![]() ![]() | base64Binary | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | canonical (Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | 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 (Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | SampledData | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Signature | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Timing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | ContactDetail | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | DataRequirement | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Expression | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | ParameterDefinition | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | RelatedArtifact | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | TriggerDefinition | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | UsageContext | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Availability | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | ExtendedContactDetail | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | VirtualServiceDetail | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Dosage | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Meta | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ
C
![]() | 0..1 | Resource | If parameter is a whole resource | ||||
![]() ![]() ![]() ![]() ![]() |
Σ
C
![]() | 0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
| ||||
|
Σ
C
|
1..1 | BackboneElement |
Operation
to
perform:
add
|
insert
|
delete
|
replace
|
move
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: type |
||||
|
Σ
C
|
1 .. 1 | code |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | code |
If
parameter
is
a
data
type
Binding: Patch Operation ( required ) |
||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
Path
-
where
to
perform
the
operation
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: path |
||||
|
Σ
C
|
1 .. 1 | string |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | string | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
name
of
the
property
to
add
(add
operation
only)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: name |
||||
|
Σ
C
|
1 .. 1 | string |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | string | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
Value
to
add
(or
replace)
-
any
valid
datatype
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: value |
||||
|
Σ
C
|
1..1 | If parameter is a data type | |||||
|
base64Binary | |||||||
|
boolean | |||||||
|
canonical (Any) | |||||||
|
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 (Any) | |||||||
|
SampledData | |||||||
|
Signature | |||||||
|
Timing | |||||||
|
ContactDetail | |||||||
|
DataRequirement | |||||||
|
Expression | |||||||
|
ParameterDefinition | |||||||
|
RelatedArtifact | |||||||
|
TriggerDefinition | |||||||
|
UsageContext | |||||||
|
Availability | |||||||
|
ExtendedContactDetail | |||||||
| VirtualServiceDetail | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Dosage | |||||||
|
Meta | |||||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
Index
at
which
insert
(insert
operation
only)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: index |
||||
|
Σ
C
|
1 .. 1 | integer |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | integer | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
List
index
to
move
from
(move
operation
only)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: source |
||||
|
Σ
C
|
1 .. 1 | integer |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | integer | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
Σ
C
|
1..1 | BackboneElement |
List
index
to
move
to
(move
operation
only)
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | string |
Name
from
the
definition
Fixed Value: destination |
||||
|
Σ
C
|
1 .. 1 | integer |
If
parameter
is
a
data
type
Slice: Unordered, Closed by type:$this |
||||
|
Σ
C
|
1..1 | integer | If parameter is a data type | ||||
|
Σ
C
|
0..1 | Resource | If parameter is a whole resource | ||||
|
Σ
C
|
0..* | See parameter (Parameters) |
Named
part
of
a
multi-part
parameter
|
||||
|
||||||||
XML Template
<!-- FHIRPathPatchProfile --><Parameters xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
<<implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <parameter> I 0..* BackboneElement <!-- I 0..* One root level parameter for each patch operation --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <value[x]><!-- I 0..1 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|If parameter is a data type</value[x]>UsageContext|Availability|ExtendedContactDetail|VirtualServiceDetail|Dosage| Meta If parameter is a data type --></value[x]> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <-- part sliced by value:name in the specified orderClosed--> <part> I 1..1 BackboneElement <!-- I 1..1 Operation to perform: add | insert | delete | replace | move --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueCode sliced by type:$this in the specified orderClosed--> <valueCode value="[code]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 Path - where to perform the operation --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueString sliced by type:$this in the specified orderClosed--> <valueString value="[string]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 name of the property to add (add operation only) --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueString sliced by type:$this in the specified orderClosed--> <valueString value="[string]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 Value to add (or replace) - any valid datatype --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <value[x]><!-- I 1..1 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|| </value[x]>TriggerDefinition|UsageContext|Availability|ExtendedContactDetail| VirtualServiceDetail|Dosage|Meta If parameter is a data type --></value[x]> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 Index at which insert (insert operation only) --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueInteger sliced by type:$this in the specified orderClosed--> <valueInteger value="[integer]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 List index to move from (move operation only) --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueInteger sliced by type:$this in the specified orderClosed--> <valueInteger value="[integer]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> <part> I 1..1 BackboneElement <!-- I 1..1 List index to move to (move operation only) --><<a href="fhirpath-patch-definitions.html#Parameters.parameter.part.modifierExtension" title="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.<modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Name from the definition --> <-- valueInteger sliced by type:$this in the specified orderClosed--> <valueInteger value="[integer]"/><!-- I 1..1 If parameter is a data type --> <resource><!-- 0..1 Resource If parameter is a whole resource --></resource> <part><!-- See http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter Named part of a multi-part parameter --></part> </part> </parameter> </Parameters>
JSON Template
{ // FHIRPathPatchProfile
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"parameter" : [{ BackboneElement }] // IOne root level parameter for each patch operation
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| Parameters.language | All Languages | required | All Languages |
| Parameters.parameter.part.value[x] | Patch Operation | required | Patch Operation |