Patient Request for Corrections Implementation Guide
1.0.0 - STU 1

Patient Request for Corrections Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-patient-correction/ and changes regularly. See the Directory of published versions

## Resource Profile: PatientCorrectionCommunication - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 1

Definitions for the patient-correction-communication resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Communication
2. Communication.partOf
Definition | The initial communication sent by a Requester for a record correction.
Short | Initial Patient Correction Communication resource for this request.
Comments | When creating an initial correct request, this element SHALL be empty. Subsequent communications in either direction (to or from the patient) SHALL populate this element with a reference to the original communication requesting a correction.
Control | 0..1
Type | Reference(Patient Correction Communication)
Must Support | true
4. Communication.inResponseTo
Comments | Patient Correction Request Communication that this is in response to. This will only be filled in if it represents a response to another Communication resource. It can be used to query and assemble conversation threads related to the request process.
Control | 0..1
Type | Reference(Patient Correction Communication)
Must Support | true
6. Communication.status
Short | Fixed: completed.
Pattern Value | `completed`
8. Communication.category
Control | 1..1
Binding | The codes SHALL be taken from Patient Correction Communication Types Value Set (required to `http://hl7.org/fhir/uv/patient-corrections/ValueSet/PatientCorrectionCommunicationTypesVS` )
Must Support | true
10. Communication.subject
Short | The Patient that the correction request or the log disagreement applies to.
Control | 1..?
Type | Reference(Patient)
Must Support | true
12. Communication.topic
Short | A heading/subject line for the message being sent.
Comments | Equivalent to the subject line in an email thread.
Must Support | true
14. Communication.about
Slicing | This element introduces a set of slices on `Communication.about`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ reference
16. Communication.about:correctionTask
Slice Name | correctionTask
Definition | A server-created Correction Task for servicing this correction request.
Short | Patient Correction Task requesting a correction.
Comments | When creating an initial correction request, this element SHALL be empty. If a processing system creates a Task resource related to a correction request, the server SHALL add a reference to that Task here. Any subsequent communication requests regarding the same correction request SHALL reference the relevant Task if present.
Control | 0..1
Type | Reference(Patient Correction Task)
Must Support | true
18. Communication.sent
Short | When this communication was sent
Comments | The date that this particular part of the conversation is sent. On the initial request from the Requestor for either correction or logging a disagreement, this date/time will be used as `Task.authoredOn` to signify when the process was initiated on the Fulfiller.
Control | 1..?
20. Communication.recipient
Short | Message recipient: either a Requestor or a Fulfiller
Comments | Depending on the direction of the patient correction communication, the recipient of the communication may be the Fulfiller or it may be the Requester.
Control | 1..?
Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
22. Communication.sender
Short | Message sender: either a Requestor or a Fulfiller
Comments | Depending on the direction of the patient correction communication, the sender of the communication may be the Requester or it may be the Fulfiller. If spawning a Task relating to an initial request (for either correction or logging of disagreement), the Fulfiller SHALL use this sender to represent the `Task.requester`.
Control | 1..?
Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization, HealthcareService)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
24. Communication.payload
Short | Contents of this communication.
Comments | The contents of this particular conversation component. If this is the original correction request or logging of a disagreement, then the payload would contain the request. If it is the final outcome of the request, then the payload would contain the final outcome information. Otherwise it contains a single message in back and forth conversation needed to process the initial request. Since it is possible to have a Communication resource reference a conversation held outside of the FHIR Rest protocol (email, mail, portal messaging - see Communication.channel) the minimum cardinality is zero. However, it is expected in most cases payload will be valued.
Must Support | true
26. Communication.note
Short | Non-actionable notes about this communication.
Comments | If there is NOT a Task created to work on a correction request, this element MAY contain notes from those that are working on a correction. Notes from Requestors SHOULD be placed into additional communications, so that Fulfillers review them. This element SHALL NOT contain actionable requests from either Requestors or Fulfillers.

Guidance on how to interpret the contents of this table can be foundhere

0. Communication
Definition | An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
Short | A record of information transmitted from a sender to a receiver
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Communication.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Communication.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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
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 resource that contains them
Summary | false
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
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())
6. Communication.partOf
Definition | The initial communication sent by a Requester for a record correction. Part of this action.
Short | Initial Patient Correction Communication resource for this request.Part of this action
Comments | When creating an initial correct request, this element SHALL be empty. Subsequent communications in either direction (to or from the patient) SHALL populate this element with a reference to the original communication requesting a correction.
Control | 0..1*
Type | Reference(Patient Correction Communication, Resource)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | container
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Communication.inResponseTo
Definition | Prior communication that this communication is in response to.
Short | Reply to
Comments | Patient Correction Request Communication that this is in response to. This will only be filled in if it represents a response to another Communication resource. It can be used to query and assemble conversation threads related to the request process.
Control | 0..1*
Type | Reference(Patient Correction Communication, Communication)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Communication.status
Definition | The status of the transmission.
Short | Fixed: completed.preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Comments | This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from EventStatus http://hl7.org/fhir/ValueSet/event-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/event-status|4.0.1` ) The status of the communication.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `completed`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Communication.category
Definition | The type of message conveyed such as alert, notification, reminder, instruction, etc.
Short | Message category
Comments | There may be multiple axes of categorization and one communication may serve multiple purposes.
Control | 10..1*
Binding | The codes SHALL be taken from For example codes, see Patient Correction Communication Types Value Set http://hl7.org/fhir/ValueSet/communication-category (required to `http://hl7.org/fhir/uv/patient-corrections/ValueSet/PatientCorrectionCommunicationTypesVS` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Communication.subject
Definition | The patient or group that was the focus of this communication.
Short | The Patient that the correction request or the log disagreement applies to.Focus of message
Control | 10..1
Type | Reference(Patient, Group)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Communication.topic
Definition | Description of the purpose/content, similar to a subject line in an email.
Short | A heading/subject line for the message being sent.Description of the purpose/content
Comments | Equivalent to the subject line in an email thread. Communication.topic.text can be used without any codings.
Control | 0..1
Binding | For example codes, see CommunicationTopic http://hl7.org/fhir/ValueSet/communication-topic (example to `http://hl7.org/fhir/ValueSet/communication-topic` ) Codes describing the purpose or content of the communication.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Communication.about
Definition | Other resources that pertain to this communication and to which this communication should be associated.
Short | Resources that pertain to this communication
Comments | Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.
Control | 0..*
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Communication.about`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ reference
20. Communication.about:correctionTask
Slice Name | correctionTask
Definition | A server-created Correction Task for servicing this correction request. Other resources that pertain to this communication and to which this communication should be associated.
Short | Patient Correction Task requesting a correction.Resources that pertain to this communication
Comments | When creating an initial correction request, this element SHALL be empty. If a processing system creates a Task resource related to a correction request, the server SHALL add a reference to that Task here. Any subsequent communication requests regarding the same correction request SHALL reference the relevant Task if present. Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.
Control | 0..1*
Type | Reference(Patient Correction Task, Resource)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Communication.sent
Definition | The time when this communication was sent.
Short | When this communication was sentWhen sent
Comments | The date that this particular part of the conversation is sent. On the initial request from the Requestor for either correction or logging a disagreement, this date/time will be used as `Task.authoredOn` to signify when the process was initiated on the Fulfiller.
Control | 10..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Communication.recipient
Definition | The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Short | Message recipient: either a Requestor or a Fulfiller
Comments | Depending on the direction of the patient correction communication, the recipient of the communication may be the Fulfiller or it may be the Requester.
Control | 10..*
Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Device, Group)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Communication.sender
Definition | The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
Short | Message sender: either a Requestor or a Fulfiller
Comments | Depending on the direction of the patient correction communication, the sender of the communication may be the Requester or it may be the Fulfiller. If spawning a Task relating to an initial request (for either correction or logging of disagreement), the Fulfiller SHALL use this sender to represent the `Task.requester`.
Control | 10..1
Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization, HealthcareService, Device)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Communication.payload
Definition | Text, attachment(s), or resource(s) that was communicated to the recipient.
Short | Contents of this communication.Message payload
Comments | The contents of this particular conversation component. If this is the original correction request or logging of a disagreement, then the payload would contain the request. If it is the final outcome of the request, then the payload would contain the final outcome information. Otherwise it contains a single message in back and forth conversation needed to process the initial request. Since it is possible to have a Communication resource reference a conversation held outside of the FHIR Rest protocol (email, mail, portal messaging - see Communication.channel) the minimum cardinality is zero. However, it is expected in most cases payload will be valued.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Communication.payload.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Communication.payload.content[x]
Definition | A communicated content (or for multi-part communications, one portion of the communication).
Short | Message part content
Control | 1..1
Type | Choice of: string, Attachment, Reference(Resource)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Communication.note
Definition | Additional notes or commentary about the communication by the sender, receiver or other interested parties.
Short | Non-actionable notes about this communication.Comments made about the communication
Comments | If there is NOT a Task created to work on a correction request, this element MAY contain notes from those that are working on a correction. Notes from Requestors SHOULD be placed into additional communications, so that Fulfillers review them. This element SHALL NOT contain actionable requests from either Requestors or Fulfillers.
Control | 0..*
Type | Annotation
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Communication
Definition | An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
Short | A record of information transmitted from a sender to a receiver
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. Communication.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. Communication.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Communication.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Communication.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Communication.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Communication.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Communication.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. Communication.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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
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 resource that contains them
Summary | false
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
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Communication.identifier
Definition | Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Short | Unique identifier
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Communication.instantiatesCanonical
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
Short | Instantiates FHIR protocol or definition
Control | 0..*
Type | canonical(PlanDefinition, ActivityDefinition, Measure, OperationDefinition, Questionnaire)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Communication.instantiatesUri
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
Short | Instantiates external protocol or definition
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
Control | 0..*
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())`)
24. Communication.basedOn
Definition | An order, proposal or plan fulfilled in whole or in part by this Communication.
Short | Request fulfilled by this communication
Comments | This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.
Control | 0..*
Type | Reference(Resource)
Is Modifier | false
Summary | true
Alternate Names | fulfills
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Communication.partOf
Definition | The initial communication sent by a Requester for a record correction.
Short | Initial Patient Correction Communication resource for this request.
Comments | When creating an initial correct request, this element SHALL be empty. Subsequent communications in either direction (to or from the patient) SHALL populate this element with a reference to the original communication requesting a correction.
Control | 0..1
Type | Reference(Patient Correction Communication)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | container
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Communication.inResponseTo
Definition | Prior communication that this communication is in response to.
Short | Reply to
Comments | Patient Correction Request Communication that this is in response to. This will only be filled in if it represents a response to another Communication resource. It can be used to query and assemble conversation threads related to the request process.
Control | 0..1
Type | Reference(Patient Correction Communication)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Communication.status
Definition | The status of the transmission.
Short | Fixed: completed.
Comments | This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from EventStatus (required to `http://hl7.org/fhir/ValueSet/event-status|4.0.1` ) The status of the communication.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `completed`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Communication.statusReason
Definition | Captures the reason for the current state of the Communication.
Short | Reason for current status
Comments | This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here.
Control | 0..1
Binding | For example codes, see CommunicationNotDoneReason (example to `http://hl7.org/fhir/ValueSet/communication-not-done-reason` ) Codes for the reason why a communication did not happen.
Type | CodeableConcept
Is Modifier | false
Summary | true
Alternate Names | Suspended Reason, Cancelled Reason
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Communication.category
Definition | The type of message conveyed such as alert, notification, reminder, instruction, etc.
Short | Message category
Comments | There may be multiple axes of categorization and one communication may serve multiple purposes.
Control | 1..1
Binding | The codes SHALL be taken from Patient Correction Communication Types Value Set (required to `http://hl7.org/fhir/uv/patient-corrections/ValueSet/PatientCorrectionCommunicationTypesVS` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Communication.priority
Definition | Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
Short | routine | urgent | asap | stat
Comments | Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) Codes indicating the relative importance of a communication.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Meaning if Missing | If missing, this communication should be treated with normal priority
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. Communication.medium
Definition | A channel that was used for this communication (e.g. email, fax).
Short | A channel of communication
Control | 0..*
Binding | For example codes, see ParticipationMode (example to `http://terminology.hl7.org/ValueSet/v3-ParticipationMode` ) Codes for communication mediums such as phone, fax, email, in person, etc.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Communication.subject
Definition | The patient or group that was the focus of this communication.
Short | The Patient that the correction request or the log disagreement applies to.
Control | 1..1
Type | Reference(Patient)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Communication.topic
Definition | Description of the purpose/content, similar to a subject line in an email.
Short | A heading/subject line for the message being sent.
Comments | Equivalent to the subject line in an email thread.
Control | 0..1
Binding | For example codes, see CommunicationTopic (example to `http://hl7.org/fhir/ValueSet/communication-topic` ) Codes describing the purpose or content of the communication.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Communication.about
Definition | Other resources that pertain to this communication and to which this communication should be associated.
Short | Resources that pertain to this communication
Comments | Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.
Control | 0..*
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Communication.about`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ reference
46. Communication.about:correctionTask
Slice Name | correctionTask
Definition | A server-created Correction Task for servicing this correction request.
Short | Patient Correction Task requesting a correction.
Comments | When creating an initial correction request, this element SHALL be empty. If a processing system creates a Task resource related to a correction request, the server SHALL add a reference to that Task here. Any subsequent communication requests regarding the same correction request SHALL reference the relevant Task if present.
Control | 0..1
Type | Reference(Patient Correction Task)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Communication.encounter
Definition | The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
Short | Encounter created as part of
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.
Control | 0..1
Type | Reference(Encounter)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Communication.sent
Definition | The time when this communication was sent.
Short | When this communication was sent
Comments | The date that this particular part of the conversation is sent. On the initial request from the Requestor for either correction or logging a disagreement, this date/time will be used as `Task.authoredOn` to signify when the process was initiated on the Fulfiller.
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Communication.received
Definition | The time when this communication arrived at the destination.
Short | When received
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Communication.recipient
Definition | The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Short | Message recipient: either a Requestor or a Fulfiller
Comments | Depending on the direction of the patient correction communication, the recipient of the communication may be the Fulfiller or it may be the Requester.
Control | 1..*
Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Communication.sender
Definition | The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
Short | Message sender: either a Requestor or a Fulfiller
Comments | Depending on the direction of the patient correction communication, the sender of the communication may be the Requester or it may be the Fulfiller. If spawning a Task relating to an initial request (for either correction or logging of disagreement), the Fulfiller SHALL use this sender to represent the `Task.requester`.
Control | 1..1
Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization, HealthcareService)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Communication.reasonCode
Definition | The reason or justification for the communication.
Short | Indication for message
Comments | Textual reasons can be captured using reasonCode.text.
Control | 0..*
Binding | For example codes, see SNOMEDCTClinicalFindings (example to `http://hl7.org/fhir/ValueSet/clinical-findings` ) Codes for describing reasons for the occurrence of a communication.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Communication.reasonReference
Definition | Indicates another resource whose existence justifies this communication.
Short | Why was communication done?
Control | 0..*
Type | Reference(Condition, Observation, DiagnosticReport, DocumentReference)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Communication.payload
Definition | Text, attachment(s), or resource(s) that was communicated to the recipient.
Short | Contents of this communication.
Comments | The contents of this particular conversation component. If this is the original correction request or logging of a disagreement, then the payload would contain the request. If it is the final outcome of the request, then the payload would contain the final outcome information. Otherwise it contains a single message in back and forth conversation needed to process the initial request. Since it is possible to have a Communication resource reference a conversation held outside of the FHIR Rest protocol (email, mail, portal messaging - see Communication.channel) the minimum cardinality is zero. However, it is expected in most cases payload will be valued.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Communication.payload.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
66. Communication.payload.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
68. Communication.payload.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
70. Communication.payload.content[x]
Definition | A communicated content (or for multi-part communications, one portion of the communication).
Short | Message part content
Control | 1..1
Type | Choice of: string, Attachment, Reference(Resource)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Communication.note
Definition | Additional notes or commentary about the communication by the sender, receiver or other interested parties.
Short | Non-actionable notes about this communication.
Comments | If there is NOT a Task created to work on a correction request, this element MAY contain notes from those that are working on a correction. Notes from Requestors SHOULD be placed into additional communications, so that Fulfillers review them. This element SHALL NOT contain actionable requests from either Requestors or Fulfillers.
Control | 0..*
Type | Annotation
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)