FHIR IG Statistics: StructureDefinition/be-communication

Resources that use this resource

No resources found

Resources that this resource uses

Narrative

Note: links and images are rebased to the (stated) source

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	Communication	A record of information transmitted from a sender to a receiver
identifier	S	0..*	Identifier	Unique identifier for this communication
status	S	1..1	code	Status of this communication: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
category	S	0..*	CodeableConcept	Message category
priority	S	0..1	code	routine | urgent | asap | stat
subject	S	0..1	Reference(BePatient | Group)	Subject of the communication - typically Patient
topic	S	0..1	CodeableConcept	Topic of the communication Binding: BEDiaryTopic (preferred)
sent	S	0..1	dateTime	Date and Time that the communication has been sent
recipient	S	0..*	Reference(Device | Organization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	Intended receiver of the communication
sender	S	0..1	Reference(Device | Organization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService)	The actual sender of the communication
payload	S	0..*	BackboneElement	The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
content[x]		1..1	(Slice Definition)	Communication content Slice: Unordered, Open by type:$this
contentString		0..1	string	Message part content
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "be-communication",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Clinical.Request &amp; Response"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "patient"
    }
  ],
  "url": "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-communication",
  "version": "1.0.0",
  "name": "BeCommunication",
  "title": "BeCommunication",
  "status": "active",
  "date": "2021-01-18T09:02:46+00:00",
  "publisher": "eHealth Platform",
  "contact": [
    {
      "name": "eHealth Platform",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ehealth.fgov.be"
        }
      ]
    },
    {
      "name": "Message structure",
      "telecom": [
        {
          "system": "email",
          "value": "message-structure@ehealth.fgov.be"
        }
      ]
    }
  ],
  "description": "This is the technical specification for the Communication resource, as it is used in Belgium.\nThis specification is compatible with the current version of KMEHR Diary Note, namely the selection of attributes that are supported, and the maximum length of the payload (320 characters).\nIt also relies on the foundation Belgium resources, for example the Belgian Patient, Practitioner and other resources.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "056"
        }
      ],
      "text": "Belgium"
    }
  ],
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Communication",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Communication",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Communication.identifier",
        "path": "Communication.identifier",
        "short": "Unique identifier for this communication",
        "definition": "Unique identifier for this communication. Unlike the resource's _id, this identifier must resolve across systems.",
        "mustSupport": true
      },
      {
        "id": "Communication.status",
        "path": "Communication.status",
        "short": "Status of this communication: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
        "mustSupport": true
      },
      {
        "id": "Communication.category",
        "path": "Communication.category",
        "mustSupport": true
      },
      {
        "id": "Communication.priority",
        "path": "Communication.priority",
        "mustSupport": true
      },
      {
        "id": "Communication.subject",
        "path": "Communication.subject",
        "short": "Subject of the communication - typically Patient",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient",
              "http://hl7.org/fhir/StructureDefinition/Group"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Communication.topic",
        "path": "Communication.topic",
        "short": "Topic of the communication",
        "mustSupport": true,
        "binding": {
          "strength": "preferred",
          "valueSet": "https://www.ehealth.fgov.be/standards/fhir/ValueSet/be-vs-diarytopic"
        }
      },
      {
        "id": "Communication.sent",
        "path": "Communication.sent",
        "short": "Date and Time that the communication has been sent",
        "mustSupport": true
      },
      {
        "id": "Communication.recipient",
        "path": "Communication.recipient",
        "short": "Intended receiver of the communication",
        "definition": "This field indicates the intended receiver of the communication. For messages, this SHALL be explicitly indicated, even when it can be assumed e.g. to be the patient's Care Team. For diary notes, this can be optional.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Device",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerrole",
              "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
              "http://hl7.org/fhir/StructureDefinition/Group",
              "http://hl7.org/fhir/StructureDefinition/CareTeam",
              "http://hl7.org/fhir/StructureDefinition/HealthcareService",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-organization"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Communication.sender",
        "path": "Communication.sender",
        "short": "The actual sender of the communication",
        "definition": "This field contains the sender of the communication. If the communication is entered by a nurse on behalf of a physician, this shall refer to the nurse.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Device",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerrole",
              "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
              "http://hl7.org/fhir/StructureDefinition/HealthcareService",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-organization"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Communication.payload",
        "path": "Communication.payload",
        "short": "The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.",
        "definition": "This content can be free Text (up to 320 characters), or Attachments (e.g. a photo) or References to other resources (e.g. a Binary resource containing a photo).",
        "comment": "For systems that are intending to be backwards compatible with KMEHR, only the text is allowed.",
        "mustSupport": true
      },
      {
        "id": "Communication.payload.content[x]",
        "path": "Communication.payload.content[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "ordered": false,
          "rules": "open"
        },
        "short": "Communication content",
        "definition": "A communicated content (or for multi-part communications, one portion of the communication). This can be a string, an attachment, or a reference to a resource."
      },
      {
        "id": "Communication.payload.content[x]:contentString",
        "path": "Communication.payload.content[x]",
        "sliceName": "contentString",
        "comment": "NOTE: The string element is valid only for FHIR 4.0.1, and it will likely be replaced by another data type (Annotation) in future releases of FHIR and of this profile.",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}