Elektronische Leistungsbestätigung
1.0.0 - draft
Elektronische Leistungsbestätigung - Local Development build (v1.0.0). See the Directory of published versions
Draft as of 2023-07-07 |
Definitions for the KK-ELB-PollingRequest resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Parameters | |
2. Parameters.meta | |
Control | 10..1 |
Must Support | true |
3. Parameters.meta.profile | |
Control | 1..1 |
Must Support | true |
4. Parameters.implicitRules | |
Control | 0..01 |
5. Parameters.language | |
Control | 0..01 |
6. Parameters.parameter | |
Control | 10..1* |
Must Support | true |
Slicing | This element introduces a set of slices on Parameters.parameter. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
7. Parameters.parameter:byRequestingSystem | |
SliceName | byRequestingSystem |
Control | 0..1 |
8. Parameters.parameter:byRequestingSystem.id | |
Control | 0..0 |
9. Parameters.parameter:byRequestingSystem.name | |
Control | 0..? |
Must Support | true |
Fixed Value | requestingSystem |
10. Parameters.parameter:byRequestingSystem.value[x] | |
Control | 1..? |
Type | Identifier(IdentifierIknr) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
11. Parameters.parameter:byRequestingSystem.resource | |
Control | 0..0 |
12. Parameters.parameter:byRequestingSystem.part | |
Control | 0..0 |
13. Parameters.parameter:byPerformingOrganization | |
SliceName | byPerformingOrganization |
Control | 0..1 |
14. Parameters.parameter:byPerformingOrganization.id | |
Control | 0..0 |
15. Parameters.parameter:byPerformingOrganization.name | |
Control | 0..? |
Must Support | true |
Fixed Value | performingOrganization |
16. Parameters.parameter:byPerformingOrganization.value[x] | |
Control | 1..? |
Type | Identifier(IdentifierIknr) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
17. Parameters.parameter:byPerformingOrganization.resource | |
Control | 0..0 |
18. Parameters.parameter:byPerformingOrganization.part | |
Control | 0..0 |
19. Parameters.parameter:byPatient | |
SliceName | byPatient |
Control | 0..1 |
20. Parameters.parameter:byPatient.id | |
Control | 0..0 |
21. Parameters.parameter:byPatient.name | |
Control | 0..? |
Must Support | true |
Fixed Value | patient |
22. Parameters.parameter:byPatient.value[x] | |
Control | 1..? |
Type | Identifier(IdentifierKvid10) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
23. Parameters.parameter:byPatient.resource | |
Control | 0..0 |
24. Parameters.parameter:byPatient.part | |
Control | 0..0 |
25. Parameters.parameter:byPayor | |
SliceName | byPayor |
Control | 0..1 |
26. Parameters.parameter:byPayor.id | |
Control | 0..0 |
27. Parameters.parameter:byPayor.name | |
Control | 0..? |
Must Support | true |
Fixed Value | payor |
28. Parameters.parameter:byPayor.value[x] | |
Control | 1..? |
Type | Identifier(IdentifierIknr) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
29. Parameters.parameter:byPayor.resource | |
Control | 0..0 |
30. Parameters.parameter:byPayor.part | |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here.
1. 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. | ||||
Control | 0..* | ||||
Summary | false | ||||
Comments | The parameters that may be used are defined by the OperationDefinition resource. | ||||
2. 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. | ||||
Control | 10..1 | ||||
Type | Meta | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
3. Parameters.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Control | 10..1* | ||||
Type | canonical(StructureDefinition) | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. 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. | ||||
Control | 0..01 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
5. Parameters.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..01 | ||||
Binding | The codes SHOULD be taken from CommonLanguages A human language.
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
6. Parameters.parameter | |||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 10..1* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element 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()))) | ||||
Slicing | This element introduces a set of slices on Parameters.parameter. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
7. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
9. Parameters.parameter:byRequestingSystem | |||||
SliceName | byRequestingSystem | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element 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()))) | ||||
10. Parameters.parameter:byRequestingSystem.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..01 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
11. Parameters.parameter:byRequestingSystem.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
12. Parameters.parameter:byRequestingSystem.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | requestingSystem | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
13. Parameters.parameter:byRequestingSystem.value[x] | |||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. If the parameter is a data type. | ||||
Control | 10..1 This element is affected by the following invariants: ele-1, inv-1 | ||||
Type | Choice of: Identifier(IdentifierIknr), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, 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 | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
14. Parameters.parameter:byRequestingSystem.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..01 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
15. Parameters.parameter:byRequestingSystem.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..0* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
16. Parameters.parameter:byPerformingOrganization | |||||
SliceName | byPerformingOrganization | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element 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()))) | ||||
17. Parameters.parameter:byPerformingOrganization.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..01 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
18. Parameters.parameter:byPerformingOrganization.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
19. Parameters.parameter:byPerformingOrganization.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | performingOrganization | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
20. Parameters.parameter:byPerformingOrganization.value[x] | |||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. If the parameter is a data type. | ||||
Control | 10..1 This element is affected by the following invariants: ele-1, inv-1 | ||||
Type | Choice of: Identifier(IdentifierIknr), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, 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 | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
21. Parameters.parameter:byPerformingOrganization.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..01 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
22. Parameters.parameter:byPerformingOrganization.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..0* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. Parameters.parameter:byPatient | |||||
SliceName | byPatient | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element 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()))) | ||||
24. Parameters.parameter:byPatient.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..01 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
25. Parameters.parameter:byPatient.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
26. Parameters.parameter:byPatient.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Parameters.parameter:byPatient.value[x] | |||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. If the parameter is a data type. | ||||
Control | 10..1 This element is affected by the following invariants: ele-1, inv-1 | ||||
Type | Choice of: Identifier(IdentifierKvid10), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, 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 | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Parameters.parameter:byPatient.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..01 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
29. Parameters.parameter:byPatient.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..0* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. Parameters.parameter:byPayor | |||||
SliceName | byPayor | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element 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()))) | ||||
31. Parameters.parameter:byPayor.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..01 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
32. Parameters.parameter:byPayor.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
33. Parameters.parameter:byPayor.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | payor | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. Parameters.parameter:byPayor.value[x] | |||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. If the parameter is a data type. | ||||
Control | 10..1 This element is affected by the following invariants: ele-1, inv-1 | ||||
Type | Choice of: Identifier(IdentifierIknr), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, 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 | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. Parameters.parameter:byPayor.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..01 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
36. Parameters.parameter:byPayor.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..0* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element 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 found here.
1. 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. | ||||
Control | 0..* | ||||
Summary | false | ||||
Comments | The parameters that may be used are defined by the OperationDefinition resource. | ||||
2. Parameters.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
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. | ||||
3. 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. | ||||
Control | 1..1 | ||||
Type | Meta | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. Parameters.meta.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
5. Parameters.meta.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element 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.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
6. Parameters.meta.versionId | |||||
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
7. Parameters.meta.lastUpdated | |||||
Definition | When the resource last changed - e.g. when the version changed. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
8. Parameters.meta.source | |||||
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
9. Parameters.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Control | 1..1 | ||||
Type | canonical(StructureDefinition) | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
10. Parameters.meta.security | |||||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System | ||||
Type | Coding | ||||
Summary | true | ||||
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
11. Parameters.meta.tag | |||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..* | ||||
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Summary | true | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
12. 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. | ||||
Control | 0..0 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
13. Parameters.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..0 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
14. Parameters.parameter | |||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element 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()))) | ||||
Slicing | This element introduces a set of slices on Parameters.parameter. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
15. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
16. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element 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()) | ||||
17. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
19. Parameters.parameter.value[x] | |||||
Definition | If the 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 | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
20. Parameters.parameter.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
21. Parameters.parameter.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
22. Parameters.parameter:byRequestingSystem | |||||
SliceName | byRequestingSystem | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
23. Parameters.parameter:byRequestingSystem.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..0 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
24. Parameters.parameter:byRequestingSystem.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element 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()) | ||||
25. Parameters.parameter:byRequestingSystem.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
26. Parameters.parameter:byRequestingSystem.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | requestingSystem | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Parameters.parameter:byRequestingSystem.value[x] | |||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Identifier(IdentifierIknr) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Parameters.parameter:byRequestingSystem.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..0 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
29. Parameters.parameter:byRequestingSystem.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..0 | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. Parameters.parameter:byPerformingOrganization | |||||
SliceName | byPerformingOrganization | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
31. Parameters.parameter:byPerformingOrganization.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..0 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
32. Parameters.parameter:byPerformingOrganization.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element 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()) | ||||
33. Parameters.parameter:byPerformingOrganization.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
34. Parameters.parameter:byPerformingOrganization.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | performingOrganization | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. Parameters.parameter:byPerformingOrganization.value[x] | |||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Identifier(IdentifierIknr) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. Parameters.parameter:byPerformingOrganization.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..0 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
37. Parameters.parameter:byPerformingOrganization.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..0 | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. Parameters.parameter:byPatient | |||||
SliceName | byPatient | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
39. Parameters.parameter:byPatient.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..0 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
40. Parameters.parameter:byPatient.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element 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()) | ||||
41. Parameters.parameter:byPatient.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
42. Parameters.parameter:byPatient.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. Parameters.parameter:byPatient.value[x] | |||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Identifier(IdentifierKvid10) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. Parameters.parameter:byPatient.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..0 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
45. Parameters.parameter:byPatient.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..0 | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. Parameters.parameter:byPayor | |||||
SliceName | byPayor | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
47. Parameters.parameter:byPayor.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..0 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
48. Parameters.parameter:byPayor.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element 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()) | ||||
49. Parameters.parameter:byPayor.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
50. Parameters.parameter:byPayor.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | payor | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. Parameters.parameter:byPayor.value[x] | |||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Identifier(IdentifierIknr) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. Parameters.parameter:byPayor.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..0 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
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. | ||||
53. Parameters.parameter:byPayor.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..0 | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |