eHealth Infrastructure - Local Development build (v2.6.0). See the Directory of published versions
Active as of 2023-01-12 |
Definitions for the ehealth-message resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Communication | |
Invariants | Defined on this element message-invariant: Category message invariant (: category.coding.code = 'message' implies (recipient.reference.contains('Patient/') and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not() or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists()) and (sender.reference.contains('Patient/') or sender.reference.contains('Device/'))) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists() )) nemsms-invariant: If communication resource is a NemSMS payload cannot exceed 160 (: medium.coding.where(code = 'nemsms').exists() implies payload.contentString.length() <= 160) note-invariant: Category note invariant (: category.coding.code = 'note' implies (sender.reference = recipient.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists())) notification-invariant: Category notification invariant (: category.coding.code = 'notification' implies recipient.reference.contains('Patient/') and ( sender.reference.contains('Practitioner/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists())) |
2. Communication.extension | |
Control | 10..* |
Slicing | This element introduces a set of slices on Communication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
3. Communication.extension:episodeOfCare | |
SliceName | episodeOfCare |
Control | 0..1 |
Type | Extension(episodeOfCare) (Extension Type: Reference(EpisodeOfCare)) |
4. Communication.extension:recipientCareTeam | |
SliceName | recipientCareTeam |
Control | 0..1 |
Type | Extension(ehealth-communication-recipientCareTeam) (Extension Type: Reference(ehealth-careteam) : {r}) |
5. Communication.extension:senderCareTeam | |
SliceName | senderCareTeam |
Control | 0..1 |
Type | Extension(ehealth-communication-senderCareTeam) (Extension Type: Reference(ehealth-careteam) : {r}) |
6. Communication.extension:restrictionCategory | |
SliceName | restrictionCategory |
Control | 0..* |
Type | Extension(ehealth-restriction-category) (Extension Type: CodeableConcept) |
7. Communication.extension:threadId | |
SliceName | threadId |
Control | 0..1 |
Type | Extension(ehealth-thread-id) (Extension Type: string) |
8. Communication.extension:period | |
SliceName | period |
Control | 0..* |
Type | Extension(ehealth-period) (Extension Type: Period) |
9. Communication.extension:administrativeStatus | |
SliceName | administrativeStatus |
Control | 1..1 |
Type | Extension(ehealth-administrative-status) (Extension Type: Coding) |
10. Communication.extension:title | |
SliceName | title |
Control | 0..1 |
Type | Extension(ehealth-title) (Extension Type: string) |
11. Communication.extension:priority | |
SliceName | priority |
Control | 0..1 |
Type | Extension(ehealth-priority) (Extension Type: code) |
12. Communication.extension:groupId | |
SliceName | groupId |
Control | 0..1 |
Type | Extension(ehealth-group-id) (Extension Type: string) |
13. Communication.extension:onBehalfOf | |
SliceName | onBehalfOf |
Control | 0..1 |
Type | Extension(ehealth-on-behalf-of) (Extension Type: Reference(ehealth-careteam) : {r}) |
Must Support | true |
14. Communication.partOf | |
Type | Reference(CarePlan|Resource) : {r} |
15. Communication.category | |
Control | 10..* |
Slicing | This element introduces a set of slices on Communication.category. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
16. Communication.category:DkTmCategory | |
SliceName | DkTmCategory |
Control | 1..1 |
17. Communication.category:DkTmCategory.coding | |
Control | 0..? |
18. Communication.category:DkTmCategory.coding.system | |
Control | 1..? |
Pattern Value | http://ehealth.sundhed.dk/cs/message-category |
19. Communication.category:DkTmCategory.coding.code | |
Control | 0..? |
Binding | The codes SHALL be taken from MessageCategory |
20. Communication.medium | |
Slicing | This element introduces a set of slices on Communication.medium. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
21. Communication.medium:DkTmMedium | |
SliceName | DkTmMedium |
Control | 0..1 |
22. Communication.medium:DkTmMedium.coding | |
Control | 0..? |
23. Communication.medium:DkTmMedium.coding.system | |
Control | 1..? |
Pattern Value | http://ehealth.sundhed.dk/cs/message-medium |
24. Communication.medium:DkTmMedium.coding.code | |
Control | 0..? |
Binding | The codes SHALL be taken from MessageMedium |
25. Communication.recipient | |
Control | 0..1* |
Type | Reference(Patient|Practitioner|Device|Organization|PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) : {r} |
26. Communication.sender | |
Type | Reference(Device|Patient|Practitioner|Organization|PractitionerRole|RelatedPerson|HealthcareService) : {r}, {c} |
27. Communication.reasonCode | |
Binding | The codes SHALL be taken from eHealth Message Reason CodeFor example codes, see SNOMEDCTClinicalFindings |
28. Communication.reasonReference | |
Type | Reference(Condition|Observation|DiagnosticReport|DocumentReference) : {r} |
29. Communication.payload | |
Control | 0..1* |
30. Communication.payload.content[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on Communication.payload.content[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
31. Communication.payload.contentString | |
Control | 1..1 |
Type | string |
32. Communication.note | |
Control | 0..? |
33. Communication.note.authorReference | |
Control | 0..1 |
Type | Reference(ehealth-practitioner|ehealth-patient|ehealth-relatedperson) |
34. Communication.note.authorString | |
Control | 0..1 |
Type | string |
Guidance on how to interpret the contents of this table can be found here.
1. Communication | |
Definition | An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition. |
Control | 0..* |
Summary | false |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) message-invariant: Category message invariant (: category.coding.code = 'message' implies (recipient.reference.contains('Patient/') and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not() or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists()) and (sender.reference.contains('Patient/') or sender.reference.contains('Device/'))) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists() )) nemsms-invariant: If communication resource is a NemSMS payload cannot exceed 160 (: medium.coding.where(code = 'nemsms').exists() implies payload.contentString.length() <= 160) note-invariant: Category note invariant (: category.coding.code = 'note' implies (sender.reference = recipient.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists())) notification-invariant: Category notification invariant (: category.coding.code = 'notification' implies recipient.reference.contains('Patient/') and ( sender.reference.contains('Practitioner/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists())) |
2. Communication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. Communication.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 10..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Communication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Communication.extension:episodeOfCare | |
SliceName | episodeOfCare |
Definition | The episode(s) of care that establishes the context for this {{title}}. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(episodeOfCare) (Extension Type: Reference(EpisodeOfCare)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
5. Communication.extension:recipientCareTeam | |
SliceName | recipientCareTeam |
Definition | CareTeam that is a recipient of a Communication |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-communication-recipientCareTeam) (Extension Type: Reference(ehealth-careteam) : {r}) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
6. Communication.extension:senderCareTeam | |
SliceName | senderCareTeam |
Definition | CareTeam that is a sender of a Communication |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-communication-senderCareTeam) (Extension Type: Reference(ehealth-careteam) : {r}) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
7. Communication.extension:restrictionCategory | |
SliceName | restrictionCategory |
Definition | The resource is intended for certain category of workflow/responsibility only |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-restriction-category) (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
8. Communication.extension:threadId | |
SliceName | threadId |
Definition | A logical id identifying a set of messages, which are grouped in a thread. Can be supplied by the client, eg. as a UUID |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-thread-id) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
9. Communication.extension:period | |
SliceName | period |
Definition | Specifies the temporal validity of an ehealth/message instance. Contains a period, eg. specifying temporal validity |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-period) (Extension Type: Period) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. Communication.extension:administrativeStatus | |
SliceName | administrativeStatus |
Definition | The administrative status of how a message recipient has handled a message |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-administrative-status) (Extension Type: Coding) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
11. Communication.extension:title | |
SliceName | title |
Definition | The title of the message |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-title) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
12. Communication.extension:priority | |
SliceName | priority |
Definition | The priority of a message |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-priority) (Extension Type: code) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
13. Communication.extension:groupId | |
SliceName | groupId |
Definition | A logical id identifying a set of messages, which have the same recipient (considered a 'group message'). Must be supplied by the client, eg. as a UUID |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-group-id) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
14. Communication.extension:onBehalfOf | |
SliceName | onBehalfOf |
Definition | On behalf of |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-on-behalf-of) (Extension Type: Reference(ehealth-careteam) : {r}) |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
15. Communication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
16. Communication.partOf | |
Definition | Part of this action. |
Control | 0..* |
Type | Reference(CarePlan|Resource) : {r} |
Summary | true |
Alternate Names | container |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. Communication.status | |
Definition | The status of the transmission. |
Control | 1..1 |
Binding | The codes SHALL be taken from EventStatus The status of the communication. |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. Communication.category | |
Definition | The type of message conveyed such as alert, notification, reminder, instruction, etc. |
Control | 10..* |
Binding | For example codes, see CommunicationCategory Codes for general categories of communications such as alerts, instructions, etc. |
Type | CodeableConcept |
Summary | false |
Comments | There may be multiple axes of categorization and one communication may serve multiple purposes. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Communication.category. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
19. Communication.category:DkTmCategory | |
SliceName | DkTmCategory |
Definition | The type of message conveyed such as alert, notification, reminder, instruction, etc. |
Control | 10..1* |
Binding | For example codes, see CommunicationCategory Codes for general categories of communications such as alerts, instructions, etc. |
Type | CodeableConcept |
Summary | false |
Comments | There may be multiple axes of categorization and one communication may serve multiple purposes. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. Communication.medium | |
Definition | A channel that was used for this communication (e.g. email, fax). |
Control | 0..* |
Binding | For example codes, see ParticipationMode Codes for communication mediums such as phone, fax, email, in person, etc. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Communication.medium. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
21. Communication.medium:DkTmMedium | |
SliceName | DkTmMedium |
Definition | A channel that was used for this communication (e.g. email, fax). |
Control | 0..1* |
Binding | For example codes, see ParticipationMode Codes for communication mediums such as phone, fax, email, in person, etc. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. Communication.recipient | |
Definition | The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time). |
Control | 0..1* |
Type | Reference(Patient|Practitioner|Device|Organization|PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) : {r} |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. Communication.sender | |
Definition | The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. |
Control | 0..1 |
Type | Reference(Device|Patient|Practitioner|Organization|PractitionerRole|RelatedPerson|HealthcareService) : {r}, {c} |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Communication.reasonCode | |
Definition | The reason or justification for the communication. |
Control | 0..* |
Binding | The codes SHALL be taken from eHealth Message Reason CodeFor example codes, see SNOMEDCTClinicalFindings |
Type | CodeableConcept |
Summary | true |
Comments | Textual reasons can be captured using reasonCode.text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Communication.reasonReference | |
Definition | Indicates another resource whose existence justifies this communication. |
Control | 0..* |
Type | Reference(Condition|Observation|DiagnosticReport|DocumentReference) : {r} |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Communication.payload | |
Definition | Text, attachment(s), or resource(s) that was communicated to the recipient. |
Control | 0..1* |
Type | BackboneElement |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. Communication.payload.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
28. Communication.payload.content[x] | |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | Choice of: string, Reference(Resource), Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Communication.payload.content[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
29. Communication.payload.content[x]:contentString | |
SliceName | contentString |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | Choice of: string, Reference(Resource), Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. Communication | |||||
Definition | An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition. | ||||
Control | 0..* | ||||
Summary | false | ||||
2. Communication.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. Communication.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. Communication.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
5. Communication.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Summary | false | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
6. Communication.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
7. Communication.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
8. Communication.extension | |||||
Definition | An Extension | ||||
Control | 1..* | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Communication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
9. Communication.extension:episodeOfCare | |||||
SliceName | episodeOfCare | ||||
Definition | The episode(s) of care that establishes the context for this {{title}}. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(episodeOfCare) (Extension Type: Reference(EpisodeOfCare)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
10. Communication.extension:recipientCareTeam | |||||
SliceName | recipientCareTeam | ||||
Definition | CareTeam that is a recipient of a Communication | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-communication-recipientCareTeam) (Extension Type: Reference(ehealth-careteam) : {r}) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
11. Communication.extension:senderCareTeam | |||||
SliceName | senderCareTeam | ||||
Definition | CareTeam that is a sender of a Communication | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-communication-senderCareTeam) (Extension Type: Reference(ehealth-careteam) : {r}) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
12. Communication.extension:restrictionCategory | |||||
SliceName | restrictionCategory | ||||
Definition | The resource is intended for certain category of workflow/responsibility only | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-restriction-category) (Extension Type: CodeableConcept) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
13. Communication.extension:threadId | |||||
SliceName | threadId | ||||
Definition | A logical id identifying a set of messages, which are grouped in a thread. Can be supplied by the client, eg. as a UUID | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-thread-id) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
14. Communication.extension:period | |||||
SliceName | period | ||||
Definition | Specifies the temporal validity of an ehealth/message instance. Contains a period, eg. specifying temporal validity | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-period) (Extension Type: Period) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
15. Communication.extension:administrativeStatus | |||||
SliceName | administrativeStatus | ||||
Definition | The administrative status of how a message recipient has handled a message | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-administrative-status) (Extension Type: Coding) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
16. Communication.extension:title | |||||
SliceName | title | ||||
Definition | The title of the message | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-title) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
17. Communication.extension:priority | |||||
SliceName | priority | ||||
Definition | The priority of a message | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-priority) (Extension Type: code) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
18. Communication.extension:groupId | |||||
SliceName | groupId | ||||
Definition | A logical id identifying a set of messages, which have the same recipient (considered a 'group message'). Must be supplied by the client, eg. as a UUID | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-group-id) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
19. Communication.extension:onBehalfOf | |||||
SliceName | onBehalfOf | ||||
Definition | On behalf of | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-on-behalf-of) (Extension Type: Reference(ehealth-careteam) : {r}) | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
20. Communication.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
21. Communication.identifier | |||||
Definition | Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers. | ||||
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
22. Communication.instantiatesCanonical | |||||
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. | ||||
Control | 0..* | ||||
Type | canonical(PlanDefinition|ActivityDefinition|Measure|OperationDefinition|Questionnaire) | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. Communication.instantiatesUri | |||||
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. | ||||
Control | 0..* | ||||
Type | uri | ||||
Summary | true | ||||
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
24. Communication.basedOn | |||||
Definition | An order, proposal or plan fulfilled in whole or in part by this Communication. | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Summary | true | ||||
Alternate Names | fulfills | ||||
Comments | This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. Communication.partOf | |||||
Definition | Part of this action. | ||||
Control | 0..* | ||||
Type | Reference(CarePlan) : {r} | ||||
Summary | true | ||||
Alternate Names | container | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. Communication.inResponseTo | |||||
Definition | Prior communication that this communication is in response to. | ||||
Control | 0..* | ||||
Type | Reference(Communication) | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Communication.status | |||||
Definition | The status of the transmission. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from EventStatus The status of the communication | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Communication.statusReason | |||||
Definition | Captures the reason for the current state of the Communication. | ||||
Control | 0..1 | ||||
Binding | For example codes, see CommunicationNotDoneReason Codes for the reason why a communication did not happen | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Alternate Names | Suspended Reason, Cancelled Reason | ||||
Comments | This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. Communication.category | |||||
Definition | The type of message conveyed such as alert, notification, reminder, instruction, etc. | ||||
Control | 1..* | ||||
Binding | For example codes, see CommunicationCategory Codes for general categories of communications such as alerts, instructions, etc | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Comments | There may be multiple axes of categorization and one communication may serve multiple purposes. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Communication.category. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
30. Communication.category:DkTmCategory | |||||
SliceName | DkTmCategory | ||||
Definition | The type of message conveyed such as alert, notification, reminder, instruction, etc. | ||||
Control | 1..1 | ||||
Binding | For example codes, see CommunicationCategory Codes for general categories of communications such as alerts, instructions, etc | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Comments | There may be multiple axes of categorization and one communication may serve multiple purposes. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
31. Communication.category:DkTmCategory.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
32. Communication.category:DkTmCategory.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Communication.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
33. Communication.category:DkTmCategory.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. Communication.category:DkTmCategory.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
35. Communication.category:DkTmCategory.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Communication.category.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
36. Communication.category:DkTmCategory.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Pattern Value | http://ehealth.sundhed.dk/cs/message-category | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. Communication.category:DkTmCategory.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. Communication.category:DkTmCategory.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from MessageCategory | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. Communication.category:DkTmCategory.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
40. Communication.category:DkTmCategory.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. Communication.category:DkTmCategory.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. Communication.priority | |||||
Definition | Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from RequestPriority Codes indicating the relative importance of a communication | ||||
Type | code | ||||
Summary | true | ||||
Comments | Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress. | ||||
Meaning if Missing | If missing, this communication should be treated with normal priority | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. Communication.medium | |||||
Definition | A channel that was used for this communication (e.g. email, fax). | ||||
Control | 0..* | ||||
Binding | For example codes, see ParticipationMode Codes for communication mediums such as phone, fax, email, in person, etc | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Communication.medium. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
44. Communication.medium:DkTmMedium | |||||
SliceName | DkTmMedium | ||||
Definition | A channel that was used for this communication (e.g. email, fax). | ||||
Control | 0..1 | ||||
Binding | For example codes, see ParticipationMode Codes for communication mediums such as phone, fax, email, in person, etc | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. Communication.medium:DkTmMedium.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
46. Communication.medium:DkTmMedium.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Communication.medium.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
47. Communication.medium:DkTmMedium.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
48. Communication.medium:DkTmMedium.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
49. Communication.medium:DkTmMedium.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Communication.medium.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
50. Communication.medium:DkTmMedium.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Pattern Value | http://ehealth.sundhed.dk/cs/message-medium | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. Communication.medium:DkTmMedium.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. Communication.medium:DkTmMedium.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from MessageMedium | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
53. Communication.medium:DkTmMedium.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. Communication.medium:DkTmMedium.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. Communication.medium:DkTmMedium.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
56. Communication.subject | |||||
Definition | The patient or group that was the focus of this communication. | ||||
Control | 0..1 | ||||
Type | Reference(Patient|Group) | ||||
Summary | true | ||||
Alternate Names | patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
57. Communication.topic | |||||
Definition | Description of the purpose/content, similar to a subject line in an email. | ||||
Control | 0..1 | ||||
Binding | For example codes, see CommunicationTopic Codes describing the purpose or content of the communication | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Comments | Communication.topic.text can be used without any codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
58. Communication.about | |||||
Definition | Other resources that pertain to this communication and to which this communication should be associated. | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Summary | false | ||||
Comments | Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
59. Communication.encounter | |||||
Definition | The Encounter during which this Communication was created or to which the creation of this record is tightly associated. | ||||
Control | 0..1 | ||||
Type | Reference(Encounter) | ||||
Summary | true | ||||
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
60. Communication.sent | |||||
Definition | The time when this communication was sent. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
61. Communication.received | |||||
Definition | The time when this communication arrived at the destination. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
62. Communication.recipient | |||||
Definition | The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time). | ||||
Control | 0..1 | ||||
Type | Reference(Patient|Practitioner) : {r} | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. Communication.sender | |||||
Definition | The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. | ||||
Control | 0..1 | ||||
Type | Reference(Device|Patient|Practitioner) : {r}, {c} | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
64. Communication.reasonCode | |||||
Definition | The reason or justification for the communication. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from eHealth Message Reason Code | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Comments | Textual reasons can be captured using reasonCode.text. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
65. Communication.reasonReference | |||||
Definition | Indicates another resource whose existence justifies this communication. | ||||
Control | 0..* | ||||
Type | Reference(Condition|Observation) : {r} | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
66. Communication.payload | |||||
Definition | Text, attachment(s), or resource(s) that was communicated to the recipient. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
67. Communication.payload.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
68. Communication.payload.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
69. Communication.payload.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
70. Communication.payload.content[x] | |||||
Definition | A communicated content (or for multi-part communications, one portion of the communication). | ||||
Control | 1..1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Communication.payload.content[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
71. Communication.payload.content[x]:contentString | |||||
SliceName | contentString | ||||
Definition | A communicated content (or for multi-part communications, one portion of the communication). | ||||
Control | 1..1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
72. Communication.note | |||||
Definition | Additional notes or commentary about the communication by the sender, receiver or other interested parties. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
73. Communication.note.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
74. Communication.note.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on Communication.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
75. Communication.note.author[x] | |||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | Choice of: Reference(Practitioner|Patient|RelatedPerson|Organization), string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Communication.note.author[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
76. Communication.note.author[x]:authorReference | |||||
SliceName | authorReference | ||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | Reference(ehealth-practitioner|ehealth-patient|ehealth-relatedperson) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
77. Communication.note.author[x]:authorString | |||||
SliceName | authorString | ||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
78. Communication.note.time | |||||
Definition | Indicates when this particular annotation was made. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
79. Communication.note.text | |||||
Definition | The text of the annotation in markdown format. | ||||
Control | 1..1 | ||||
Type | markdown | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |