eHealth Infrastructure
2021.3.0 - build
eHealth Infrastructure
2021.3.0 - build
eHealth Infrastructure - Local Development build (v2021.3.0). See the Directory of published versions
| Defining URL: | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-request |
| Version: | 2021.3.0 |
| Name: | ehealth-communication-request |
| Status: | Active as of 2021-11-25T09:32:14+00:00 |
| Publisher: | Systematic | Trifork |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-request
The CommunicationRequest resource allows for change in the way eHealth automated processing creates Communication (of profile ehealth-message) as a result of a submitted measurement or lack thereof for a particular Patient and context.
In the eHealth Infrastructure, automated processing generates Communication (of profile ehealth-message) in the following cases:
By default, the Communication is created with recipient set to the one or more CareTeam associated with the CarePlan referencing the ProcedureRequest for which the measurement was made.
The CommunicationRequest is used to customize how and when Communications are created by automated processing:
If multiple CommunicationRequests for the same recipient are found, then only the newest is considered valid.
When automated processing creates Communication about a specific ProcedureRequest and Patient, the CareTeam is not set as recipient when a CommunicationRequest exists where:
basedOn references the ProcedureRequestrecipient references the CareTeamreasonCode matches the Communication reasonCode (of the Communication created for CareTeam).priority matches the Task priority (of the Task created for CareTeam).status is ‘suspended’Setting the status to any other value than ‘suspended’ disables the specified suppression of Communication with the CareTeam as recipient. The Communication is created with recipient set as the
remaining one or more CareTeam referenced from the CarePlan referencing the ProcedureRequest. In case no remaining CareTeam are referenced from the CarePlan, no Communication is created.
When automated processing creates Communication about a specific ProcedureRequest and Patient, additional Communication with the Patient as recipient is created if a CommunicationRequest exists where:
basedOn references the ProcedureRequestrecipient references the PatientreasonCode matches the Communication reasonCode (of the Communication created for CareTeam).priority matches the Task priority (of the Task created for CareTeam).status is ‘active’Setting the status to ‘suspended’ disables the specified creation of Communication with the Patient as recipient.
It is possible to use CommunicationRequest to override some default values of the Communication:
medium of the Communication (created for the Patient or Careteam) overrides the Communication medium (of the Communication created for CareTeam).payload of the Communication (created for the Patient) overrides the Communication payload (of the Communication created for CareTeam).A CommunicationRequest is related to Communication (ehealth-message), Task (ehealth-task), and ProcedureRequest (ehealth-procedureRequest).
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CommunicationRequest
This structure is derived from CommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |
  Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 workflow-episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare | |
 basedOn | 0..1 | Reference(Resource) | Fulfills plan or proposal | |
| category | 0..* | CodeableConcept | Message category Binding: MessageCategory (required) | |
| priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) | |
| medium | 0..* | CodeableConcept | A channel of communication Binding: MessageMedium (required) | |
 subject | 1..1 | Reference(Patient) | Focus of message | |
 recipient | 0..* | Reference(Patient | CareTeam) {r} | Message recipient | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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 | |
| workflow-episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Unique identifier |
| basedOn | Σ | 0..1 | 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 | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request. | |
| category | 0..* | CodeableConcept | Message category Binding: MessageCategory (required) | |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action |
| medium | 0..* | CodeableConcept | A channel of communication Binding: MessageMedium (required) | |
| subject | 1..1 | Reference(Patient) | Focus of message | |
| about | 0..* | Reference(Resource) | Resources that pertain to this communication request | |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
 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 | ||
 contentString | string | |||
| contentAttachment | Attachment | |||
| contentReference | Reference(Resource) | |||
| 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/what is requesting service |
| recipient | 0..* | Reference(Patient | CareTeam) {r} | Message recipient | |
| sender | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
| reasonCode | Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. |
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? |
| note | 0..* | Annotation | Comments made about communication request | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |
| Documentation for this format | ||||
This structure is derived from CommunicationRequest
Differential View
This structure is derived from CommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| workflow-episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare | |
| basedOn | 0..1 | Reference(Resource) | Fulfills plan or proposal | |
| category | 0..* | CodeableConcept | Message category Binding: MessageCategory (required) | |
| priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) | |
| medium | 0..* | CodeableConcept | A channel of communication Binding: MessageMedium (required) | |
| subject | 1..1 | Reference(Patient) | Focus of message | |
| recipient | 0..* | Reference(Patient | CareTeam) {r} | Message recipient | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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 | |
| workflow-episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Unique identifier |
| basedOn | Σ | 0..1 | 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 | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request. | |
| category | 0..* | CodeableConcept | Message category Binding: MessageCategory (required) | |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action |
| medium | 0..* | CodeableConcept | A channel of communication Binding: MessageMedium (required) | |
| subject | 1..1 | Reference(Patient) | Focus of message | |
| about | 0..* | Reference(Resource) | Resources that pertain to this communication request | |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| 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 | ||
| contentString | string | |||
| contentAttachment | Attachment | |||
| contentReference | Reference(Resource) | |||
| 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/what is requesting service |
| recipient | 0..* | Reference(Patient | CareTeam) {r} | Message recipient | |
| sender | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
| reasonCode | Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. |
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? |
| note | 0..* | Annotation | Comments made about communication request | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| CommunicationRequest.language | preferred | CommonLanguages Max Binding: AllLanguages |
| CommunicationRequest.status | required | RequestStatus |
| CommunicationRequest.statusReason | example | |
| CommunicationRequest.category | required | MessageCategory |
| CommunicationRequest.priority | required | RequestPriority |
| CommunicationRequest.medium | required | MessageMedium |
| CommunicationRequest.reasonCode | example | ActReason |
| Id | Path | Details | Requirements |
| dom-2 | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | CommunicationRequest | 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 | CommunicationRequest | 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 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | CommunicationRequest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.extension:episodeOfCare | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.extension:episodeOfCare | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.replaces | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.groupIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.doNotPerform | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.medium | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.about | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.payload.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.payload.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.payload.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.payload.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.payload.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.authoredOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.requester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2021+ Systematic | Trifork. Package dk.ehealth.sundhed.fhir.ig.core#2021.3.0 based on FHIR 4.0.1. Generated 2021-11-25
