AddCommunication Implementation Guide
2.2 - version 2.2
This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
Draft as of 2025-02-04 |
Definitions for the CommunicationParameters resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Parameters | |
Definition | This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources. |
Short | Operation Request or Response |
Comments | The parameters that may be used are defined by the OperationDefinition resource. |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | check-allowed-receivecorrespondence-variants: If receiveCorrespondence is true, VisitType must be NEW and ActionType must be BOOK, RESCHEDULE, or CANCEL ((parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference').extension.where(url = 'receiveCorrespondence').value = true) implies ((parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'BOOK') or (parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'RESCHEDULE') or (parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'CANCEL')) ) |
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 | Correspondance IdLogical id of this artifact |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 10..1 |
Type | id |
Is Modifier | false |
Must Support | false |
Summary | true |
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. |
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 its 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 its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | 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. |
Short | AddCommunication parametersOperation Parameter |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
Slicing | This element introduces a set of slices on Parameters.parameter . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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()) |
10. 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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Parameters.parameter:invitation | |
Slice Name | invitation |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for InvitationCommunicationRequestOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
14. Parameters.parameter:invitation.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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()) |
16. Parameters.parameter:invitation.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Parameters.parameter:invitation.resource | |
Definition | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. Conveys the content if the parameter is a whole resource. |
Short | A request for information to be sent to a receiverIf 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | CommunicationRequestResource(Invitation CommunicationRequest) |
Is Modifier | false |
Must Support | false |
Summary | false |
20. Parameters.parameter:reminder | |
Slice Name | reminder |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for ReminderCommunicationRequestOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
22. Parameters.parameter:reminder.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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()) |
24. Parameters.parameter:reminder.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. Parameters.parameter:reminder.resource | |
Definition | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. Conveys the content if the parameter is a whole resource. |
Short | A request for information to be sent to a receiverIf 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | CommunicationRequestResource(Reminder CommunicationRequest) |
Is Modifier | false |
Must Support | false |
Summary | false |
28. Parameters.parameter:invitation_appointment | |
Slice Name | invitation_appointment |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for InvitationAppointmentOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
30. Parameters.parameter:invitation_appointment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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:invitation_appointment.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. Parameters.parameter:invitation_appointment.resource | |
Definition | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). Conveys the content if the parameter is a whole resource. |
Short | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | AppointmentResource(Invitation Appointment) |
Is Modifier | false |
Must Support | false |
Summary | false |
36. Parameters.parameter:reminder_appointment | |
Slice Name | reminder_appointment |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for ReminderAppointmentOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
38. Parameters.parameter:reminder_appointment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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()) |
40. Parameters.parameter:reminder_appointment.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. Parameters.parameter:reminder_appointment.resource | |
Definition | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). Conveys the content if the parameter is a whole resource. |
Short | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | AppointmentResource(Reminder Appointment) |
Is Modifier | false |
Must Support | false |
Summary | false |
44. Parameters.parameter:patient | |
Slice Name | patient |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for PatientOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
46. Parameters.parameter:patient.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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:patient.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
50. Parameters.parameter:patient.resource | |
Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. Conveys the content if the parameter is a whole resource. |
Short | Information about an individual or animal receiving health care servicesIf 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | PatientResource(Patient) |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | SubjectOfCare Client Resident |
52. Parameters.parameter:relatedperson | |
Slice Name | relatedperson |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for RelatedPersonOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
54. Parameters.parameter:relatedperson.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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()) |
56. Parameters.parameter:relatedperson.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. Parameters.parameter:relatedperson.resource | |
Definition | Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. Conveys the content if the parameter is a whole resource. |
Short | A person that is related to a patient, but who is not a direct target of careIf 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | RelatedPersonResource(RelatedPerson) |
Is Modifier | false |
Must Support | false |
Summary | false |
60. Parameters.parameter:practitioner | |
Slice Name | practitioner |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for PractitionerOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
62. Parameters.parameter:practitioner.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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:practitioner.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. Parameters.parameter:practitioner.resource | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare or related services. Conveys the content if the parameter is a whole resource. |
Short | A person with a formal responsibility in the provisioning of healthcare or related servicesIf 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | PractitionerResource(Practitioner) |
Is Modifier | false |
Must Support | false |
Summary | false |
68. Parameters.parameter:healthcareservice | |
Slice Name | healthcareservice |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for HealthcareServiceOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
70. Parameters.parameter:healthcareservice.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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()) |
72. Parameters.parameter:healthcareservice.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. Parameters.parameter:healthcareservice.resource | |
Definition | The details of a healthcare service available at a location. Conveys the content if the parameter is a whole resource. |
Short | The details of a healthcare service available at a locationIf 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | HealthcareServiceResource(HealthCareService) |
Is Modifier | false |
Must Support | false |
Summary | false |
76. Parameters.parameter:location | |
Slice Name | location |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for LocationOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
78. Parameters.parameter:location.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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:location.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
82. Parameters.parameter:location.resource | |
Definition | Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated. Conveys the content if the parameter is a whole resource. |
Short | Details and position information for a placeIf 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | LocationResource(Location) |
Is Modifier | false |
Must Support | false |
Summary | false |
84. Parameters.parameter:othercommunication | |
Slice Name | othercommunication |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for OtherCommunicationRequestOperation Parameter |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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()))) |
86. Parameters.parameter:othercommunication.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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()) |
88. Parameters.parameter:othercommunication.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. Parameters.parameter:othercommunication.resource | |
Definition | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. Conveys the content if the parameter is a whole resource. |
Short | A request for information to be sent to a receiverIf 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | CommunicationRequestResource(Other CommunicationRequest) |
Is Modifier | false |
Must Support | false |
Summary | false |
Guidance on how to interpret the contents of this table can be found here
0. Parameters | |
Invariants | check-allowed-receivecorrespondence-variants: If receiveCorrespondence is true, VisitType must be NEW and ActionType must be BOOK, RESCHEDULE, or CANCEL ((parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference').extension.where(url = 'receiveCorrespondence').value = true) implies ((parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'BOOK') or (parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'RESCHEDULE') or (parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'CANCEL')) ) |
2. Parameters.id | |
Short | Correspondance Id |
Control | 1..? |
4. Parameters.meta | |
6. Parameters.meta.source | |
Short | HealthCare System id. Used to route form response |
Control | 1..? |
8. Parameters.parameter | |
Short | AddCommunication parameters |
Control | 1..? |
Slicing | This element introduces a set of slices on Parameters.parameter . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
10. Parameters.parameter:invitation | |
Slice Name | invitation |
Short | Parameter for InvitationCommunicationRequest |
Control | 0..* |
12. Parameters.parameter:invitation.resource | |
Type | CommunicationRequest(Invitation CommunicationRequest) |
14. Parameters.parameter:reminder | |
Slice Name | reminder |
Short | Parameter for ReminderCommunicationRequest |
Control | 0..* |
16. Parameters.parameter:reminder.resource | |
Type | CommunicationRequest(Reminder CommunicationRequest) |
18. Parameters.parameter:invitation_appointment | |
Slice Name | invitation_appointment |
Short | Parameter for InvitationAppointment |
Control | 0..* |
20. Parameters.parameter:invitation_appointment.resource | |
Type | Appointment(Invitation Appointment) |
22. Parameters.parameter:reminder_appointment | |
Slice Name | reminder_appointment |
Short | Parameter for ReminderAppointment |
Control | 0..* |
24. Parameters.parameter:reminder_appointment.resource | |
Type | Appointment(Reminder Appointment) |
26. Parameters.parameter:patient | |
Slice Name | patient |
Short | Parameter for Patient |
Control | 0..* |
28. Parameters.parameter:patient.resource | |
Type | Patient(Patient) |
30. Parameters.parameter:relatedperson | |
Slice Name | relatedperson |
Short | Parameter for RelatedPerson |
Control | 0..* |
32. Parameters.parameter:relatedperson.resource | |
Type | RelatedPerson(RelatedPerson) |
34. Parameters.parameter:practitioner | |
Slice Name | practitioner |
Short | Parameter for Practitioner |
Control | 0..* |
36. Parameters.parameter:practitioner.resource | |
Type | Practitioner(Practitioner) |
38. Parameters.parameter:healthcareservice | |
Slice Name | healthcareservice |
Short | Parameter for HealthcareService |
Control | 0..* |
40. Parameters.parameter:healthcareservice.resource | |
Type | HealthcareService(HealthCareService) |
42. Parameters.parameter:location | |
Slice Name | location |
Short | Parameter for Location |
Control | 0..* |
44. Parameters.parameter:location.resource | |
Type | Location(Location) |
46. Parameters.parameter:othercommunication | |
Slice Name | othercommunication |
Short | Parameter for OtherCommunicationRequest |
Control | 0..* |
48. Parameters.parameter:othercommunication.resource | |
Type | CommunicationRequest(Other CommunicationRequest) |
Guidance on how to interpret the contents of this table can be found here
0. Parameters | |
Definition | This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources. |
Short | Operation Request or Response |
Comments | The parameters that may be used are defined by the OperationDefinition resource. |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | check-allowed-receivecorrespondence-variants: If receiveCorrespondence is true, VisitType must be NEW and ActionType must be BOOK, RESCHEDULE, or CANCEL ((parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference').extension.where(url = 'receiveCorrespondence').value = true) implies ((parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'BOOK') or (parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'RESCHEDULE') or (parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').exists() and parameter.where(resource is Appointment).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType').value = 'NEW' and parameter.where(resource is CommunicationRequest).resource.extension.where(url = 'http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType').value = 'CANCEL')) ) |
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 | Correspondance Id |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 1..1 |
Type | id |
Is Modifier | false |
Must Support | 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 |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. 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. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
8. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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.meta.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
10. 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. |
Short | Version specific identifier |
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. |
Control | 0..1 |
Type | id |
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()) ) |
12. Parameters.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Short | When the resource version last changed |
Comments | This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. 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. |
Control | 0..1 |
Type | instant |
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()) ) |
14. 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. |
Short | HealthCare System id. Used to route form response |
Comments | The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. 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. |
Control | 1..1 |
Type | uri |
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.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. |
Short | Profiles this resource claims to conform to |
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. |
Control | 0..* |
Type | canonical(StructureDefinition) |
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()) ) |
18. Parameters.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Short | Security Labels applied to this resource |
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. |
Control | 0..* |
Binding | Unless not suitable, these codes SHALL be taken from AllSecurityLabels (extensible to http://hl7.org/fhir/ValueSet/security-labels )Security Labels from the Healthcare Privacy and Security Classification System. |
Type | Coding |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. 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. |
Short | Tags applied to this resource |
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. |
Control | 0..* |
Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags )Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Type | Coding |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. 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 its 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 its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. 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 SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. Parameters.parameter | |
Definition | A parameter passed to or received from the operation. |
Short | AddCommunication parameters |
Control | 1..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
Slicing | This element introduces a set of slices on Parameters.parameter . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. 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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
30. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
32. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
34. 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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
36. Parameters.parameter.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. Parameters.parameter.resource | |
Definition | Conveys the content 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 its general resource resolution methods. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | true |
40. Parameters.parameter.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. Parameters.parameter:invitation | |
Slice Name | invitation |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for InvitationCommunicationRequest |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
44. Parameters.parameter:invitation.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
46. Parameters.parameter:invitation.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
48. Parameters.parameter:invitation.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
50. Parameters.parameter:invitation.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. Parameters.parameter:invitation.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. Parameters.parameter:invitation.resource | |
Definition | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. |
Short | A request for information to be sent to a receiver |
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 its general resource resolution methods. |
Control | 0..1 |
Type | CommunicationRequest(Invitation CommunicationRequest) |
Is Modifier | false |
Must Support | false |
Summary | false |
56. Parameters.parameter:invitation.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. Parameters.parameter:reminder | |
Slice Name | reminder |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for ReminderCommunicationRequest |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
60. Parameters.parameter:reminder.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
62. Parameters.parameter:reminder.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
64. Parameters.parameter:reminder.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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:reminder.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. Parameters.parameter:reminder.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. Parameters.parameter:reminder.resource | |
Definition | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. |
Short | A request for information to be sent to a receiver |
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 its general resource resolution methods. |
Control | 0..1 |
Type | CommunicationRequest(Reminder CommunicationRequest) |
Is Modifier | false |
Must Support | false |
Summary | false |
72. Parameters.parameter:reminder.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
74. Parameters.parameter:invitation_appointment | |
Slice Name | invitation_appointment |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for InvitationAppointment |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
76. Parameters.parameter:invitation_appointment.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
78. Parameters.parameter:invitation_appointment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
80. Parameters.parameter:invitation_appointment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
82. Parameters.parameter:invitation_appointment.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
84. Parameters.parameter:invitation_appointment.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
86. Parameters.parameter:invitation_appointment.resource | |
Definition | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
Short | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) |
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 its general resource resolution methods. |
Control | 0..1 |
Type | Appointment(Invitation Appointment) |
Is Modifier | false |
Must Support | false |
Summary | false |
88. Parameters.parameter:invitation_appointment.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. Parameters.parameter:reminder_appointment | |
Slice Name | reminder_appointment |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for ReminderAppointment |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
92. Parameters.parameter:reminder_appointment.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
94. Parameters.parameter:reminder_appointment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
96. Parameters.parameter:reminder_appointment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
98. Parameters.parameter:reminder_appointment.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
100. Parameters.parameter:reminder_appointment.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
102. Parameters.parameter:reminder_appointment.resource | |
Definition | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
Short | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) |
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 its general resource resolution methods. |
Control | 0..1 |
Type | Appointment(Reminder Appointment) |
Is Modifier | false |
Must Support | false |
Summary | false |
104. Parameters.parameter:reminder_appointment.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
106. Parameters.parameter:patient | |
Slice Name | patient |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for Patient |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
108. Parameters.parameter:patient.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
110. Parameters.parameter:patient.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
112. Parameters.parameter:patient.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
114. Parameters.parameter:patient.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
116. Parameters.parameter:patient.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
118. Parameters.parameter:patient.resource | |
Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
Short | Information about an individual or animal receiving health care services |
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 its general resource resolution methods. |
Control | 0..1 |
Type | Patient(Patient) |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | SubjectOfCare Client Resident |
120. Parameters.parameter:patient.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
122. Parameters.parameter:relatedperson | |
Slice Name | relatedperson |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for RelatedPerson |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
124. Parameters.parameter:relatedperson.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
126. Parameters.parameter:relatedperson.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
128. Parameters.parameter:relatedperson.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
130. Parameters.parameter:relatedperson.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
132. Parameters.parameter:relatedperson.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
134. Parameters.parameter:relatedperson.resource | |
Definition | Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. |
Short | A person that is related to a patient, but who is not a direct target of care |
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 its general resource resolution methods. |
Control | 0..1 |
Type | RelatedPerson(RelatedPerson) |
Is Modifier | false |
Must Support | false |
Summary | false |
136. Parameters.parameter:relatedperson.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
138. Parameters.parameter:practitioner | |
Slice Name | practitioner |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for Practitioner |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
140. Parameters.parameter:practitioner.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
142. Parameters.parameter:practitioner.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
144. Parameters.parameter:practitioner.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
146. Parameters.parameter:practitioner.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
148. Parameters.parameter:practitioner.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
150. Parameters.parameter:practitioner.resource | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare or related services. |
Short | A person with a formal responsibility in the provisioning of healthcare or related services |
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 its general resource resolution methods. |
Control | 0..1 |
Type | Practitioner(Practitioner) |
Is Modifier | false |
Must Support | false |
Summary | false |
152. Parameters.parameter:practitioner.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
154. Parameters.parameter:healthcareservice | |
Slice Name | healthcareservice |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for HealthcareService |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
156. Parameters.parameter:healthcareservice.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
158. Parameters.parameter:healthcareservice.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
160. Parameters.parameter:healthcareservice.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
162. Parameters.parameter:healthcareservice.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
164. Parameters.parameter:healthcareservice.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
166. Parameters.parameter:healthcareservice.resource | |
Definition | The details of a healthcare service available at a location. |
Short | The details of a healthcare service available at a location |
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 its general resource resolution methods. |
Control | 0..1 |
Type | HealthcareService(HealthCareService) |
Is Modifier | false |
Must Support | false |
Summary | false |
168. Parameters.parameter:healthcareservice.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
170. Parameters.parameter:location | |
Slice Name | location |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for Location |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
172. Parameters.parameter:location.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
174. Parameters.parameter:location.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
176. Parameters.parameter:location.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
178. Parameters.parameter:location.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
180. Parameters.parameter:location.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
182. Parameters.parameter:location.resource | |
Definition | Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
Short | Details and position information for a place |
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 its general resource resolution methods. |
Control | 0..1 |
Type | Location(Location) |
Is Modifier | false |
Must Support | false |
Summary | false |
184. Parameters.parameter:location.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
186. Parameters.parameter:othercommunication | |
Slice Name | othercommunication |
Definition | A parameter passed to or received from the operation. |
Short | Parameter for OtherCommunicationRequest |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
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())) ) |
188. Parameters.parameter:othercommunication.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
190. Parameters.parameter:othercommunication.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
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() ) |
192. Parameters.parameter:othercommunication.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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() ) |
194. Parameters.parameter:othercommunication.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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
196. Parameters.parameter:othercommunication.value[x] | |
Definition | Conveys the content 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
[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 | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
198. Parameters.parameter:othercommunication.resource | |
Definition | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. |
Short | A request for information to be sent to a receiver |
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 its general resource resolution methods. |
Control | 0..1 |
Type | CommunicationRequest(Other CommunicationRequest) |
Is Modifier | false |
Must Support | false |
Summary | false |
200. Parameters.parameter:othercommunication.part | |
Definition | A named part of a multi-part parameter. |
Short | Named part of a multi-part parameter |
Control | 0..* This element is affected by the following invariants: inv-1 |
Type | Seettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |