ZD Communication

Resources conforming to this profile are requested by ZorgDomein using a FHIR read request. The Communication resource is requested to obtain the body text of documents that are generated by the information system of the sender of the document. The resource ID that is used to do the read request is derived from the reference in the message slice on Task.input. See Send documents for more details.

The canonical URL for this profile is:

http://zorgdomein.nl/fhir/StructureDefinition/zd-communication

This profile builds on Communication.

diffhybridsnap

Communication		0..*	Communication	Element Id Communication Short description A record of information transmitted from a sender to a receiver Definition An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition. Data Type Communication Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative `contained.text.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-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource `contained.where(('#'+id in %resource.descendants().reference).not()).empty()` com-1:Not Done Reason can only be specified if NotDone is "true" `notDone or notDoneReason.exists().not()` Mappings rim:Entity. Role, or Act workflow:Event w5:workflow.encounter
identifier	Σ	0..*	Identifier	Element Id Communication.identifier Short description Unique identifier Definition Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Event.identifier w5:id
definition	Σ	0..*	Reference(PlanDefinition \| ActivityDefinition)	Element Id Communication.definition Short description Instantiates protocol or definition Definition A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. Comments 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. Data Type Reference(PlanDefinition \| ActivityDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.definition
basedOn	Σ	1..1	Reference(ZD Task)	Element Id Communication.basedOn Short description Task resource that is used to communicate a specific task to ZorgDomein during SSO Alternate names fulfills Definition An order, proposal or plan fulfilled in whole or in part by this Communication. Comments This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc. Data Type Reference(ZD Task) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.basedOn
reference	Σ	1..1	string	Element Id Communication.basedOn.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	Element Id Communication.basedOn.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
display	Σ	0..1	string	Element Id Communication.basedOn.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
partOf	Σ	0..*	Reference(Resource)	Element Id Communication.partOf Short description Part of this action Alternate names container Definition Part of this action. Comments 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. Data Type Reference(Resource) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.partOf
status	Σ ?!	1..1	codeBinding	Element Id Communication.status Short description preparation \| in-progress \| suspended \| aborted \| completed \| entered-in-error Definition The status of the transmission. 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. Data Type code Binding EventStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a workflow:Event.status w5:status
notDone	Σ ?!	0..1	boolean	Element Id Communication.notDone Short description Communication did not occur Definition If true, indicates that the described communication event did not actually occur. Requirements Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. Comments This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a workflow:Event.notDone
notDoneReason	Σ	0..1	CodeableConcept	Element Id Communication.notDoneReason Short description Why communication did not occur Definition Describes why the communication event did not occur in coded and/or textual form. Comments 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. Data Type CodeableConcept Binding CommunicationNotDoneReason (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Event.notDoneReason
category		0..*	CodeableConcept	Element Id Communication.category Short description Message category Definition The type of message conveyed such as alert, notification, reminder, instruction, etc. Comments There may be multiple axes of categorization and one communication may serve multiple purposes. Data Type CodeableConcept Binding CommunicationCategory (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Event.code w5:class
medium		0..*	CodeableConcept	Element Id Communication.medium Short description A channel of communication Definition A channel that was used for this communication (e.g. email, fax). Comments 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. Data Type CodeableConcept Binding v3 Code System ParticipationMode (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
subject	Σ	0..1	Reference(Patient \| Group)	Element Id Communication.subject Short description Focus of message Alternate names patient Definition The patient or group that was the focus of this communication. Comments 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. Data Type Reference(Patient \| Group) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.subject w5:who.focus
recipient		0..*	Reference(Device \| Organization \| Patient \| Practitioner \| RelatedPerson \| Group)	Element Id Communication.recipient Short description Message recipient Definition The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). Comments 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. Data Type Reference(Device \| Organization \| Patient \| Practitioner \| RelatedPerson \| Group) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5:who.focus
topic		0..*	Reference(Resource)	Element Id Communication.topic Short description Focal resources Definition The resources which were responsible for or related to producing this communication. Comments 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. Data Type Reference(Resource) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5:context
context	Σ	0..1	Reference(Encounter \| EpisodeOfCare)	Element Id Communication.context Short description Encounter or episode leading to message Alternate names encounter Definition The encounter within which the communication was sent. Comments 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. Data Type Reference(Encounter \| EpisodeOfCare) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.context w5:context
sent		0..1	dateTime	Element Id Communication.sent Short description When sent Definition The time when this communication was sent. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a workflow:Event.occurrenceDateTime (Invariant: maps to either sent OR received) w5:when.init
received		0..1	dateTime	Element Id Communication.received Short description When received Definition The time when this communication arrived at the destination. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a workflow:Event.occurrenceDateTime (Invariant: maps to either sent OR received) w5:when.done
sender		0..1	Reference(Device \| Organization \| Patient \| Practitioner \| RelatedPerson)	Element Id Communication.sender Short description Message sender Definition The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. Comments 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. Data Type Reference(Device \| Organization \| Patient \| Practitioner \| RelatedPerson) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.performer.actor w5:who.actor
reasonCode	Σ	0..*	CodeableConcept	Element Id Communication.reasonCode Short description Indication for message Definition The reason or justification for the communication. Comments Textual reasons can be caprued using reasonCode.text. Data Type CodeableConcept Binding SNOMED CT Clinical Findings (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Event.reasonCodableConcept rim:.reasonCode w5:why
reasonReference	Σ	0..*	Reference(Condition \| Observation)	Element Id Communication.reasonReference Short description Why was communication done? Definition Indicates another resource whose existence justifies this communication. Comments 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. Data Type Reference(Condition \| Observation) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.reasonReference rim:.outboundRelationship[typeCode=RSON].target w5:why
payload		1..1	BackboneElement	Element Id Communication.payload Short description Body text of the message or document Definition Text, attachment(s), or resource(s) that was communicated to the recipient. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a
contentString		1..1	string	Element Id Communication.payload.content[x]:contentString Short description Message part content Definition A communicated content (or for multi-part communications, one portion of the communication). Comments Note that FHIR strings may not exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a
note		0..*	Annotation	Element Id Communication.note Short description Comments made about the communication Definition Additional notes or commentary about the communication by the sender, receiver or other interested parties. Comments 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). Data Type Annotation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act workflow:Event.note

See the profile on simplifier.net for additional details.

Example resource

Below you find an example of a resource that conforms to the ZD Communication profile.

{
  "resourceType": "Communication",
  "meta": {
    "profile": [
      "http://zorgdomein.nl/fhir/StructureDefinition/zd-communication"
    ]
  },
  "basedOn": [
    {
      "reference": "Task/1864"
    }
  ],
  "status": "in-progress",
  "subject": {
    "reference": "Patient/1"
  },
  "payload": [
    {
      "contentString": "Geachte heer I.O. Huisarts, \n\nQuisque vel felis facilisis, rhoncus dolor in, tempor lacus. Vestibulum at elementum orci. Vivamus fringilla vestibulum pretium. Quisque auctor, lectus id molestie ullamcorper, quam elit fermentum arcu, sit amet pulvinar sem nunc et nisl. Curabitur sed mauris tempus, vulputate urna ac, feugiat sapien. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Quisque sed mauris eget nibh condimentum semper nec vel mauris. \n\nMet vriendelijke groet, \n\nDhr. I.O. Fysio Breukelen"
    }
  ]
}

<Communication xmlns='http://hl7.org/fhir'>
  <meta>
    <profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-communication'/>
  </meta>
  <basedOn>
    <reference value='Task/1864'/>
  </basedOn>
  <status value='in-progress'/>
  <subject>
    <reference value='Patient/1'/>
  </subject>
  <payload>
    <contentString value='Geachte heer I.O. Huisarts, 

Quisque vel felis facilisis, rhoncus dolor in, tempor lacus. Vestibulum at elementum orci. Vivamus fringilla vestibulum pretium. Quisque auctor, lectus id molestie ullamcorper, quam elit fermentum arcu, sit amet pulvinar sem nunc et nisl. Curabitur sed mauris tempus, vulputate urna ac, feugiat sapien. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Quisque sed mauris eget nibh condimentum semper nec vel mauris. 

Met vriendelijke groet, 

Dhr. I.O. Fysio Breukelen'/>
  </payload>
</Communication>

ZD Communication

Example resource

Questions or comments?

Thank you!