Patient Request for Corrections Implementation Guide, published by HL7 International - Patient Empowerment Workgroup. This is not an authorized publication; it is the continuous build for version 1.0.0). 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
Official URL: http://hl7.org/fhir/uv/patient-corrections/StructureDefinition/patient-correction-communication | Version: 1.0.0 | |||
Draft as of 2023-09-11 | Computable Name: PatientCorrectionCommunication |
A Communication between a patient and a fulfiller relating to a patient correction request.
This is the profile for the Patient Correction Communication, which is used for back and forth conversation about a patient’s request for correction to their medical record. Each Patient Correction Communication resource instance represents a message in the bidirectional conversation needed to complete a patient’s request for correction to their medical record or for logging their disagreement to a correction denial. This profile sets minimum expectations for the Communication resource to support this workflow. It is expected to be used in conjunction with the Patient Correction Task profile.
The following data-elements must always be present (Mandatory) definition]) or must be supported if the data is present (Must Support) definition). They are presented below in a simple human-readable explanation. Profile specific guidance is provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements. Refer to the Examples section of the guide for example resources provided in the context of an example workflow.
Each implementation of PatientCorrectionCommunication must provide:
id
: An idstatus
: fixed to “completed”category
: indicates whether it’s a “Request for Correction” or “Log Disagreement” processsubject
: the person whose record is to be correctedsender
: who is sending this communicationrecipient
: who is receiving this communicationsent
: date/time communication was sentabout
: When the initial Communication request for correction resource is created by the Requester, Communication.about will be empty. When the Fulfiller spawns a Task to support the request, the Fulfiller sets Communication.about
to reference the spawned Task that represents the entire request for correction or log disagreement process. On all other Communication resources, Communication.about
references the Communication resource that contained the initial request. When a Log Disagreement Task is created, the Fulfiller will update the Communication containing the Log Disagreement request such that Communication.about references the Log Disagreement Task as well as the original correction request Communication.topic
: a heading/subject line for the message being sent. Could be thought of as the subject line in an email thread.inResponseTo
: points to the prior Communication resource in a conversation thread.Payload
: contains the actual message being communicated, including any attachments or references.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
partOf | S | 0..1 | Reference(Patient Correction Communication) | Initial Patient Correction Communication resource for this request. |
inResponseTo | S | 0..1 | Reference(Patient Correction Communication) | Reply to |
status | 1..1 | code | Fixed: completed. Required Pattern: completed | |
category | S | 1..1 | CodeableConcept | Message category Binding: Patient Correction Communication Types Value Set (required) |
subject | S | 1..1 | Reference(Patient) | The Patient that the correction request or the log disagreement applies to. |
topic | S | 0..1 | CodeableConcept | A heading/subject line for the message being sent. |
Slices for about | 0..* | Reference(Resource) | Resources that pertain to this communication Slice: Unordered, Open by type:reference | |
about:correctionTask | S | 0..1 | Reference(Patient Correction Task) | Patient Correction Task requesting a correction. |
sent | 1..1 | dateTime | When this communication was sent | |
recipient | S | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService) | Message recipient: either a Requestor or a Fulfiller |
sender | S | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | HealthcareService) | Message sender: either a Requestor or a Fulfiller |
payload | S | 0..* | BackboneElement | Contents of this communication. |
note | 0..* | Annotation | Non-actionable notes about this communication. | |
Documentation for this format |
Path | Conformance | ValueSet |
Communication.category | required | PatientCorrectionCommunicationTypesVS |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
partOf | SΣ | 0..1 | Reference(Patient Correction Communication) | Initial Patient Correction Communication resource for this request. |
inResponseTo | S | 0..1 | Reference(Patient Correction Communication) | Reply to |
status | ?!Σ | 1..1 | code | Fixed: completed. Binding: EventStatus (required): The status of the communication. Required Pattern: completed |
category | S | 1..1 | CodeableConcept | Message category Binding: Patient Correction Communication Types Value Set (required) |
subject | SΣ | 1..1 | Reference(Patient) | The Patient that the correction request or the log disagreement applies to. |
topic | S | 0..1 | CodeableConcept | A heading/subject line for the message being sent. Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. |
Slices for about | 0..* | Reference(Resource) | Resources that pertain to this communication Slice: Unordered, Open by type:reference | |
about:correctionTask | S | 0..1 | Reference(Patient Correction Task) | Patient Correction Task requesting a correction. |
sent | 1..1 | dateTime | When this communication was sent | |
recipient | S | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService) | Message recipient: either a Requestor or a Fulfiller |
sender | S | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | HealthcareService) | Message sender: either a Requestor or a Fulfiller |
payload | S | 0..* | BackboneElement | Contents of this communication. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | 1..1 | Message part content | ||
contentString | string | |||
contentAttachment | Attachment | |||
contentReference | Reference(Resource) | |||
note | 0..* | Annotation | Non-actionable notes about this communication. | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Communication.status | required | Pattern: completed |
Communication.category | required | PatientCorrectionCommunicationTypesVS |
Communication.topic | example | CommunicationTopic |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique identifier | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
partOf | SΣ | 0..1 | Reference(Patient Correction Communication) | Initial Patient Correction Communication resource for this request. | ||||
inResponseTo | S | 0..1 | Reference(Patient Correction Communication) | Reply to | ||||
status | ?!Σ | 1..1 | code | Fixed: completed. Binding: EventStatus (required): The status of the communication. Required Pattern: completed | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
category | S | 1..1 | CodeableConcept | Message category Binding: Patient Correction Communication Types Value Set (required) | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
subject | SΣ | 1..1 | Reference(Patient) | The Patient that the correction request or the log disagreement applies to. | ||||
topic | S | 0..1 | CodeableConcept | A heading/subject line for the message being sent. Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | ||||
Slices for about | 0..* | Reference(Resource) | Resources that pertain to this communication Slice: Unordered, Open by type:reference | |||||
about:correctionTask | S | 0..1 | Reference(Patient Correction Task) | Patient Correction Task requesting a correction. | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
sent | 1..1 | dateTime | When this communication was sent | |||||
received | 0..1 | dateTime | When received | |||||
recipient | S | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService) | Message recipient: either a Requestor or a Fulfiller | ||||
sender | S | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | HealthcareService) | Message sender: either a Requestor or a Fulfiller | ||||
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
payload | S | 0..* | BackboneElement | Contents of this communication. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
content[x] | 1..1 | Message part content | ||||||
contentString | string | |||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(Resource) | |||||||
note | 0..* | Annotation | Non-actionable notes about this communication. | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Communication.language | preferred | CommonLanguages
| ||||
Communication.status | required | Pattern: completed | ||||
Communication.statusReason | example | CommunicationNotDoneReason | ||||
Communication.category | required | PatientCorrectionCommunicationTypesVS | ||||
Communication.priority | required | RequestPriority | ||||
Communication.medium | example | ParticipationMode | ||||
Communication.topic | example | CommunicationTopic | ||||
Communication.reasonCode | example | SNOMEDCTClinicalFindings |
This structure is derived from Communication
Summary
Mandatory: 5 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
partOf | S | 0..1 | Reference(Patient Correction Communication) | Initial Patient Correction Communication resource for this request. |
inResponseTo | S | 0..1 | Reference(Patient Correction Communication) | Reply to |
status | 1..1 | code | Fixed: completed. Required Pattern: completed | |
category | S | 1..1 | CodeableConcept | Message category Binding: Patient Correction Communication Types Value Set (required) |
subject | S | 1..1 | Reference(Patient) | The Patient that the correction request or the log disagreement applies to. |
topic | S | 0..1 | CodeableConcept | A heading/subject line for the message being sent. |
Slices for about | 0..* | Reference(Resource) | Resources that pertain to this communication Slice: Unordered, Open by type:reference | |
about:correctionTask | S | 0..1 | Reference(Patient Correction Task) | Patient Correction Task requesting a correction. |
sent | 1..1 | dateTime | When this communication was sent | |
recipient | S | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService) | Message recipient: either a Requestor or a Fulfiller |
sender | S | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | HealthcareService) | Message sender: either a Requestor or a Fulfiller |
payload | S | 0..* | BackboneElement | Contents of this communication. |
note | 0..* | Annotation | Non-actionable notes about this communication. | |
Documentation for this format |
Path | Conformance | ValueSet |
Communication.category | required | PatientCorrectionCommunicationTypesVS |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
partOf | SΣ | 0..1 | Reference(Patient Correction Communication) | Initial Patient Correction Communication resource for this request. |
inResponseTo | S | 0..1 | Reference(Patient Correction Communication) | Reply to |
status | ?!Σ | 1..1 | code | Fixed: completed. Binding: EventStatus (required): The status of the communication. Required Pattern: completed |
category | S | 1..1 | CodeableConcept | Message category Binding: Patient Correction Communication Types Value Set (required) |
subject | SΣ | 1..1 | Reference(Patient) | The Patient that the correction request or the log disagreement applies to. |
topic | S | 0..1 | CodeableConcept | A heading/subject line for the message being sent. Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. |
Slices for about | 0..* | Reference(Resource) | Resources that pertain to this communication Slice: Unordered, Open by type:reference | |
about:correctionTask | S | 0..1 | Reference(Patient Correction Task) | Patient Correction Task requesting a correction. |
sent | 1..1 | dateTime | When this communication was sent | |
recipient | S | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService) | Message recipient: either a Requestor or a Fulfiller |
sender | S | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | HealthcareService) | Message sender: either a Requestor or a Fulfiller |
payload | S | 0..* | BackboneElement | Contents of this communication. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
content[x] | 1..1 | Message part content | ||
contentString | string | |||
contentAttachment | Attachment | |||
contentReference | Reference(Resource) | |||
note | 0..* | Annotation | Non-actionable notes about this communication. | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Communication.status | required | Pattern: completed |
Communication.category | required | PatientCorrectionCommunicationTypesVS |
Communication.topic | example | CommunicationTopic |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique identifier | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
partOf | SΣ | 0..1 | Reference(Patient Correction Communication) | Initial Patient Correction Communication resource for this request. | ||||
inResponseTo | S | 0..1 | Reference(Patient Correction Communication) | Reply to | ||||
status | ?!Σ | 1..1 | code | Fixed: completed. Binding: EventStatus (required): The status of the communication. Required Pattern: completed | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
category | S | 1..1 | CodeableConcept | Message category Binding: Patient Correction Communication Types Value Set (required) | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
subject | SΣ | 1..1 | Reference(Patient) | The Patient that the correction request or the log disagreement applies to. | ||||
topic | S | 0..1 | CodeableConcept | A heading/subject line for the message being sent. Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | ||||
Slices for about | 0..* | Reference(Resource) | Resources that pertain to this communication Slice: Unordered, Open by type:reference | |||||
about:correctionTask | S | 0..1 | Reference(Patient Correction Task) | Patient Correction Task requesting a correction. | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
sent | 1..1 | dateTime | When this communication was sent | |||||
received | 0..1 | dateTime | When received | |||||
recipient | S | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService) | Message recipient: either a Requestor or a Fulfiller | ||||
sender | S | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | HealthcareService) | Message sender: either a Requestor or a Fulfiller | ||||
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
payload | S | 0..* | BackboneElement | Contents of this communication. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
content[x] | 1..1 | Message part content | ||||||
contentString | string | |||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(Resource) | |||||||
note | 0..* | Annotation | Non-actionable notes about this communication. | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Communication.language | preferred | CommonLanguages
| ||||
Communication.status | required | Pattern: completed | ||||
Communication.statusReason | example | CommunicationNotDoneReason | ||||
Communication.category | required | PatientCorrectionCommunicationTypesVS | ||||
Communication.priority | required | RequestPriority | ||||
Communication.medium | example | ParticipationMode | ||||
Communication.topic | example | CommunicationTopic | ||||
Communication.reasonCode | example | SNOMEDCTClinicalFindings |
This structure is derived from Communication
Summary
Mandatory: 5 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron