Smart Health Checks
0.3.0 - ci-build
Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions
Draft as of 2025-09-17 |
Definitions for the SHCPatch resource profile.
Guidance on how to interpret the contents of this table can be foundhere
0. Parameters | |||||||
Definition | This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. | ||||||
Short | Parameters for patching elements supported in Smart Health ChecksOperation Request or Response | ||||||
Comments | The parameters that may be used are defined by the OperationDefinition resource. | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | shc-patch-01: When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. (parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') )shc-patch-02: When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. ( parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') )shc-patch-03: When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. ( parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') ) | ||||||
2. Parameters.implicitRules | |||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||
Short | A set of rules under which this content was created | ||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
4. Parameters.parameter | |||||||
Definition | A parameter passed to or received from the operation. | ||||||
Short | Operation Parameter | ||||||
Control | 10..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-1: A parameter must have one and only one of (value, resource, part) ( (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) )inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||||
6. Parameters.parameter.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
8. Parameters.parameter.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Parameters for element patchingName from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | operation | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
10. Parameters.parameter.part | |||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Named part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 30..* | ||||||
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
12. Parameters.parameter.part.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
14. Parameters.parameter.part.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
16. Parameters.parameter.part:type | |||||||
Slice Name | type | ||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Patch operation to performNamed part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 10..1* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
18. Parameters.parameter.part:type.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
20. Parameters.parameter.part:type.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | type | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
22. Parameters.parameter.part:type.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 10..1 This element is affected by the following invariants: inv-1 | ||||||
Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | replace | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
24. Parameters.parameter.part:path | |||||||
Slice Name | path | ||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Where to perform the operationNamed part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 10..1* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
26. Parameters.parameter.part:path.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
28. Parameters.parameter.part:path.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | path | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
30. Parameters.parameter.part:path.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 10..1 This element is affected by the following invariants: inv-1 | ||||||
Binding | The codes SHALL be taken from For codes, see Smart Health Checks Patch Path (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath ) | ||||||
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
32. Parameters.parameter.part:value | |||||||
Slice Name | value | ||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Replacement valueNamed part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 10..1* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
34. Parameters.parameter.part:value.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
36. Parameters.parameter.part:value.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | value | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
38. Parameters.parameter.part:value.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 10..1 This element is affected by the following invariants: inv-1, shc-patch-01, shc-patch-02, shc-patch-03 | ||||||
Type | Choice of: code, dateTime, markdown, string, CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, Contributor, oid, instant, ContactPoint, HumanName, Money, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part.value[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
40. Parameters.parameter.part:value.value[x]:valueCode | |||||||
Slice Name | valueCode | ||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Binding | The codes SHALL be taken from For codes, see Medication Statement Status Limited (required to https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited ) | ||||||
Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
42. Parameters.parameter.part:value.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
44. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code defined by a terminology system | ||||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part.value[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
46. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | |||||||
Slice Name | AllergyIntoleranceClinicalStatusCodes | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code defined by a terminology system | ||||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||||
Control | 0..1* | ||||||
Binding | The codes SHALL be taken from For codes, see Allergy Intolerance Clinical Status Minimal (required to https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal ) | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
48. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | |||||||
Slice Name | ConditionClinicalStatusCodes | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code defined by a terminology system | ||||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||||
Control | 0..1* | ||||||
Binding | The codes SHALL be taken from For codes, see ConditionClinicalStatusCodes (required to http://hl7.org/fhir/ValueSet/condition-clinical ) | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
50. Parameters.parameter.part:value.value[x]:valueDateTime | |||||||
Slice Name | valueDateTime | ||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | dateTime, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
52. Parameters.parameter.part:value.value[x]:valueMarkdown | |||||||
Slice Name | valueMarkdown | ||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | markdown, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
54. Parameters.parameter.part:pathLabel | |||||||
Slice Name | pathLabel | ||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.Named part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 0..1* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
56. Parameters.parameter.part:pathLabel.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
58. Parameters.parameter.part:pathLabel.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | pathLabel | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
60. Parameters.parameter.part:pathLabel.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 10..1 This element is affected by the following invariants: inv-1 | ||||||
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
0. Parameters | |||||||
Short | Parameters for patching elements supported in Smart Health Checks | ||||||
Invariants | shc-patch-01: When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. (parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') )shc-patch-02: When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. ( parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') )shc-patch-03: When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. ( parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') ) | ||||||
2. Parameters.parameter | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
4. Parameters.parameter.name | |||||||
Short | Parameters for element patching | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Fixed Value | operation | ||||||
6. Parameters.parameter.part | |||||||
Control | 3..? | ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
8. Parameters.parameter.part:type | |||||||
Slice Name | type | ||||||
Short | Patch operation to perform | ||||||
Control | 1..1 | ||||||
Type | BackboneElement | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
10. Parameters.parameter.part:type.name | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
Fixed Value | type | ||||||
12. Parameters.parameter.part:type.value[x] | |||||||
Control | 1..? | ||||||
Type | code | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Fixed Value | replace | ||||||
14. Parameters.parameter.part:path | |||||||
Slice Name | path | ||||||
Short | Where to perform the operation | ||||||
Control | 1..1 | ||||||
Type | BackboneElement | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
16. Parameters.parameter.part:path.name | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
Fixed Value | path | ||||||
18. Parameters.parameter.part:path.value[x] | |||||||
Control | 1..? | ||||||
Binding | The codes SHALL be taken from Smart Health Checks Patch Path (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath ) | ||||||
Type | string | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
20. Parameters.parameter.part:value | |||||||
Slice Name | value | ||||||
Short | Replacement value | ||||||
Control | 1..1 | ||||||
Type | BackboneElement | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
22. Parameters.parameter.part:value.name | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
Fixed Value | value | ||||||
24. Parameters.parameter.part:value.value[x] | |||||||
Control | 1..? This element is affected by the following invariants: shc-patch-01, shc-patch-02, shc-patch-03 | ||||||
Type | Choice of: code, dateTime, markdown, string, CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part.value[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
26. Parameters.parameter.part:value.value[x]:valueCode | |||||||
Slice Name | valueCode | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from Medication Statement Status Limited (required to https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited ) | ||||||
Type | code | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
28. Parameters.parameter.part:value.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Control | 0..1 | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Must Support | true | ||||||
30. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding | |||||||
Control | 1..1 | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part.value[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
32. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | |||||||
Slice Name | AllergyIntoleranceClinicalStatusCodes | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from Allergy Intolerance Clinical Status Minimal (required to https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal ) | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
34. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | |||||||
Slice Name | ConditionClinicalStatusCodes | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from ConditionClinicalStatusCodes (required to http://hl7.org/fhir/ValueSet/condition-clinical ) | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
36. Parameters.parameter.part:value.value[x]:valueDateTime | |||||||
Slice Name | valueDateTime | ||||||
Control | 0..1 | ||||||
Type | dateTime | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
38. Parameters.parameter.part:value.value[x]:valueMarkdown | |||||||
Slice Name | valueMarkdown | ||||||
Control | 0..1 | ||||||
Type | markdown | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
40. Parameters.parameter.part:pathLabel | |||||||
Slice Name | pathLabel | ||||||
Short | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire. | ||||||
Control | 0..1 | ||||||
Type | BackboneElement | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
42. Parameters.parameter.part:pathLabel.name | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
Fixed Value | pathLabel | ||||||
44. Parameters.parameter.part:pathLabel.value[x] | |||||||
Control | 1..? | ||||||
Type | string | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
|
Guidance on how to interpret the contents of this table can be foundhere
0. Parameters | |||||||
Definition | This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. | ||||||
Short | Parameters for patching elements supported in Smart Health Checks | ||||||
Comments | The parameters that may be used are defined by the OperationDefinition resource. | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | shc-patch-01: When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. (parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') )shc-patch-02: When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. ( parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') )shc-patch-03: When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. ( parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') ) | ||||||
2. Parameters.id | |||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||
Short | Logical id of this artifact | ||||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||||
Control | 0..1 | ||||||
Type | id | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
4. Parameters.meta | |||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||
Short | Metadata about the resource | ||||||
Control | 0..1 | ||||||
Type | Meta | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
6. Parameters.implicitRules | |||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||
Short | A set of rules under which this content was created | ||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
8. Parameters.language | |||||||
Definition | The base language in which the resource is written. | ||||||
Short | Language of the resource content | ||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1 )A human language.
| ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
10. Parameters.parameter | |||||||
Definition | A parameter passed to or received from the operation. | ||||||
Short | Operation Parameter | ||||||
Control | 1..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )inv-1: A parameter must have one and only one of (value, resource, part) ( (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) ) | ||||||
12. Parameters.parameter.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
14. Parameters.parameter.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
Short | Additional content defined by implementations | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
16. Parameters.parameter.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
18. Parameters.parameter.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Parameters for element patching | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | operation | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
20. Parameters.parameter.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
22. Parameters.parameter.resource | |||||||
Definition | If the parameter is a whole resource. | ||||||
Short | If parameter is a whole resource | ||||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
24. Parameters.parameter.part | |||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Named part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 3..* | ||||||
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
26. Parameters.parameter.part.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
28. Parameters.parameter.part.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
Short | Additional content defined by implementations | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
30. Parameters.parameter.part.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
32. Parameters.parameter.part.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
34. Parameters.parameter.part.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
36. Parameters.parameter.part.resource | |||||||
Definition | If the parameter is a whole resource. | ||||||
Short | If parameter is a whole resource | ||||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
38. Parameters.parameter.part.part | |||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Named part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 0..* | ||||||
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
40. Parameters.parameter.part:type | |||||||
Slice Name | type | ||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Patch operation to perform | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 1..1 | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
42. Parameters.parameter.part:type.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
44. Parameters.parameter.part:type.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
Short | Additional content defined by implementations | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
46. Parameters.parameter.part:type.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
48. Parameters.parameter.part:type.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | type | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
50. Parameters.parameter.part:type.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 1..1 This element is affected by the following invariants: inv-1 | ||||||
Type | code | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | replace | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
52. Parameters.parameter.part:type.resource | |||||||
Definition | If the parameter is a whole resource. | ||||||
Short | If parameter is a whole resource | ||||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
54. Parameters.parameter.part:type.part | |||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Named part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 0..* | ||||||
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
56. Parameters.parameter.part:path | |||||||
Slice Name | path | ||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Where to perform the operation | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 1..1 | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
58. Parameters.parameter.part:path.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
60. Parameters.parameter.part:path.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
Short | Additional content defined by implementations | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
62. Parameters.parameter.part:path.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
64. Parameters.parameter.part:path.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | path | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
66. Parameters.parameter.part:path.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 1..1 This element is affected by the following invariants: inv-1 | ||||||
Binding | The codes SHALL be taken from Smart Health Checks Patch Path (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath ) | ||||||
Type | string | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
68. Parameters.parameter.part:path.resource | |||||||
Definition | If the parameter is a whole resource. | ||||||
Short | If parameter is a whole resource | ||||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
70. Parameters.parameter.part:path.part | |||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Named part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 0..* | ||||||
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
72. Parameters.parameter.part:value | |||||||
Slice Name | value | ||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Replacement value | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 1..1 | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
74. Parameters.parameter.part:value.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
76. Parameters.parameter.part:value.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
Short | Additional content defined by implementations | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
78. Parameters.parameter.part:value.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
80. Parameters.parameter.part:value.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | value | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
82. Parameters.parameter.part:value.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 1..1 This element is affected by the following invariants: inv-1, shc-patch-01, shc-patch-02, shc-patch-03 | ||||||
Type | Choice of: code, dateTime, markdown, string, CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part.value[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
84. Parameters.parameter.part:value.value[x]:valueCode | |||||||
Slice Name | valueCode | ||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Binding | The codes SHALL be taken from Medication Statement Status Limited (required to https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited ) | ||||||
Type | code | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
86. Parameters.parameter.part:value.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
88. Parameters.parameter.part:value.value[x]:valueCodeableConcept.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
90. Parameters.parameter.part:value.value[x]:valueCodeableConcept.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
Short | Additional content defined by implementations | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part.value[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
92. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code defined by a terminology system | ||||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This element introduces a set of slices on Parameters.parameter.part.value[x].coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
94. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | |||||||
Slice Name | AllergyIntoleranceClinicalStatusCodes | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code defined by a terminology system | ||||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from Allergy Intolerance Clinical Status Minimal (required to https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal ) | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
96. Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | |||||||
Slice Name | ConditionClinicalStatusCodes | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code defined by a terminology system | ||||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from ConditionClinicalStatusCodes (required to http://hl7.org/fhir/ValueSet/condition-clinical ) | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
98. Parameters.parameter.part:value.value[x]:valueCodeableConcept.text | |||||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
100. Parameters.parameter.part:value.value[x]:valueDateTime | |||||||
Slice Name | valueDateTime | ||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | dateTime | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
102. Parameters.parameter.part:value.value[x]:valueMarkdown | |||||||
Slice Name | valueMarkdown | ||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | markdown | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
104. Parameters.parameter.part:value.resource | |||||||
Definition | If the parameter is a whole resource. | ||||||
Short | If parameter is a whole resource | ||||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
106. Parameters.parameter.part:value.part | |||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Named part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 0..* | ||||||
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
108. Parameters.parameter.part:pathLabel | |||||||
Slice Name | pathLabel | ||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire. | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 0..1 | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
110. Parameters.parameter.part:pathLabel.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
112. Parameters.parameter.part:pathLabel.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
Short | Additional content defined by implementations | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
114. Parameters.parameter.part:pathLabel.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
116. Parameters.parameter.part:pathLabel.name | |||||||
Definition | The name of the parameter (reference to the operation definition). | ||||||
Short | Name from the definition | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Fixed Value | pathLabel | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
118. Parameters.parameter.part:pathLabel.value[x] | |||||||
Definition | If the parameter is a data type. | ||||||
Short | If parameter is a data type | ||||||
Control | 1..1 This element is affected by the following invariants: inv-1 | ||||||
Type | string | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
120. Parameters.parameter.part:pathLabel.resource | |||||||
Definition | If the parameter is a whole resource. | ||||||
Short | If parameter is a whole resource | ||||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
122. Parameters.parameter.part:pathLabel.part | |||||||
Definition | A named part of a multi-part parameter. | ||||||
Short | Named part of a multi-part parameter | ||||||
Comments | Only one level of nested parameters is allowed. | ||||||
Control | 0..* | ||||||
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |