AddCommunication Implementation Guide
2.2 - version 2.2

This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Reminder CommunicationRequest

Official URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/ReminderCommunicationRequest Version: 2.2
Draft as of 2025-02-04 Computable Name: ReminderCommunicationRequest

Resource to hold information about reminders.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
reminder-scheduled-at-utc-future-date: Reminder scheduledAtUtc date must be today or in the future
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... ScheduledAtUtc 1..1 dateTime Date for reminder to be sent
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 1..1 Identifier Reference Id
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code The status of the communication request
Binding: RequestStatus (required): The status of the communication request.


ele-1: All FHIR elements must have a @value or children
... intent ?!Σ 1..1 code The intent of the communication request
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.


ele-1: All FHIR elements must have a @value or children
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
ele-1: All FHIR elements must have a @value or children
... subject 1..1 Reference(Patient) Reference to the Patient
ele-1: All FHIR elements must have a @value or children
... about 1..1 Reference(Reminder Appointment) Reference to Appointment
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
CommunicationRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
reminder-scheduled-at-utc-future-dateerrorCommunicationRequestReminder scheduledAtUtc date must be today or in the future
: extension('http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate').value >= today().toDateTime()

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
reminder-scheduled-at-utc-future-date: Reminder scheduledAtUtc date must be today or in the future
... meta
.... versionId 1..1 id Version Id must be included if sending more than one Reminder per bundle
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... ScheduledAtUtc 1..1 dateTime Date for reminder to be sent
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate
... identifier 1..1 Identifier Reference Id
... intent 1..1 code The intent of the communication request
... subject 1..1 Reference(Patient) Reference to the Patient
... about 1..1 Reference(Reminder Appointment) Reference to Appointment

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
reminder-scheduled-at-utc-future-dateerrorCommunicationRequestReminder scheduledAtUtc date must be today or in the future
: extension('http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate').value >= today().toDateTime()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
reminder-scheduled-at-utc-future-date: Reminder scheduledAtUtc date must be today or in the future
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 1..1 id Version Id must be included if sending more than one Reminder per bundle
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... ScheduledAtUtc 1..1 dateTime Date for reminder to be sent
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Reference Id
... basedOn Σ 0..* Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code The status of the communication request
Binding: RequestStatus (required): The status of the communication request.

... statusReason 0..1 CodeableConcept Reason for current status
Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request.

... intent ?!Σ 1..1 code The intent of the communication request
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.

... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.

... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject 1..1 Reference(Patient) Reference to the Patient
... about 1..1 Reference(Reminder Appointment) Reference to Appointment
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created
... payload 0..* BackboneElement Message payload
.... 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
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... contentCodeableConcept CodeableConcept
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who asks for the information to be shared
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint) Who to share the information with
... informationProvider Σ 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) Who should share the information
... reason Σ 0..* CodeableReference(Resource) Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
CommunicationRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
CommunicationRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
CommunicationRequest.statusReasonexampleCommunicationRequestStatusReason
http://hl7.org/fhir/ValueSet/communication-request-status-reason
from the FHIR Standard
CommunicationRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
CommunicationRequest.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
CommunicationRequest.mediumexampleParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.reasonexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
reminder-scheduled-at-utc-future-dateerrorCommunicationRequestReminder scheduledAtUtc date must be today or in the future
: extension('http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate').value >= today().toDateTime()

This structure is derived from CommunicationRequest

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
reminder-scheduled-at-utc-future-date: Reminder scheduledAtUtc date must be today or in the future
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... ScheduledAtUtc 1..1 dateTime Date for reminder to be sent
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 1..1 Identifier Reference Id
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code The status of the communication request
Binding: RequestStatus (required): The status of the communication request.


ele-1: All FHIR elements must have a @value or children
... intent ?!Σ 1..1 code The intent of the communication request
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.


ele-1: All FHIR elements must have a @value or children
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
ele-1: All FHIR elements must have a @value or children
... subject 1..1 Reference(Patient) Reference to the Patient
ele-1: All FHIR elements must have a @value or children
... about 1..1 Reference(Reminder Appointment) Reference to Appointment
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
CommunicationRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
reminder-scheduled-at-utc-future-dateerrorCommunicationRequestReminder scheduledAtUtc date must be today or in the future
: extension('http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate').value >= today().toDateTime()

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
reminder-scheduled-at-utc-future-date: Reminder scheduledAtUtc date must be today or in the future
... meta
.... versionId 1..1 id Version Id must be included if sending more than one Reminder per bundle
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... ScheduledAtUtc 1..1 dateTime Date for reminder to be sent
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate
... identifier 1..1 Identifier Reference Id
... intent 1..1 code The intent of the communication request
... subject 1..1 Reference(Patient) Reference to the Patient
... about 1..1 Reference(Reminder Appointment) Reference to Appointment

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
reminder-scheduled-at-utc-future-dateerrorCommunicationRequestReminder scheduledAtUtc date must be today or in the future
: extension('http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate').value >= today().toDateTime()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
reminder-scheduled-at-utc-future-date: Reminder scheduledAtUtc date must be today or in the future
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 1..1 id Version Id must be included if sending more than one Reminder per bundle
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... ScheduledAtUtc 1..1 dateTime Date for reminder to be sent
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Reference Id
... basedOn Σ 0..* Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code The status of the communication request
Binding: RequestStatus (required): The status of the communication request.

... statusReason 0..1 CodeableConcept Reason for current status
Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request.

... intent ?!Σ 1..1 code The intent of the communication request
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.

... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.

... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject 1..1 Reference(Patient) Reference to the Patient
... about 1..1 Reference(Reminder Appointment) Reference to Appointment
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created
... payload 0..* BackboneElement Message payload
.... 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
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... contentCodeableConcept CodeableConcept
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who asks for the information to be shared
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint) Who to share the information with
... informationProvider Σ 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) Who should share the information
... reason Σ 0..* CodeableReference(Resource) Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
CommunicationRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
CommunicationRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
CommunicationRequest.statusReasonexampleCommunicationRequestStatusReason
http://hl7.org/fhir/ValueSet/communication-request-status-reason
from the FHIR Standard
CommunicationRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
CommunicationRequest.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
CommunicationRequest.mediumexampleParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.reasonexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
reminder-scheduled-at-utc-future-dateerrorCommunicationRequestReminder scheduledAtUtc date must be today or in the future
: extension('http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReminderScheduledAtUtcDate').value >= today().toDateTime()

This structure is derived from CommunicationRequest

 

Other representations of profile: CSV, Excel, Schematron