Smart Health Checks
0.3.0 - ci-build
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-10-01 |
Definitions for the SHCPatchMedicationStatement 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 MedicationStatement resource 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-medication-statement-01: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'status', the part parameter named 'value' SHALL have a value from the 'Medication Statement Status Limited' value set. (parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'status').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'status').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited'))shc-patch-medication-statement-02: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'dosage', the part parameter named 'value' SHALL have a value of type Dosage. ( parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'dosage').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'dosage').part.where(name='value').value is Dosage)shc-patch-medication-statement-03: When the part parameter named 'path' has a value of 'MedicationStatement.dosage[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type string. ( parameter.where(part.where(name='path').value = 'MedicationStatement.dosage[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement.dosage[0]' and part.where(name='name').value = 'text').part.where(name='value').value is string)shc-patch-medication-statement-04: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation. ( parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation)shc-patch-medication-statement-05: When the part parameter named 'path' has a value of 'MedicationStatement.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown. ( parameter.where(part.where(name='path').value = 'MedicationStatement.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown) | ||||||
| 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 | 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 | 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 | 40..* | ||||||
| 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 | add | ||||||
| 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 MedicationStatement Element Path (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchMedicationStatementElementPath) | ||||||
| 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:name | |||||||
| Slice Name | name | ||||||
| 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 | 10..1* | ||||||
| Type | BackboneElement | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 34. Parameters.parameter.part:name.modifierExtension | |||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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:name.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 | name | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 38. Parameters.parameter.part:name.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 MedicationStatement Element Name (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchMedicationStatementElementName) | ||||||
| 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())) | ||||||
| 40. 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())) | ||||||
| 42. 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()) | ||||||
| 44. 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())) | ||||||
| 46. 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-medication-statement-01, shc-patch-medication-statement-02, shc-patch-medication-statement-03, shc-patch-medication-statement-04, shc-patch-medication-statement-05 | ||||||
| Type | Choice of: code, markdown, string, Annotation, Dosage, date, Meta, Address, Attachment, integer, Count, DataRequirement, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, Contributor, oid, instant, ContactPoint, HumanName, Money, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, 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: | ||||||
| 48. 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())) | ||||||
| 50. Parameters.parameter.part:value.value[x]:valueDosage | |||||||
| Slice Name | valueDosage | ||||||
| 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 | Dosage, date, Meta, Address, Attachment, integer, Count, DataRequirement, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| 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())) | ||||||
| 52. Parameters.parameter.part:value.value[x]:valueDosage.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()) | ||||||
| 54. Parameters.parameter.part:value.value[x]:valueDosage.text | |||||||
| Definition | Free text dosage instructions e.g. SIG. | ||||||
| Short | Free text dosage instructions e.g. SIG | ||||||
| Control | 10..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 | ||||||
| Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 56. 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())) | ||||||
| 58. Parameters.parameter.part:value.value[x]:valueAnnotation | |||||||
| Slice Name | valueAnnotation | ||||||
| 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 | Annotation, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, 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 | ||||||
| Obligations |
| ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 60. Parameters.parameter.part:value.value[x]:valueAnnotation.text | |||||||
| Definition | The text of the annotation in markdown format. | ||||||
| Short | The annotation - text content (as markdown) | ||||||
| Control | 1..1 | ||||||
| Type | markdown | ||||||
| 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())) | ||||||
| 62. 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())) | ||||||
| 64. 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()) | ||||||
| 66. 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())) | ||||||
| 68. 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 MedicationStatement resource elements supported in Smart Health Checks | ||||||
| Invariants | shc-patch-medication-statement-01: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'status', the part parameter named 'value' SHALL have a value from the 'Medication Statement Status Limited' value set. (parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'status').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'status').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited'))shc-patch-medication-statement-02: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'dosage', the part parameter named 'value' SHALL have a value of type Dosage. ( parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'dosage').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'dosage').part.where(name='value').value is Dosage)shc-patch-medication-statement-03: When the part parameter named 'path' has a value of 'MedicationStatement.dosage[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type string. ( parameter.where(part.where(name='path').value = 'MedicationStatement.dosage[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement.dosage[0]' and part.where(name='name').value = 'text').part.where(name='value').value is string)shc-patch-medication-statement-04: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation. ( parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation)shc-patch-medication-statement-05: When the part parameter named 'path' has a value of 'MedicationStatement.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown. ( parameter.where(part.where(name='path').value = 'MedicationStatement.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown) | ||||||
| 2. Parameters.parameter | |||||||
| Control | 1..? | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| 4. Parameters.parameter.name | |||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Fixed Value | operation | ||||||
| 6. Parameters.parameter.part | |||||||
| Control | 4..? | ||||||
| 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 | add | ||||||
| 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 MedicationStatement Element Path (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchMedicationStatementElementPath) | ||||||
| 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:name | |||||||
| Slice Name | name | ||||||
| Control | 1..1 | ||||||
| Type | BackboneElement | ||||||
| 22. Parameters.parameter.part:name.name | |||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Fixed Value | name | ||||||
| 24. Parameters.parameter.part:name.value[x] | |||||||
| Control | 1..? | ||||||
| Binding | The codes SHALL be taken from Smart Health Checks Patch MedicationStatement Element Name (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchMedicationStatementElementName) | ||||||
| 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 |
| ||||||
| 26. Parameters.parameter.part:value | |||||||
| Slice Name | value | ||||||
| Short | Replacement value | ||||||
| Control | 1..1 | ||||||
| Type | BackboneElement | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| 28. Parameters.parameter.part:value.name | |||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Fixed Value | value | ||||||
| 30. Parameters.parameter.part:value.value[x] | |||||||
| Control | 1..? This element is affected by the following invariants: shc-patch-medication-statement-01, shc-patch-medication-statement-02, shc-patch-medication-statement-03, shc-patch-medication-statement-04, shc-patch-medication-statement-05 | ||||||
| Type | Choice of: code, markdown, string, Annotation, Dosage | ||||||
| [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: | ||||||
| 32. 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 | ||||||
| 34. Parameters.parameter.part:value.value[x]:valueDosage | |||||||
| Slice Name | valueDosage | ||||||
| Control | 0..1 | ||||||
| Type | Dosage | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| 36. Parameters.parameter.part:value.value[x]:valueDosage.text | |||||||
| Control | 1..? | ||||||
| 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:value.value[x]:valueAnnotation | |||||||
| Slice Name | valueAnnotation | ||||||
| Control | 0..1 | ||||||
| Type | Annotation | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| 42. Parameters.parameter.part:value.value[x]:valueAnnotation.text | |||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| 44. 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 |
| ||||||
| 46. Parameters.parameter.part:pathLabel.name | |||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Fixed Value | pathLabel | ||||||
| 48. 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 MedicationStatement resource 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-medication-statement-01: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'status', the part parameter named 'value' SHALL have a value from the 'Medication Statement Status Limited' value set. (parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'status').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'status').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited'))shc-patch-medication-statement-02: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'dosage', the part parameter named 'value' SHALL have a value of type Dosage. ( parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'dosage').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'dosage').part.where(name='value').value is Dosage)shc-patch-medication-statement-03: When the part parameter named 'path' has a value of 'MedicationStatement.dosage[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type string. ( parameter.where(part.where(name='path').value = 'MedicationStatement.dosage[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement.dosage[0]' and part.where(name='name').value = 'text').part.where(name='value').value is string)shc-patch-medication-statement-04: When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation. ( parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation)shc-patch-medication-statement-05: When the part parameter named 'path' has a value of 'MedicationStatement.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown. ( parameter.where(part.where(name='path').value = 'MedicationStatement.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown) | ||||||
| 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 | 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 | 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 | 4..* | ||||||
| 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 | add | ||||||
| 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 MedicationStatement Element Path (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchMedicationStatementElementPath) | ||||||
| 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:name | |||||||
| Slice Name | name | ||||||
| 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 | 1..1 | ||||||
| Type | BackboneElement | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 74. Parameters.parameter.part:name.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | 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:name.extension | |||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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:name.modifierExtension | |||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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:name.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 | name | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 82. Parameters.parameter.part:name.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 MedicationStatement Element Name (required to https://smartforms.csiro.au/ig/ValueSet/SHCPatchMedicationStatementElementName) | ||||||
| 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())) | ||||||
| 84. Parameters.parameter.part:name.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 | ||||||
| 86. Parameters.parameter.part:name.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())) | ||||||
| 88. 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())) | ||||||
| 90. 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 | ||||||
| 92. 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()) | ||||||
| 94. 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()) | ||||||
| 96. 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())) | ||||||
| 98. 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-medication-statement-01, shc-patch-medication-statement-02, shc-patch-medication-statement-03, shc-patch-medication-statement-04, shc-patch-medication-statement-05 | ||||||
| Type | Choice of: code, markdown, string, Annotation, Dosage | ||||||
| [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: | ||||||
| 100. 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())) | ||||||
| 102. Parameters.parameter.part:value.value[x]:valueDosage | |||||||
| Slice Name | valueDosage | ||||||
| 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 | Dosage | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| 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())) | ||||||
| 104. Parameters.parameter.part:value.value[x]:valueDosage.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 | ||||||
| 106. Parameters.parameter.part:value.value[x]:valueDosage.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: | ||||||
| 108. Parameters.parameter.part:value.value[x]:valueDosage.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()) | ||||||
| 110. Parameters.parameter.part:value.value[x]:valueDosage.sequence | |||||||
| Definition | Indicates the order in which the dosage instructions should be applied or interpreted. | ||||||
| Short | The order of the dosage instructions | ||||||
| Control | 0..1 | ||||||
| Type | integer | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 112. Parameters.parameter.part:value.value[x]:valueDosage.text | |||||||
| Definition | Free text dosage instructions e.g. SIG. | ||||||
| Short | Free text dosage instructions e.g. SIG | ||||||
| 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 | ||||||
| Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 114. Parameters.parameter.part:value.value[x]:valueDosage.additionalInstruction | |||||||
| Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). | ||||||
| Short | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | ||||||
| Comments | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text. | ||||||
| Control | 0..* | ||||||
| Binding | For example codes, see SNOMEDCTAdditionalDosageInstructions (example to http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1)A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||||
| Type | CodeableConcept | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 116. Parameters.parameter.part:value.value[x]:valueDosage.patientInstruction | |||||||
| Definition | Instructions in terms that are understood by the patient or consumer. | ||||||
| Short | Patient or consumer oriented instructions | ||||||
| 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 | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 118. Parameters.parameter.part:value.value[x]:valueDosage.timing | |||||||
| Definition | When medication should be administered. | ||||||
| Short | When medication should be administered | ||||||
| Comments | This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. | ||||||
| Control | 0..1 | ||||||
| Type | Timing | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 120. Parameters.parameter.part:value.value[x]:valueDosage.asNeeded[x] | |||||||
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | ||||||
| Short | Take "as needed" (for x) | ||||||
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". | ||||||
| Control | 0..1 | ||||||
| Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1)A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | ||||||
| Type | Choice of: boolean, 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 | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 122. Parameters.parameter.part:value.value[x]:valueDosage.site | |||||||
| Definition | Body site to administer to. | ||||||
| Short | Body site to administer to | ||||||
| Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. | ||||||
| Control | 0..1 | ||||||
| Binding | For example codes, see SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example to http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1)A coded concept describing the site location the medicine enters into or onto the body. | ||||||
| Type | CodeableConcept | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | A coded specification of the anatomic site where the medication first enters the body. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 124. Parameters.parameter.part:value.value[x]:valueDosage.route | |||||||
| Definition | How drug should enter body. | ||||||
| Short | How drug should enter body | ||||||
| Control | 0..1 | ||||||
| Binding | For example codes, see SNOMEDCTRouteCodes (example to http://hl7.org/fhir/ValueSet/route-codes|4.0.1)A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||||
| Type | CodeableConcept | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 126. Parameters.parameter.part:value.value[x]:valueDosage.method | |||||||
| Definition | Technique for administering medication. | ||||||
| Short | Technique for administering medication | ||||||
| Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. | ||||||
| Control | 0..1 | ||||||
| Binding | For example codes, see SNOMEDCTAdministrationMethodCodes (example to http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1)A coded concept describing the technique by which the medicine is administered. | ||||||
| Type | CodeableConcept | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 128. Parameters.parameter.part:value.value[x]:valueDosage.doseAndRate | |||||||
| Definition | The amount of medication administered. | ||||||
| Short | Amount of medication administered | ||||||
| Control | 0..* | ||||||
| Type | Element | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 130. Parameters.parameter.part:value.value[x]:valueDosage.doseAndRate.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 | ||||||
| 132. Parameters.parameter.part:value.value[x]:valueDosage.doseAndRate.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].doseAndRate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 134. Parameters.parameter.part:value.value[x]:valueDosage.doseAndRate.type | |||||||
| Definition | The kind of dose or rate specified, for example, ordered or calculated. | ||||||
| Short | The kind of dose or rate specified | ||||||
| Control | 0..1 | ||||||
| Binding | For example codes, see DoseAndRateType (example to http://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1)The kind of dose or rate specified. | ||||||
| Type | CodeableConcept | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | If the type is not populated, assume to be "ordered". | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 136. Parameters.parameter.part:value.value[x]:valueDosage.doseAndRate.dose[x] | |||||||
| Definition | Amount of medication per dose. | ||||||
| Short | Amount of medication per dose | ||||||
| Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. | ||||||
| Control | 0..1 | ||||||
| Type | Choice of: Range, Quantity(SimpleQuantity) | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | The amount of therapeutic or other substance given at one administration event. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 138. Parameters.parameter.part:value.value[x]:valueDosage.doseAndRate.rate[x] | |||||||
| Definition | Amount of medication per unit of time. | ||||||
| Short | Amount of medication per unit of time | ||||||
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. | ||||||
| Control | 0..1 | ||||||
| Type | Choice of: Ratio, Range, Quantity(SimpleQuantity) | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 140. Parameters.parameter.part:value.value[x]:valueDosage.maxDosePerPeriod | |||||||
| Definition | Upper limit on medication per unit of time. | ||||||
| Short | Upper limit on medication per unit of time | ||||||
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". | ||||||
| Control | 0..1 | ||||||
| Type | Ratio | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 142. Parameters.parameter.part:value.value[x]:valueDosage.maxDosePerAdministration | |||||||
| Definition | Upper limit on medication per administration. | ||||||
| Short | Upper limit on medication per administration | ||||||
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. | ||||||
| Control | 0..1 | ||||||
| Type | Quantity(SimpleQuantity) | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 144. Parameters.parameter.part:value.value[x]:valueDosage.maxDosePerLifetime | |||||||
| Definition | Upper limit on medication per lifetime of the patient. | ||||||
| Short | Upper limit on medication per lifetime of the patient | ||||||
| Control | 0..1 | ||||||
| Type | Quantity(SimpleQuantity) | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 146. 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())) | ||||||
| 148. Parameters.parameter.part:value.value[x]:valueAnnotation | |||||||
| Slice Name | valueAnnotation | ||||||
| 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 | Annotation | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| 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())) | ||||||
| 150. Parameters.parameter.part:value.value[x]:valueAnnotation.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 | ||||||
| 152. Parameters.parameter.part:value.value[x]:valueAnnotation.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: | ||||||
| 154. Parameters.parameter.part:value.value[x]:valueAnnotation.author[x] | |||||||
| Definition | The individual responsible for making the annotation. | ||||||
| Short | Individual responsible for the annotation | ||||||
| Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||||||
| Control | 0..1 | ||||||
| Type | Choice of: Reference(Practitioner, Patient, RelatedPerson, Organization), 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 | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 156. Parameters.parameter.part:value.value[x]:valueAnnotation.time | |||||||
| Definition | Indicates when this particular annotation was made. | ||||||
| Short | When the annotation was made | ||||||
| Control | 0..1 | ||||||
| Type | dateTime | ||||||
| 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())) | ||||||
| 158. Parameters.parameter.part:value.value[x]:valueAnnotation.text | |||||||
| Definition | The text of the annotation in markdown format. | ||||||
| Short | The annotation - text content (as markdown) | ||||||
| Control | 1..1 | ||||||
| Type | markdown | ||||||
| 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())) | ||||||
| 160. 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 | ||||||
| 162. 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())) | ||||||
| 164. 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())) | ||||||
| 166. 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 | ||||||
| 168. 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()) | ||||||
| 170. 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()) | ||||||
| 172. 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())) | ||||||
| 174. 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())) | ||||||
| 176. 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 | ||||||
| 178. 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())) | ||||||