Nachrichten (Communication)
Ärzte können Patienten erlauben ihnen über das ESYSTA-Portal Nachrichten zu senden, auf die Ärzte wiederum antworten können. So entsteht ein sicheres Kommunikationsmedium zwischen Patienten und Ärzten. Die folgende Festlegung beschreibt Nachrichten (EsystaCommunication) im ESYSTA-Portal. Ein Nachrichtenaustausch (sender
und recepient
) findet stets zwischen einem Patienten (DiabetesPatient) und einem Arzt (Practitioner) statt, enthält einen Inhalt (payload
) und einen Betreff (topic
).
Kompatibilität
Dieses Profil basiert auf der Basisdefinition des FHIR Communication und wurde durch Einschränkungen spezifiziert. Instanzen müssen gegen das folgende FHIR-Profil valide sein.
FHIR-Profil (EsystaCommunication)
EsystaCommunication (Communication) | I | Communication | There are no (further) constraints on this element Element idCommunication A record of information transmitted from a sender to a receiver DefinitionAn 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.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCommunication.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCommunication.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCommunication.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCommunication.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | S I | 0..1 | Extension | Element idCommunication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
messageRead | I | 0..1 | Extension(boolean) | Element idCommunication.extension:messageRead Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://portal.esysta.com/fhir/StructureDefinition/MessageRead Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idCommunication.identifier Unique identifier DefinitionBusiness 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. Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers. 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.
|
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | There are no (further) constraints on this element Element idCommunication.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Constraints
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idCommunication.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
|
basedOn | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.basedOn Request fulfilled by this communication Alternate namesfulfills DefinitionAn order, proposal or plan fulfilled in whole or in part by this Communication. This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.
|
partOf | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.partOf Part of this action Alternate namescontainer DefinitionPart of this action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
inResponseTo | I | 0..* | Reference(Communication) | There are no (further) constraints on this element Element idCommunication.inResponseTo Reply to DefinitionPrior communication that this communication is in response to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.status preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown DefinitionThe status of the transmission. 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. The status of the communication.
|
statusReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCommunication.statusReason Reason for current status Alternate namesSuspended Reason, Cancelled Reason DefinitionCaptures the reason for the current state of the Communication. 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. Codes for the reason why a communication did not happen.
|
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.category Message category DefinitionThe type of message conveyed such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication may serve multiple purposes. Codes for general categories of communications such as alerts, instructions, etc.
| |
priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.priority routine | urgent | asap | stat DefinitionCharacterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress. If missing, this communication should be treated with normal priority Codes indicating the relative importance of a communication.
|
medium | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.medium A channel of communication DefinitionA channel that was used for this communication (e.g. email, fax). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for communication mediums such as phone, fax, email, in person, etc.
| |
subject | Σ I | 0..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element idCommunication.subject Focus of message Alternate namespatient DefinitionThe patient or group that was the focus of this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
topic | S | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCommunication.topic Description of the purpose/content DefinitionDescription of the purpose/content, similar to a subject line in an email. Communication.topic.text can be used without any codings. Codes describing the purpose or content of the communication.
|
about | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.about Resources that pertain to this communication DefinitionOther resources that pertain to this communication and to which this communication should be associated. Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idCommunication.encounter Encounter created as part of DefinitionThe Encounter during which this Communication was created or to which the creation of this record is tightly associated. 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.
|
sent | S | 1..1 | dateTime | There are no (further) constraints on this element Element idCommunication.sent When sent DefinitionThe time when this communication was sent.
|
received | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.received When received DefinitionThe time when this communication arrived at the destination.
| |
recipient | S I | 1..1 | Reference(DiabetesPatient | Practitioner) | Element idCommunication.recipient Message recipient DefinitionThe 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). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(DiabetesPatient | Practitioner) Constraints
|
sender | S I | 1..1 | Reference(DiabetesPatient | Practitioner) | Element idCommunication.sender Message sender DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(DiabetesPatient | Practitioner) Constraints
|
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.reasonCode Indication for message DefinitionThe reason or justification for the communication. Textual reasons can be captured using reasonCode.text. Codes for describing reasons for the occurrence of a communication.
|
reasonReference | Σ I | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idCommunication.reasonReference Why was communication done? DefinitionIndicates another resource whose existence justifies this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints
|
payload | S | 1..1 | BackboneElement | There are no (further) constraints on this element Element idCommunication.payload Message payload DefinitionText, attachment(s), or resource(s) that was communicated to the recipient.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.payload.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.payload.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.payload.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
content[x] | 1..1 | There are no (further) constraints on this element Element idCommunication.payload.content[x] Message part content DefinitionA communicated content (or for multi-part communications, one portion of the communication).
| ||
contentString | string | There are no (further) constraints on this element Data type | ||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idCommunication.note Comments made about the communication DefinitionAdditional notes or commentary about the communication by the sender, receiver or other interested parties. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
Beispiel
Fiktives Beispiel einer validen EsystaCommunication Instanz:
<Communication xmlns="http://hl7.org/fhir"> <id value="message-1" /> <meta> <profile value="http://portal.esysta.com/fhir/StructureDefinition/EsystaCommunication" /> </meta> <extension url="http://portal.esysta.com/fhir/StructureDefinition/MessageRead"> <valueBoolean value="true" /> </extension> <identifier> <use value="official" /> <system value="http://portal.esysta.com/fhir/Communication/" /> <value value="message-1" /> </identifier> <status value="completed" /> <topic> <text value="Ich hab so schlimm FHIR!" /> </topic> <sent value="2012-12-10T06:08:44.725727Z" /> <recipient> <reference value="Practitioner/practitioner-1" /> </recipient> <sender> <reference value="Patient/patient-1" /> </sender> <payload> <contentString value="Hallo Herr Doktor Card, bitte helfen Sie mir schnell mit meinem FHIR, es brennt!" /> </payload> </Communication>