Generated Narrative: StructureDefinition CommunicationParameters Name Flags Card. Type Description & Constraints Parameters C 0..* Parameters Operation Request or Response check-allowed-receivecorrespondence-variants: If receiveCorrespondence is true, VisitType must be NEW and ActionType must be BOOK, RESCHEDULE, or CANCEL id 1..1 id Correspondance Id meta source 1..1 uri HealthCare System id. Used to route form response Slices for parameter 1..* BackboneElement AddCommunication parameters Slice: Unordered, Open by profile:resource parameter:invitation 0..* BackboneElement Parameter for InvitationCommunicationRequest resource 0..1 InvitationCommunicationRequest A request for information to be sent to a receiver parameter:reminder 0..* BackboneElement Parameter for ReminderCommunicationRequest resource 0..1 ReminderCommunicationRequest A request for information to be sent to a receiver parameter:invitation_appointment 0..* BackboneElement Parameter for InvitationAppointment resource 0..1 InvitationAppointment 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) parameter:reminder_appointment 0..* BackboneElement Parameter for ReminderAppointment resource 0..1 ReminderAppointment 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) parameter:patient 0..* BackboneElement Parameter for Patient resource 0..1 CommunicationPatient Information about an individual or animal receiving health care services parameter:relatedperson 0..* BackboneElement Parameter for RelatedPerson resource 0..1 CommunicationRelatedPerson A person that is related to a patient, but who is not a direct target of care parameter:practitioner 0..* BackboneElement Parameter for Practitioner resource 0..1 CommunicationPractitioner A person with a formal responsibility in the provisioning of healthcare or related services parameter:healthcareservice 0..* BackboneElement Parameter for HealthcareService resource 0..1 CommunicationHealthCareService The details of a healthcare service available at a location parameter:location 0..* BackboneElement Parameter for Location resource 0..1 CommunicationLocation Details and position information for a place parameter:othercommunication 0..* BackboneElement Parameter for OtherCommunicationRequest resource 0..1 OtherCommunicationRequest A request for information to be sent to a receiver Documentation for this format
Profile to hold all resources needed in the AddCommunication API
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.
The parameters that may be used are defined by the OperationDefinition resource.
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'))
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
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.
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.
When the resource last changed - e.g. when the version changed.
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](http://hl7.org/fhir/R5/http.html#read) interaction.
HealthCare System id. Used to route form response
A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R5/provenance.html#) 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.
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.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R5/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R5/structuredefinition-definitions.html#StructureDefinition.url).
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.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
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.
Security Labels from the Healthcare Privacy and Security Classification System.
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.
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.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
A set of rules under which this content was created
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.
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.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
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).
A parameter passed to or received from the operation.
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()))
Extensions that cannot be ignored even if unrecognized
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).
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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The name of the parameter (reference to the operation definition).
Conveys the content if the parameter is a data type.
Conveys the content if the parameter is a whole resource.
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.
Parameter for InvitationCommunicationRequest
A request for information to be sent to a receiver
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.
Parameter for ReminderCommunicationRequest
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)
Entity, Role, or Act,Act[@moodCode <= 'INT']
Information about an individual or animal receiving health care services
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Entity, Role, or Act,Patient[classCode=PAT]
A person that is related to a patient, but who is not a direct target of care
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.
A person with a formal responsibility in the provisioning of healthcare or related services
A person who is directly or indirectly involved in the provisioning of healthcare or related services.
The details of a healthcare service available at a location
Entity, Role, or Act,act[classCode=ACT][moodCode=DEF]
Details and position information for a place
Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Entity, Role, or Act,.Role[classCode=SDLC]