eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 10.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions
| Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication | Version: 10.0.0 | |||
| Active as of 2026-08-05 | Computable Name: ehealth-carecommunication | |||
An Ehealth-CareCommunication is an FUT abstraction of a MedCom CareCommunication. This is needed to support communication through the VANS network with parties outside the FUT infrastructure, as well as inside FUT. The Ehealth-CareCommunication's primary feature is to enable communication in relation to several images of different file types.
The following custom search parameters may be used when searching for ehealth-CareCommunication instances:
In the eHealth Infrastructure the ehealth-CareCommunication resource is used in conjunction with the following resources:
note on sender: The sender of a message is structured as a complex extension, holding a reference to the sending PractitionerRole, the linked Practitioner and optional CareTeam. If a CareTeam is present, that CareTeam is considered the specific sender, not the PractitionerRole. PractitionerRole is still required, since every message has to have a PractitionerRole representing that message.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver Constraints: stopped-status-statusReason, only-asap-or-routine, topic-required-when-category-other, priority-category-invariant, atLeastOnePayloadString, payloadAttachment-contentType-required, no-standard-sender, sender-required-based-on-messagetype, sender-contactPoint-required-based-on-messagetype, reply-requires-inResponseTo, forward-prohibits-inResponseTo |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Sender Extension, contains the sending PractitionerRole, Practitioner and CareTeam. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization receiving the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-destination |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Reference to the sending organization of the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-origin |
![]() ![]() ![]() |
S | 1..1 | Coding | Message type URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type Binding: Message Type ValueSet (required) |
![]() ![]() ![]() |
1..1 | Coding | The administrative status of how a message recipient has handled a message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status Binding: Administrative Status (required) | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..2 | Identifier | Unique identifier Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣC | 1..1 | Identifier | The communication identifier Constraints: uuidv4 |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/id/ehealth-carecommunication-identifier |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | UUID v4 in URN form (urn:uuid:<uuid>) Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | The ID of the originating MessageHeader resource |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/fhir/system/medcom-message-header-id |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
S | 0..1 | Reference(Communication) | references the Ehealth-CareCommunication Communication.id, which this message is a response to. |
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: eHealth CareCommunication Categories (required) |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://ehealth.sundhed.dk/cs/ehealth-carecommunication-category |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
SΣ | 0..1 | code | Only used when the category is 'regarding referral', see priority-category-invariant. Binding: eHealth CareCommunication Priorities (required) |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Focus of message |
![]() ![]() |
S | 0..1 | CodeableConcept | Must be added when category is "other". Topic must be added in the text-element. Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. |
![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept. |
![]() ![]() |
SΣ | 0..1 | Reference(Encounter) | Shall contain a reference to an Encounter resource with a episodeOfCare-identifier, if the identifier is included in a previous message. |
![]() ![]() |
S | 0..1 | Reference(CareTeam | PractitionerRole) | The recieving actor of the message |
![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | string | Message part content Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Message part content |
![]() ![]() ![]() |
0..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Message part content |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | The content type shall be present when the content is an attachment included in the data element. Binding: eHealth CareCommunication Attachment MIME Types (required) Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Shall be present and contain the base64 encoded content of the attachment. |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Shall be present if the attachment is a link to a web page. Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Note: it is not allowed for the system to automatically include '.filetype' in the title. Example General: Official Corporate Logo |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time the attachment was created |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.identifier:communicationId.use | Base | required | IdentifierUse | 📦4.0.1 | FHIR Std. |
| Communication.identifier:messageHeaderId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | required | eHealth CareCommunication Categories | 📦10.0.0 | This IG |
| Communication.priority | Base | required | eHealth CareCommunication Priorities | 📦10.0.0 | This IG |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment.content[x].contentType | Base | required | eHealth CareCommunication Attachment MIME Types | 📦10.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| atLeastOnePayloadString | error | Communication | At least one payload segment shall have a message text (payload.contentString) |
payload.contentString.exists()
|
| forward-prohibits-inResponseTo | error | Communication | If messageType is 'forward-message', inResponseTo SHALL be empty. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'forward-message').exists() implies inResponseTo.empty()
|
| no-standard-sender | error | Communication | The standard Communication.sender element SHALL NOT be used. Use the ehealth-carecommunication-sender extension instead. |
sender.empty()
|
| only-asap-or-routine | error | Communication | priority must be either 'asap' or 'routine' |
priority.empty() or priority = 'asap' or priority = 'routine'
|
| payloadAttachment-contentType-required | error | Communication | contentType SHALL be present when the attachment content is in the data element. It is not required for url-only attachments. |
payload.contentAttachment.data.exists() implies payload.contentAttachment.contentType.exists()
|
| priority-category-invariant | error | Communication | Priority must not be present when category is not 'regarding-referral'. |
category.coding.code = 'regarding-referral' or priority.empty()
|
| reply-requires-inResponseTo | error | Communication | If messageType is 'reply-message', inResponseTo SHALL be populated. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'reply-message').exists() implies inResponseTo.exists()
|
| sender-contactPoint-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must carry a contactPoint. If 'forward', it may be absent. Mirrors MedCom's required authorContact on the outbound message. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').extension('contactPoint').exists()
|
| sender-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must be present. If 'forward', sender may be absent. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').exists()
|
| stopped-status-statusReason | error | Communication | If status is 'stopped', statusReason must be either 'system-error' or 'recipient-unavailable'. |
status != 'stopped' or statusReason.coding.where(code = 'system-error' or code = 'recipient-unavailable').exists()
|
| topic-required-when-category-other | error | Communication | topic must be present when category is 'other'. |
iif(category.coding.code != 'other', true, category.coding.code = 'other' and topic.exists())
|
| uuidv4 | error | Communication.identifier:communicationId | identifier.value SHALL be a valid UUID v4 in URN form (urn:uuid:<uuid>) |
value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver Constraints: stopped-status-statusReason, only-asap-or-routine, topic-required-when-category-other, priority-category-invariant, atLeastOnePayloadString, payloadAttachment-contentType-required, no-standard-sender, sender-required-based-on-messagetype, sender-contactPoint-required-based-on-messagetype, reply-requires-inResponseTo, forward-prohibits-inResponseTo |
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Sender Extension, contains the sending PractitionerRole, Practitioner and CareTeam. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization receiving the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-destination |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Reference to the sending organization of the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-origin |
![]() ![]() ![]() |
S | 1..1 | Coding | Message type URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type Binding: Message Type ValueSet (required) |
![]() ![]() ![]() |
1..1 | Coding | The administrative status of how a message recipient has handled a message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status Binding: Administrative Status (required) | |
![]() ![]() |
S | 1..2 | Identifier | Unique identifier Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SC | 1..1 | Identifier | The communication identifier Constraints: uuidv4 |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/id/ehealth-carecommunication-identifier |
![]() ![]() ![]() ![]() |
S | 1..1 | string | UUID v4 in URN form (urn:uuid:<uuid>) |
![]() ![]() ![]() |
S | 0..1 | Identifier | The ID of the originating MessageHeader resource |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/fhir/system/medcom-message-header-id |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
0..0 | Request fulfilled by this communication | ||
![]() ![]() |
0..0 | Part of this action | ||
![]() ![]() |
S | 0..1 | Reference(Communication) | references the Ehealth-CareCommunication Communication.id, which this message is a response to. |
![]() ![]() |
S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: eHealth CareCommunication Categories (required) |
![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://ehealth.sundhed.dk/cs/ehealth-carecommunication-category |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
S | 0..1 | code | Only used when the category is 'regarding referral', see priority-category-invariant. Binding: eHealth CareCommunication Priorities (required) |
![]() ![]() |
S | 1..1 | Reference(Patient) | Focus of message |
![]() ![]() |
S | 0..1 | CodeableConcept | Must be added when category is "other". Topic must be added in the text-element. |
![]() ![]() ![]() |
S | 1..1 | string | Plain text representation of the concept. |
![]() ![]() |
S | 0..1 | Reference(Encounter) | Shall contain a reference to an Encounter resource with a episodeOfCare-identifier, if the identifier is included in a previous message. |
![]() ![]() |
S | 0..1 | Reference(CareTeam | PractitionerRole) | The recieving actor of the message |
![]() ![]() |
0..0 | Message sender | ||
![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier |
![]() ![]() ![]() ![]() |
1..1 | string | Message part content Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Message part content |
![]() ![]() ![]() |
0..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier |
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Message part content |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | The content type shall be present when the content is an attachment included in the data element. Binding: eHealth CareCommunication Attachment MIME Types (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Shall be present and contain the base64 encoded content of the attachment. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | url | Shall be present if the attachment is a link to a web page. |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Note: it is not allowed for the system to automatically include '.filetype' in the title. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | The time the attachment was created |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.identifier:communicationId.use | Base | required | IdentifierUse | 📦4.0.1 | FHIR Std. |
| Communication.category | Base | required | eHealth CareCommunication Categories | 📦10.0.0 | This IG |
| Communication.priority | Base | required | eHealth CareCommunication Priorities | 📦10.0.0 | This IG |
| Communication.payload:attachment.content[x].contentType | Base | required | eHealth CareCommunication Attachment MIME Types | 📦10.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| atLeastOnePayloadString | error | Communication | At least one payload segment shall have a message text (payload.contentString) |
payload.contentString.exists()
|
| forward-prohibits-inResponseTo | error | Communication | If messageType is 'forward-message', inResponseTo SHALL be empty. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'forward-message').exists() implies inResponseTo.empty()
|
| no-standard-sender | error | Communication | The standard Communication.sender element SHALL NOT be used. Use the ehealth-carecommunication-sender extension instead. |
sender.empty()
|
| only-asap-or-routine | error | Communication | priority must be either 'asap' or 'routine' |
priority.empty() or priority = 'asap' or priority = 'routine'
|
| payloadAttachment-contentType-required | error | Communication | contentType SHALL be present when the attachment content is in the data element. It is not required for url-only attachments. |
payload.contentAttachment.data.exists() implies payload.contentAttachment.contentType.exists()
|
| priority-category-invariant | error | Communication | Priority must not be present when category is not 'regarding-referral'. |
category.coding.code = 'regarding-referral' or priority.empty()
|
| reply-requires-inResponseTo | error | Communication | If messageType is 'reply-message', inResponseTo SHALL be populated. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'reply-message').exists() implies inResponseTo.exists()
|
| sender-contactPoint-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must carry a contactPoint. If 'forward', it may be absent. Mirrors MedCom's required authorContact on the outbound message. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').extension('contactPoint').exists()
|
| sender-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must be present. If 'forward', sender may be absent. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').exists()
|
| stopped-status-statusReason | error | Communication | If status is 'stopped', statusReason must be either 'system-error' or 'recipient-unavailable'. |
status != 'stopped' or statusReason.coding.where(code = 'system-error' or code = 'recipient-unavailable').exists()
|
| topic-required-when-category-other | error | Communication | topic must be present when category is 'other'. |
iif(category.coding.code != 'other', true, category.coding.code = 'other' and topic.exists())
|
| uuidv4 | error | Communication.identifier:communicationId | identifier.value SHALL be a valid UUID v4 in URN form (urn:uuid:<uuid>) |
value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver Constraints: stopped-status-statusReason, only-asap-or-routine, topic-required-when-category-other, priority-category-invariant, atLeastOnePayloadString, payloadAttachment-contentType-required, no-standard-sender, sender-required-based-on-messagetype, sender-contactPoint-required-based-on-messagetype, reply-requires-inResponseTo, forward-prohibits-inResponseTo | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Sender Extension, contains the sending PractitionerRole, Practitioner and CareTeam. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization receiving the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-destination | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Reference to the sending organization of the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-origin | ||||
![]() ![]() ![]() |
S | 1..1 | Coding | Message type URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type Binding: Message Type ValueSet (required) | ||||
![]() ![]() ![]() |
1..1 | Coding | The administrative status of how a message recipient has handled a message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status Binding: Administrative Status (required) | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..2 | Identifier | Unique identifier Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
SΣC | 1..1 | Identifier | The communication identifier Constraints: uuidv4 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/id/ehealth-carecommunication-identifier | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | UUID v4 in URN form (urn:uuid:<uuid>) Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | The ID of the originating MessageHeader resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/fhir/system/medcom-message-header-id | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
S | 0..1 | Reference(Communication) | references the Ehealth-CareCommunication Communication.id, which this message is a response to. | ||||
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: eHealth CareCommunication Categories (required) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://ehealth.sundhed.dk/cs/ehealth-carecommunication-category | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 0..1 | code | Only used when the category is 'regarding referral', see priority-category-invariant. Binding: eHealth CareCommunication Priorities (required) | ||||
![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Focus of message | ||||
![]() ![]() |
S | 0..1 | CodeableConcept | Must be added when category is "other". Topic must be added in the text-element. Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept. | ||||
![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
![]() ![]() |
SΣ | 0..1 | Reference(Encounter) | Shall contain a reference to an Encounter resource with a episodeOfCare-identifier, if the identifier is included in a previous message. | ||||
![]() ![]() |
0..1 | dateTime | When sent | |||||
![]() ![]() |
0..1 | dateTime | When received | |||||
![]() ![]() |
S | 0..1 | Reference(CareTeam | PractitionerRole) | The recieving actor of the message | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | string | Message part content Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Message part content | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Message part content | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | The content type shall be present when the content is an attachment included in the data element. Binding: eHealth CareCommunication Attachment MIME Types (required) Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Shall be present and contain the base64 encoded content of the attachment. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Shall be present if the attachment is a link to a web page. Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Note: it is not allowed for the system to automatically include '.filetype' in the title. Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time the attachment was created | ||||
![]() ![]() |
0..* | Annotation | Comments made about the communication | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.identifier:communicationId.use | Base | required | IdentifierUse | 📦4.0.1 | FHIR Std. |
| Communication.identifier:communicationId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Communication.identifier:messageHeaderId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Communication.identifier:messageHeaderId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | example | CommunicationNotDoneReason | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | required | eHealth CareCommunication Categories | 📦10.0.0 | This IG |
| Communication.priority | Base | required | eHealth CareCommunication Priorities | 📦10.0.0 | This IG |
| Communication.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment.content[x].contentType | Base | required | eHealth CareCommunication Attachment MIME Types | 📦10.0.0 | This IG |
| Communication.payload:attachment.content[x].language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| atLeastOnePayloadString | error | Communication | At least one payload segment shall have a message text (payload.contentString) |
payload.contentString.exists()
|
| forward-prohibits-inResponseTo | error | Communication | If messageType is 'forward-message', inResponseTo SHALL be empty. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'forward-message').exists() implies inResponseTo.empty()
|
| no-standard-sender | error | Communication | The standard Communication.sender element SHALL NOT be used. Use the ehealth-carecommunication-sender extension instead. |
sender.empty()
|
| only-asap-or-routine | error | Communication | priority must be either 'asap' or 'routine' |
priority.empty() or priority = 'asap' or priority = 'routine'
|
| payloadAttachment-contentType-required | error | Communication | contentType SHALL be present when the attachment content is in the data element. It is not required for url-only attachments. |
payload.contentAttachment.data.exists() implies payload.contentAttachment.contentType.exists()
|
| priority-category-invariant | error | Communication | Priority must not be present when category is not 'regarding-referral'. |
category.coding.code = 'regarding-referral' or priority.empty()
|
| reply-requires-inResponseTo | error | Communication | If messageType is 'reply-message', inResponseTo SHALL be populated. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'reply-message').exists() implies inResponseTo.exists()
|
| sender-contactPoint-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must carry a contactPoint. If 'forward', it may be absent. Mirrors MedCom's required authorContact on the outbound message. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').extension('contactPoint').exists()
|
| sender-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must be present. If 'forward', sender may be absent. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').exists()
|
| stopped-status-statusReason | error | Communication | If status is 'stopped', statusReason must be either 'system-error' or 'recipient-unavailable'. |
status != 'stopped' or statusReason.coding.where(code = 'system-error' or code = 'recipient-unavailable').exists()
|
| topic-required-when-category-other | error | Communication | topic must be present when category is 'other'. |
iif(category.coding.code != 'other', true, category.coding.code = 'other' and topic.exists())
|
| uuidv4 | error | Communication.identifier:communicationId | identifier.value SHALL be a valid UUID v4 in URN form (urn:uuid:<uuid>) |
value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
This structure is derived from Communication
Summary
Mandatory: 18 elements(6 nested mandatory elements)
Must-Support: 34 elements
Prohibited: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver Constraints: stopped-status-statusReason, only-asap-or-routine, topic-required-when-category-other, priority-category-invariant, atLeastOnePayloadString, payloadAttachment-contentType-required, no-standard-sender, sender-required-based-on-messagetype, sender-contactPoint-required-based-on-messagetype, reply-requires-inResponseTo, forward-prohibits-inResponseTo |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Sender Extension, contains the sending PractitionerRole, Practitioner and CareTeam. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization receiving the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-destination |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Reference to the sending organization of the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-origin |
![]() ![]() ![]() |
S | 1..1 | Coding | Message type URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type Binding: Message Type ValueSet (required) |
![]() ![]() ![]() |
1..1 | Coding | The administrative status of how a message recipient has handled a message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status Binding: Administrative Status (required) | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..2 | Identifier | Unique identifier Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣC | 1..1 | Identifier | The communication identifier Constraints: uuidv4 |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/id/ehealth-carecommunication-identifier |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | UUID v4 in URN form (urn:uuid:<uuid>) Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | The ID of the originating MessageHeader resource |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/fhir/system/medcom-message-header-id |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
S | 0..1 | Reference(Communication) | references the Ehealth-CareCommunication Communication.id, which this message is a response to. |
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: eHealth CareCommunication Categories (required) |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://ehealth.sundhed.dk/cs/ehealth-carecommunication-category |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
SΣ | 0..1 | code | Only used when the category is 'regarding referral', see priority-category-invariant. Binding: eHealth CareCommunication Priorities (required) |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Focus of message |
![]() ![]() |
S | 0..1 | CodeableConcept | Must be added when category is "other". Topic must be added in the text-element. Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. |
![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept. |
![]() ![]() |
SΣ | 0..1 | Reference(Encounter) | Shall contain a reference to an Encounter resource with a episodeOfCare-identifier, if the identifier is included in a previous message. |
![]() ![]() |
S | 0..1 | Reference(CareTeam | PractitionerRole) | The recieving actor of the message |
![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | string | Message part content Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Message part content |
![]() ![]() ![]() |
0..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Message part content |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | The content type shall be present when the content is an attachment included in the data element. Binding: eHealth CareCommunication Attachment MIME Types (required) Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Shall be present and contain the base64 encoded content of the attachment. |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Shall be present if the attachment is a link to a web page. Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Note: it is not allowed for the system to automatically include '.filetype' in the title. Example General: Official Corporate Logo |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time the attachment was created |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.identifier:communicationId.use | Base | required | IdentifierUse | 📦4.0.1 | FHIR Std. |
| Communication.identifier:messageHeaderId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | required | eHealth CareCommunication Categories | 📦10.0.0 | This IG |
| Communication.priority | Base | required | eHealth CareCommunication Priorities | 📦10.0.0 | This IG |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment.content[x].contentType | Base | required | eHealth CareCommunication Attachment MIME Types | 📦10.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| atLeastOnePayloadString | error | Communication | At least one payload segment shall have a message text (payload.contentString) |
payload.contentString.exists()
|
| forward-prohibits-inResponseTo | error | Communication | If messageType is 'forward-message', inResponseTo SHALL be empty. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'forward-message').exists() implies inResponseTo.empty()
|
| no-standard-sender | error | Communication | The standard Communication.sender element SHALL NOT be used. Use the ehealth-carecommunication-sender extension instead. |
sender.empty()
|
| only-asap-or-routine | error | Communication | priority must be either 'asap' or 'routine' |
priority.empty() or priority = 'asap' or priority = 'routine'
|
| payloadAttachment-contentType-required | error | Communication | contentType SHALL be present when the attachment content is in the data element. It is not required for url-only attachments. |
payload.contentAttachment.data.exists() implies payload.contentAttachment.contentType.exists()
|
| priority-category-invariant | error | Communication | Priority must not be present when category is not 'regarding-referral'. |
category.coding.code = 'regarding-referral' or priority.empty()
|
| reply-requires-inResponseTo | error | Communication | If messageType is 'reply-message', inResponseTo SHALL be populated. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'reply-message').exists() implies inResponseTo.exists()
|
| sender-contactPoint-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must carry a contactPoint. If 'forward', it may be absent. Mirrors MedCom's required authorContact on the outbound message. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').extension('contactPoint').exists()
|
| sender-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must be present. If 'forward', sender may be absent. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').exists()
|
| stopped-status-statusReason | error | Communication | If status is 'stopped', statusReason must be either 'system-error' or 'recipient-unavailable'. |
status != 'stopped' or statusReason.coding.where(code = 'system-error' or code = 'recipient-unavailable').exists()
|
| topic-required-when-category-other | error | Communication | topic must be present when category is 'other'. |
iif(category.coding.code != 'other', true, category.coding.code = 'other' and topic.exists())
|
| uuidv4 | error | Communication.identifier:communicationId | identifier.value SHALL be a valid UUID v4 in URN form (urn:uuid:<uuid>) |
value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
Differential View
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver Constraints: stopped-status-statusReason, only-asap-or-routine, topic-required-when-category-other, priority-category-invariant, atLeastOnePayloadString, payloadAttachment-contentType-required, no-standard-sender, sender-required-based-on-messagetype, sender-contactPoint-required-based-on-messagetype, reply-requires-inResponseTo, forward-prohibits-inResponseTo |
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Sender Extension, contains the sending PractitionerRole, Practitioner and CareTeam. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization receiving the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-destination |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Reference to the sending organization of the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-origin |
![]() ![]() ![]() |
S | 1..1 | Coding | Message type URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type Binding: Message Type ValueSet (required) |
![]() ![]() ![]() |
1..1 | Coding | The administrative status of how a message recipient has handled a message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status Binding: Administrative Status (required) | |
![]() ![]() |
S | 1..2 | Identifier | Unique identifier Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SC | 1..1 | Identifier | The communication identifier Constraints: uuidv4 |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/id/ehealth-carecommunication-identifier |
![]() ![]() ![]() ![]() |
S | 1..1 | string | UUID v4 in URN form (urn:uuid:<uuid>) |
![]() ![]() ![]() |
S | 0..1 | Identifier | The ID of the originating MessageHeader resource |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/fhir/system/medcom-message-header-id |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
0..0 | Request fulfilled by this communication | ||
![]() ![]() |
0..0 | Part of this action | ||
![]() ![]() |
S | 0..1 | Reference(Communication) | references the Ehealth-CareCommunication Communication.id, which this message is a response to. |
![]() ![]() |
S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: eHealth CareCommunication Categories (required) |
![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://ehealth.sundhed.dk/cs/ehealth-carecommunication-category |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
S | 0..1 | code | Only used when the category is 'regarding referral', see priority-category-invariant. Binding: eHealth CareCommunication Priorities (required) |
![]() ![]() |
S | 1..1 | Reference(Patient) | Focus of message |
![]() ![]() |
S | 0..1 | CodeableConcept | Must be added when category is "other". Topic must be added in the text-element. |
![]() ![]() ![]() |
S | 1..1 | string | Plain text representation of the concept. |
![]() ![]() |
S | 0..1 | Reference(Encounter) | Shall contain a reference to an Encounter resource with a episodeOfCare-identifier, if the identifier is included in a previous message. |
![]() ![]() |
S | 0..1 | Reference(CareTeam | PractitionerRole) | The recieving actor of the message |
![]() ![]() |
0..0 | Message sender | ||
![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier |
![]() ![]() ![]() ![]() |
1..1 | string | Message part content Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Message part content |
![]() ![]() ![]() |
0..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier |
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Message part content |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | The content type shall be present when the content is an attachment included in the data element. Binding: eHealth CareCommunication Attachment MIME Types (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Shall be present and contain the base64 encoded content of the attachment. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | url | Shall be present if the attachment is a link to a web page. |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Note: it is not allowed for the system to automatically include '.filetype' in the title. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | The time the attachment was created |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.identifier:communicationId.use | Base | required | IdentifierUse | 📦4.0.1 | FHIR Std. |
| Communication.category | Base | required | eHealth CareCommunication Categories | 📦10.0.0 | This IG |
| Communication.priority | Base | required | eHealth CareCommunication Priorities | 📦10.0.0 | This IG |
| Communication.payload:attachment.content[x].contentType | Base | required | eHealth CareCommunication Attachment MIME Types | 📦10.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| atLeastOnePayloadString | error | Communication | At least one payload segment shall have a message text (payload.contentString) |
payload.contentString.exists()
|
| forward-prohibits-inResponseTo | error | Communication | If messageType is 'forward-message', inResponseTo SHALL be empty. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'forward-message').exists() implies inResponseTo.empty()
|
| no-standard-sender | error | Communication | The standard Communication.sender element SHALL NOT be used. Use the ehealth-carecommunication-sender extension instead. |
sender.empty()
|
| only-asap-or-routine | error | Communication | priority must be either 'asap' or 'routine' |
priority.empty() or priority = 'asap' or priority = 'routine'
|
| payloadAttachment-contentType-required | error | Communication | contentType SHALL be present when the attachment content is in the data element. It is not required for url-only attachments. |
payload.contentAttachment.data.exists() implies payload.contentAttachment.contentType.exists()
|
| priority-category-invariant | error | Communication | Priority must not be present when category is not 'regarding-referral'. |
category.coding.code = 'regarding-referral' or priority.empty()
|
| reply-requires-inResponseTo | error | Communication | If messageType is 'reply-message', inResponseTo SHALL be populated. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'reply-message').exists() implies inResponseTo.exists()
|
| sender-contactPoint-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must carry a contactPoint. If 'forward', it may be absent. Mirrors MedCom's required authorContact on the outbound message. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').extension('contactPoint').exists()
|
| sender-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must be present. If 'forward', sender may be absent. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').exists()
|
| stopped-status-statusReason | error | Communication | If status is 'stopped', statusReason must be either 'system-error' or 'recipient-unavailable'. |
status != 'stopped' or statusReason.coding.where(code = 'system-error' or code = 'recipient-unavailable').exists()
|
| topic-required-when-category-other | error | Communication | topic must be present when category is 'other'. |
iif(category.coding.code != 'other', true, category.coding.code = 'other' and topic.exists())
|
| uuidv4 | error | Communication.identifier:communicationId | identifier.value SHALL be a valid UUID v4 in URN form (urn:uuid:<uuid>) |
value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver Constraints: stopped-status-statusReason, only-asap-or-routine, topic-required-when-category-other, priority-category-invariant, atLeastOnePayloadString, payloadAttachment-contentType-required, no-standard-sender, sender-required-based-on-messagetype, sender-contactPoint-required-based-on-messagetype, reply-requires-inResponseTo, forward-prohibits-inResponseTo | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Sender Extension, contains the sending PractitionerRole, Practitioner and CareTeam. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization receiving the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-destination | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Reference to the sending organization of the message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-origin | ||||
![]() ![]() ![]() |
S | 1..1 | Coding | Message type URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type Binding: Message Type ValueSet (required) | ||||
![]() ![]() ![]() |
1..1 | Coding | The administrative status of how a message recipient has handled a message URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status Binding: Administrative Status (required) | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..2 | Identifier | Unique identifier Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
SΣC | 1..1 | Identifier | The communication identifier Constraints: uuidv4 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/id/ehealth-carecommunication-identifier | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | UUID v4 in URN form (urn:uuid:<uuid>) Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | The ID of the originating MessageHeader resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://ehealth.sundhed.dk/fhir/system/medcom-message-header-id | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
S | 0..1 | Reference(Communication) | references the Ehealth-CareCommunication Communication.id, which this message is a response to. | ||||
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: eHealth CareCommunication Categories (required) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://ehealth.sundhed.dk/cs/ehealth-carecommunication-category | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 0..1 | code | Only used when the category is 'regarding referral', see priority-category-invariant. Binding: eHealth CareCommunication Priorities (required) | ||||
![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Focus of message | ||||
![]() ![]() |
S | 0..1 | CodeableConcept | Must be added when category is "other". Topic must be added in the text-element. Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept. | ||||
![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
![]() ![]() |
SΣ | 0..1 | Reference(Encounter) | Shall contain a reference to an Encounter resource with a episodeOfCare-identifier, if the identifier is included in a previous message. | ||||
![]() ![]() |
0..1 | dateTime | When sent | |||||
![]() ![]() |
0..1 | dateTime | When received | |||||
![]() ![]() |
S | 0..1 | Reference(CareTeam | PractitionerRole) | The recieving actor of the message | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | string | Message part content Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Message part content | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Payload dateTime URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-datetime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-payload-identifier | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Message part content | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | The content type shall be present when the content is an attachment included in the data element. Binding: eHealth CareCommunication Attachment MIME Types (required) Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Shall be present and contain the base64 encoded content of the attachment. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Shall be present if the attachment is a link to a web page. Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Note: it is not allowed for the system to automatically include '.filetype' in the title. Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time the attachment was created | ||||
![]() ![]() |
0..* | Annotation | Comments made about the communication | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.identifier:communicationId.use | Base | required | IdentifierUse | 📦4.0.1 | FHIR Std. |
| Communication.identifier:communicationId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Communication.identifier:messageHeaderId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Communication.identifier:messageHeaderId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | example | CommunicationNotDoneReason | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | required | eHealth CareCommunication Categories | 📦10.0.0 | This IG |
| Communication.priority | Base | required | eHealth CareCommunication Priorities | 📦10.0.0 | This IG |
| Communication.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.3 |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment.content[x].contentType | Base | required | eHealth CareCommunication Attachment MIME Types | 📦10.0.0 | This IG |
| Communication.payload:attachment.content[x].language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| atLeastOnePayloadString | error | Communication | At least one payload segment shall have a message text (payload.contentString) |
payload.contentString.exists()
|
| forward-prohibits-inResponseTo | error | Communication | If messageType is 'forward-message', inResponseTo SHALL be empty. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'forward-message').exists() implies inResponseTo.empty()
|
| no-standard-sender | error | Communication | The standard Communication.sender element SHALL NOT be used. Use the ehealth-carecommunication-sender extension instead. |
sender.empty()
|
| only-asap-or-routine | error | Communication | priority must be either 'asap' or 'routine' |
priority.empty() or priority = 'asap' or priority = 'routine'
|
| payloadAttachment-contentType-required | error | Communication | contentType SHALL be present when the attachment content is in the data element. It is not required for url-only attachments. |
payload.contentAttachment.data.exists() implies payload.contentAttachment.contentType.exists()
|
| priority-category-invariant | error | Communication | Priority must not be present when category is not 'regarding-referral'. |
category.coding.code = 'regarding-referral' or priority.empty()
|
| reply-requires-inResponseTo | error | Communication | If messageType is 'reply-message', inResponseTo SHALL be populated. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'reply-message').exists() implies inResponseTo.exists()
|
| sender-contactPoint-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must carry a contactPoint. If 'forward', it may be absent. Mirrors MedCom's required authorContact on the outbound message. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').extension('contactPoint').exists()
|
| sender-required-based-on-messagetype | error | Communication | If messagetype is 'new' or 'reply', the sender extension must be present. If 'forward', sender may be absent. |
extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-message-Type').value.where(code = 'new-message' or code = 'reply-message').exists() implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-carecommunication-sender').exists()
|
| stopped-status-statusReason | error | Communication | If status is 'stopped', statusReason must be either 'system-error' or 'recipient-unavailable'. |
status != 'stopped' or statusReason.coding.where(code = 'system-error' or code = 'recipient-unavailable').exists()
|
| topic-required-when-category-other | error | Communication | topic must be present when category is 'other'. |
iif(category.coding.code != 'other', true, category.coding.code = 'other' and topic.exists())
|
| uuidv4 | error | Communication.identifier:communicationId | identifier.value SHALL be a valid UUID v4 in URN form (urn:uuid:<uuid>) |
value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
This structure is derived from Communication
Summary
Mandatory: 18 elements(6 nested mandatory elements)
Must-Support: 34 elements
Prohibited: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron