FHIR CI-Build

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

2.11.11.2 StructureDefinition: FHIRPathPatchProfile

Clinical Decision Support icon Work Group  Maturity Level: 3 Trial Use 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+0000 as a draft by Health Level Seven, Inc. - FHIR WG.

2.11.11.2.1 Formal Views of Profile Content

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:

  • The element Parameters.parameter.part is sliced based on the value of value:name (Closed)

This indicates the differences between this profile and the base Parameters structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Parameters Parameters
... parameter 0..* BackboneElement One root level parameter for each patch operation
.... Slices for part 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
..... part:type 1..1 BackboneElement Operation to perform: add | insert | delete | replace | move
...... name 1..1 string Name from the definition
Fixed Value: type
...... valueCode 1..1 code If parameter is a data type
Binding: Patch Operation (required)
..... part:path 1..1 BackboneElement Path - where to perform the operation
...... name 1..1 string Name from the definition
Fixed Value: path
...... valueString 1..1 string If parameter is a data type
..... part:name 1..1 BackboneElement name of the property to add (add operation only)
...... name 1..1 string Name from the definition
Fixed Value: name
...... valueString 1..1 string If parameter is a data type
..... part:value 1..1 BackboneElement Value to add (or replace) - any valid datatype
...... name 1..1 string Name from the definition
Fixed Value: value
...... value[x] 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, Dosage, Meta If parameter is a data type
..... part:index 1..1 BackboneElement Index at which insert (insert operation only)
...... name 1..1 string Name from the definition
Fixed Value: index
...... valueInteger 1..1 integer If parameter is a data type
..... part:source 1..1 BackboneElement List index to move from (move operation only)
...... name 1..1 string Name from the definition
Fixed Value: source
...... valueInteger 1..1 integer If parameter is a data type
..... part:destination 1..1 BackboneElement List index to move to (move operation only)
...... name 1..1 string Name from the definition
Fixed Value: destination
...... valueInteger 1..1 integer If parameter is a data type

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Parameters structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... parameter ΣC icon 0..* BackboneElement One root level parameter for each patch operation
inv-1: A parameter must have one and only one of (value, resource, part)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 1..1 string Name from the definition
.... value[x] ΣC icon 0..1 If parameter is a data type
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... valueMeta Meta
.... resource ΣC icon 0..1 Resource If parameter is a whole resource
.... Slices for part ΣC icon 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
..... part:type ΣC icon 1..1 BackboneElement Operation to perform: add | insert | delete | replace | move
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: type
...... Slices for value[x] ΣC icon 1..1 code If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode ΣC icon 1..1 code If parameter is a data type
Binding: Patch Operation (required)
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:path ΣC icon 1..1 BackboneElement Path - where to perform the operation
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: path
...... Slices for value[x] ΣC icon 1..1 string If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueString ΣC icon 1..1 string If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:name ΣC icon 1..1 BackboneElement name of the property to add (add operation only)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: name
...... Slices for value[x] ΣC icon 1..1 string If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueString ΣC icon 1..1 string If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:value ΣC icon 1..1 BackboneElement Value to add (or replace) - any valid datatype
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: value
...... value[x] ΣC icon 1..1 If parameter is a data type
....... valueBase64Binary base64Binary
....... valueBoolean boolean
....... valueCanonical canonical(Any)
....... valueCode code
....... valueDate date
....... valueDateTime dateTime
....... valueDecimal decimal
....... valueId id
....... valueInstant instant
....... valueInteger integer
....... valueInteger64 integer64
....... valueMarkdown markdown
....... valueOid oid
....... valuePositiveInt positiveInt
....... valueString string
....... valueTime time
....... valueUnsignedInt unsignedInt
....... valueUri uri
....... valueUrl url
....... valueUuid uuid
....... valueAddress Address
....... valueAge Age
....... valueAnnotation Annotation
....... valueAttachment Attachment
....... valueCodeableConcept CodeableConcept
....... valueCodeableReference CodeableReference
....... valueCoding Coding
....... valueContactPoint ContactPoint
....... valueCount Count
....... valueDistance Distance
....... valueDuration Duration
....... valueHumanName HumanName
....... valueIdentifier Identifier
....... valueMoney Money
....... valuePeriod Period
....... valueQuantity Quantity
....... valueRange Range
....... valueRatio Ratio
....... valueRatioRange RatioRange
....... valueReference Reference(Any)
....... valueSampledData SampledData
....... valueSignature Signature
....... valueTiming Timing
....... valueContactDetail ContactDetail
....... valueDataRequirement DataRequirement
....... valueExpression Expression
....... valueParameterDefinition ParameterDefinition
....... valueRelatedArtifact RelatedArtifact
....... valueTriggerDefinition TriggerDefinition
....... valueUsageContext UsageContext
....... valueAvailability Availability
....... valueExtendedContactDetail ExtendedContactDetail
....... valueDosage Dosage
....... valueMeta Meta
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:index ΣC icon 1..1 BackboneElement Index at which insert (insert operation only)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: index
...... Slices for value[x] ΣC icon 1..1 integer If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueInteger ΣC icon 1..1 integer If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:source ΣC icon 1..1 BackboneElement List index to move from (move operation only)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: source
...... Slices for value[x] ΣC icon 1..1 integer If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueInteger ΣC icon 1..1 integer If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:destination ΣC icon 1..1 BackboneElement List index to move to (move operation only)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: destination
...... Slices for value[x] ΣC icon 1..1 integer If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueInteger ΣC icon 1..1 integer If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format icon
<!-- FHIRPathPatchProfile -->doco

<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 -->
  <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|
    UsageContext|Availability|ExtendedContactDetail|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 -->
   <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 -->
   <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) -->
   <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 -->
   <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|
     TriggerDefinition|UsageContext|Availability|ExtendedContactDetail|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) -->
   <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) -->
   <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) -->
   <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:

  • The element Parameters.parameter.part is sliced based on the value of value:name (Closed)

Differential View

This indicates the differences between this profile and the base Parameters structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Parameters Parameters
... parameter 0..* BackboneElement One root level parameter for each patch operation
.... Slices for part 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
..... part:type 1..1 BackboneElement Operation to perform: add | insert | delete | replace | move
...... name 1..1 string Name from the definition
Fixed Value: type
...... valueCode 1..1 code If parameter is a data type
Binding: Patch Operation (required)
..... part:path 1..1 BackboneElement Path - where to perform the operation
...... name 1..1 string Name from the definition
Fixed Value: path
...... valueString 1..1 string If parameter is a data type
..... part:name 1..1 BackboneElement name of the property to add (add operation only)
...... name 1..1 string Name from the definition
Fixed Value: name
...... valueString 1..1 string If parameter is a data type
..... part:value 1..1 BackboneElement Value to add (or replace) - any valid datatype
...... name 1..1 string Name from the definition
Fixed Value: value
...... value[x] 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, Dosage, Meta If parameter is a data type
..... part:index 1..1 BackboneElement Index at which insert (insert operation only)
...... name 1..1 string Name from the definition
Fixed Value: index
...... valueInteger 1..1 integer If parameter is a data type
..... part:source 1..1 BackboneElement List index to move from (move operation only)
...... name 1..1 string Name from the definition
Fixed Value: source
...... valueInteger 1..1 integer If parameter is a data type
..... part:destination 1..1 BackboneElement List index to move to (move operation only)
...... name 1..1 string Name from the definition
Fixed Value: destination
...... valueInteger 1..1 integer If parameter is a data type

doco Documentation for this format icon

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 iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... parameter ΣC icon 0..* BackboneElement One root level parameter for each patch operation
inv-1: A parameter must have one and only one of (value, resource, part)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 1..1 string Name from the definition
.... value[x] ΣC icon 0..1 If parameter is a data type
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... valueMeta Meta
.... resource ΣC icon 0..1 Resource If parameter is a whole resource
.... Slices for part ΣC icon 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
..... part:type ΣC icon 1..1 BackboneElement Operation to perform: add | insert | delete | replace | move
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: type
...... Slices for value[x] ΣC icon 1..1 code If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode ΣC icon 1..1 code If parameter is a data type
Binding: Patch Operation (required)
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:path ΣC icon 1..1 BackboneElement Path - where to perform the operation
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: path
...... Slices for value[x] ΣC icon 1..1 string If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueString ΣC icon 1..1 string If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:name ΣC icon 1..1 BackboneElement name of the property to add (add operation only)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: name
...... Slices for value[x] ΣC icon 1..1 string If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueString ΣC icon 1..1 string If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:value ΣC icon 1..1 BackboneElement Value to add (or replace) - any valid datatype
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: value
...... value[x] ΣC icon 1..1 If parameter is a data type
....... valueBase64Binary base64Binary
....... valueBoolean boolean
....... valueCanonical canonical(Any)
....... valueCode code
....... valueDate date
....... valueDateTime dateTime
....... valueDecimal decimal
....... valueId id
....... valueInstant instant
....... valueInteger integer
....... valueInteger64 integer64
....... valueMarkdown markdown
....... valueOid oid
....... valuePositiveInt positiveInt
....... valueString string
....... valueTime time
....... valueUnsignedInt unsignedInt
....... valueUri uri
....... valueUrl url
....... valueUuid uuid
....... valueAddress Address
....... valueAge Age
....... valueAnnotation Annotation
....... valueAttachment Attachment
....... valueCodeableConcept CodeableConcept
....... valueCodeableReference CodeableReference
....... valueCoding Coding
....... valueContactPoint ContactPoint
....... valueCount Count
....... valueDistance Distance
....... valueDuration Duration
....... valueHumanName HumanName
....... valueIdentifier Identifier
....... valueMoney Money
....... valuePeriod Period
....... valueQuantity Quantity
....... valueRange Range
....... valueRatio Ratio
....... valueRatioRange RatioRange
....... valueReference Reference(Any)
....... valueSampledData SampledData
....... valueSignature Signature
....... valueTiming Timing
....... valueContactDetail ContactDetail
....... valueDataRequirement DataRequirement
....... valueExpression Expression
....... valueParameterDefinition ParameterDefinition
....... valueRelatedArtifact RelatedArtifact
....... valueTriggerDefinition TriggerDefinition
....... valueUsageContext UsageContext
....... valueAvailability Availability
....... valueExtendedContactDetail ExtendedContactDetail
....... valueDosage Dosage
....... valueMeta Meta
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:index ΣC icon 1..1 BackboneElement Index at which insert (insert operation only)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: index
...... Slices for value[x] ΣC icon 1..1 integer If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueInteger ΣC icon 1..1 integer If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:source ΣC icon 1..1 BackboneElement List index to move from (move operation only)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: source
...... Slices for value[x] ΣC icon 1..1 integer If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueInteger ΣC icon 1..1 integer If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter
..... part:destination ΣC icon 1..1 BackboneElement List index to move to (move operation only)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name Σ 1..1 string Name from the definition
Fixed Value: destination
...... Slices for value[x] ΣC icon 1..1 integer If parameter is a data type
Slice: Unordered, Closed by type:$this
....... value[x]:valueInteger ΣC icon 1..1 integer If parameter is a data type
...... resource ΣC icon 0..1 Resource If parameter is a whole resource
...... part ΣC icon 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format icon

XML Template

<!-- FHIRPathPatchProfile -->doco

<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 -->
  <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|
    UsageContext|Availability|ExtendedContactDetail|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 -->
   <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 -->
   <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) -->
   <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 -->
   <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|
     TriggerDefinition|UsageContext|Availability|ExtendedContactDetail|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) -->
   <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) -->
   <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) -->
   <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

2.11.11.2.2 Terminology Bindings

Path Name Conformance ValueSet
Parameters.language All Languages required All Languages
Parameters.parameter.part.value[x] Patch Operation required Patch Operation
. .