Medtech ALEX® AU Implementation Guide
1.0.0 - Trial Use International flag

Medtech ALEX® AU Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Outbox

Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-outbox Version: 1.0.0
Active as of 2025-10-12 Computable Name: AlexOutbox

The ALEX Outbox that utilises the Communication resource

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* AlexCommunication A record of information transmitted from a sender to a receiver
... meta Σ 1..1 Meta Metadata about the resource
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... value SΣ 0..1 string The external reference number of the Outbox record/Message
Example General: 123456
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
Required Pattern: completed
... category S 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 423876004
..... display Σ 0..1 string Representation defined by the system
Required Pattern: Clinical document (record artifact)
... subject SΣC 1..1 Reference(Patient | Group) Focus of message
Constraints: alex-outbox-display-length
... sent S 1..1 dateTime When sent
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
... payload S 1..1 BackboneElement The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Closed by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentAttachment C 0..1 Attachment Message part content
Constraints: alex-outbox-attachment-title-length
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/pdf
...... data S 1..1 base64Binary Data inline, base64ed
...... title SΣ 1..1 string This will be sent by the vendor in the payload, must limit to 50 characters, otherwise the subject will be cutoff in the UI
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍4.0.1 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.payload.​content[x]:contentAttachment.​contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
alex-outbox-attachment-title-length error Communication.payload.content[x]:contentAttachment Attachment title size validation title.empty() or title.length() <= 50
alex-outbox-display-length error Communication.subject Patient external name size validation display.empty() or display.length() <= 35
alex-outbox-external-reference-length error Communication.identifier External reference size validation value.empty() or value.length() <= 34
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication 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 error Communication 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 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AlexCommunication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* AlexCommunication A record of information transmitted from a sender to a receiver
... meta 1..1 Meta Metadata about the resource
.... profile S 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier C 0..1 Identifier Unique identifier
Constraints: alex-outbox-external-reference-length
.... use 0..0
.... type 0..0
.... system 0..0
.... value 0..1 string The external reference number of the Outbox record/Message
.... period 0..0
... status 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Required Pattern: completed
.... coding
..... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Required Pattern: 423876004
..... display 0..1 string Representation defined by the system
Required Pattern: Clinical document (record artifact)
... subject C 1..1 Reference(Patient | Group) Focus of message
Constraints: alex-outbox-display-length
... payload 1..1 BackboneElement The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully
.... Slices for content[x] Content/Rules for all slices
..... content[x]:contentAttachment C 0..1 Attachment Message part content
Constraints: alex-outbox-attachment-title-length
...... contentType 1..1 code Mime type of the content, with charset etc.
Required Pattern: application/pdf
...... title 1..1 string This will be sent by the vendor in the payload, must limit to 50 characters, otherwise the subject will be cutoff in the UI

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
alex-outbox-attachment-title-length error Communication.payload.content[x]:contentAttachment Attachment title size validation title.empty() or title.length() <= 50
alex-outbox-display-length error Communication.subject Patient external name size validation display.empty() or display.length() <= 35
alex-outbox-external-reference-length error Communication.identifier External reference size validation value.empty() or value.length() <= 34
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* AlexCommunication A record of information transmitted from a sender to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 0..1 Identifier Unique identifier
Constraints: alex-outbox-external-reference-length
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value SΣ 0..1 string The external reference number of the Outbox record/Message
Example General: 123456
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
Required Pattern: completed
... category S 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 423876004
..... display Σ 0..1 string Representation defined by the system
Required Pattern: Clinical document (record artifact)
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣC 1..1 Reference(Patient | Group) Focus of message
Constraints: alex-outbox-display-length
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string External name of patient
... sent S 1..1 dateTime When sent
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
... payload S 1..1 BackboneElement The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Closed by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentAttachment C 0..1 Attachment Message part content
Constraints: alex-outbox-attachment-title-length
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/pdf
...... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
...... data S 1..1 base64Binary Data inline, base64ed
...... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
...... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
...... title SΣ 1..1 string This will be sent by the vendor in the payload, must limit to 50 characters, otherwise the subject will be cutoff in the UI
Example General: Official Corporate Logo
...... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Communication.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Communication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Communication.status Base required EventStatus 📍4.0.1 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Communication.payload.​content[x]:contentAttachment.​contentType Base required MimeType 📍4.0.1 FHIR Std.
Communication.payload.​content[x]:contentAttachment.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
alex-outbox-attachment-title-length error Communication.payload.content[x]:contentAttachment Attachment title size validation title.empty() or title.length() <= 50
alex-outbox-display-length error Communication.subject Patient external name size validation display.empty() or display.length() <= 35
alex-outbox-external-reference-length error Communication.identifier External reference size validation value.empty() or value.length() <= 34
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication 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 error Communication 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 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AlexCommunication

Summary

Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 4 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* AlexCommunication A record of information transmitted from a sender to a receiver
... meta Σ 1..1 Meta Metadata about the resource
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... value SΣ 0..1 string The external reference number of the Outbox record/Message
Example General: 123456
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
Required Pattern: completed
... category S 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 423876004
..... display Σ 0..1 string Representation defined by the system
Required Pattern: Clinical document (record artifact)
... subject SΣC 1..1 Reference(Patient | Group) Focus of message
Constraints: alex-outbox-display-length
... sent S 1..1 dateTime When sent
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
... payload S 1..1 BackboneElement The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Closed by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentAttachment C 0..1 Attachment Message part content
Constraints: alex-outbox-attachment-title-length
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/pdf
...... data S 1..1 base64Binary Data inline, base64ed
...... title SΣ 1..1 string This will be sent by the vendor in the payload, must limit to 50 characters, otherwise the subject will be cutoff in the UI
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍4.0.1 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.payload.​content[x]:contentAttachment.​contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
alex-outbox-attachment-title-length error Communication.payload.content[x]:contentAttachment Attachment title size validation title.empty() or title.length() <= 50
alex-outbox-display-length error Communication.subject Patient external name size validation display.empty() or display.length() <= 35
alex-outbox-external-reference-length error Communication.identifier External reference size validation value.empty() or value.length() <= 34
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication 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 error Communication 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 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AlexCommunication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* AlexCommunication A record of information transmitted from a sender to a receiver
... meta 1..1 Meta Metadata about the resource
.... profile S 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier C 0..1 Identifier Unique identifier
Constraints: alex-outbox-external-reference-length
.... use 0..0
.... type 0..0
.... system 0..0
.... value 0..1 string The external reference number of the Outbox record/Message
.... period 0..0
... status 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Required Pattern: completed
.... coding
..... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Required Pattern: 423876004
..... display 0..1 string Representation defined by the system
Required Pattern: Clinical document (record artifact)
... subject C 1..1 Reference(Patient | Group) Focus of message
Constraints: alex-outbox-display-length
... payload 1..1 BackboneElement The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully
.... Slices for content[x] Content/Rules for all slices
..... content[x]:contentAttachment C 0..1 Attachment Message part content
Constraints: alex-outbox-attachment-title-length
...... contentType 1..1 code Mime type of the content, with charset etc.
Required Pattern: application/pdf
...... title 1..1 string This will be sent by the vendor in the payload, must limit to 50 characters, otherwise the subject will be cutoff in the UI

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
alex-outbox-attachment-title-length error Communication.payload.content[x]:contentAttachment Attachment title size validation title.empty() or title.length() <= 50
alex-outbox-display-length error Communication.subject Patient external name size validation display.empty() or display.length() <= 35
alex-outbox-external-reference-length error Communication.identifier External reference size validation value.empty() or value.length() <= 34

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* AlexCommunication A record of information transmitted from a sender to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 0..1 Identifier Unique identifier
Constraints: alex-outbox-external-reference-length
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value SΣ 0..1 string The external reference number of the Outbox record/Message
Example General: 123456
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
Required Pattern: completed
... category S 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 423876004
..... display Σ 0..1 string Representation defined by the system
Required Pattern: Clinical document (record artifact)
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣC 1..1 Reference(Patient | Group) Focus of message
Constraints: alex-outbox-display-length
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string External name of patient
... sent S 1..1 dateTime When sent
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
... payload S 1..1 BackboneElement The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Closed by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentAttachment C 0..1 Attachment Message part content
Constraints: alex-outbox-attachment-title-length
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/pdf
...... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
...... data S 1..1 base64Binary Data inline, base64ed
...... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
...... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
...... title SΣ 1..1 string This will be sent by the vendor in the payload, must limit to 50 characters, otherwise the subject will be cutoff in the UI
Example General: Official Corporate Logo
...... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Communication.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Communication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Communication.status Base required EventStatus 📍4.0.1 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Communication.payload.​content[x]:contentAttachment.​contentType Base required MimeType 📍4.0.1 FHIR Std.
Communication.payload.​content[x]:contentAttachment.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
alex-outbox-attachment-title-length error Communication.payload.content[x]:contentAttachment Attachment title size validation title.empty() or title.length() <= 50
alex-outbox-display-length error Communication.subject Patient external name size validation display.empty() or display.length() <= 35
alex-outbox-external-reference-length error Communication.identifier External reference size validation value.empty() or value.length() <= 34
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication 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 error Communication 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 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AlexCommunication

Summary

Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 4 elements

 

Other representations of profile: CSV, Excel, Schematron