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

• Content
• Detailed Descriptions
• Examples
• JSON

Resource Profile: Outbox

The ALEX Outbox that utilises the Communication resource

Usage:

• Use this Resource Profile: Outbox Bundle
• Examples for this Resource Profile: Communication/outbox-full-example and Communication/outbox-min-example

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	AlexCommunication	A record of information transmitted from a sender to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣC	0..1	Identifier	Unique identifier ele-1: All FHIR elements must have a @value or children alex-outbox-external-reference-length: External reference size validation
value	SΣ	0..1	string	The external reference number of the Outbox record/Message ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children Required Pattern: completed
category	S	1..1	CodeableConcept	Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 423876004
display		1..1	string	Representation defined by the system Fixed Value: Clinical document (record artifact)
subject	SΣC	1..1	Reference(Patient | Group)	Focus of message ele-1: All FHIR elements must have a @value or children alex-outbox-display-length: Patient external name size validation
sent	S	1..1	dateTime	When sent ele-1: All FHIR elements must have a @value or children
sender	S	1..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	Message sender ele-1: All FHIR elements must have a @value or children
payload	S	1..1	BackboneElement	The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for content[x]		1..1		Message part content Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
content[x]:contentAttachment	C	0..1	Attachment	Message part content ele-1: All FHIR elements must have a @value or children alex-outbox-attachment-title-length: Attachment title size validation
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. ele-1: All FHIR elements must have a @value or children Required Pattern: application/pdf
data	S	1..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Communication.status	required	Pattern: completed http://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard
Communication.category	example	Pattern: SNOMED-CT Code 423876004("Clinical document (record artifact)") http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
Communication.payload.content[x]:contentAttachment.contentType	required	Pattern: application/pdf http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	AlexCommunication	A record of information transmitted from a sender to a receiver
identifier	C	0..1	Identifier	Unique identifier alex-outbox-external-reference-length: External reference size validation
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
category		1..1	CodeableConcept	Message category Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 423876004
display		1..1	string	Representation defined by the system Fixed Value: Clinical document (record artifact)
subject	C	1..1	Reference(Patient | Group)	Focus of message alex-outbox-display-length: Patient external name size validation
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 alex-outbox-attachment-title-length: Attachment title size validation
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
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	AlexCommunication	A record of information transmitted from a sender to a receiver
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	0..1	Identifier	Unique identifier alex-outbox-external-reference-length: External reference size validation
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 423876004
display		1..1	string	Representation defined by the system Fixed Value: 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 alex-outbox-display-length: Patient external name size validation
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 alex-outbox-attachment-title-length: Attachment title size validation
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 Bindings Purpose 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Communication.status	required	Pattern: completed http://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard
Communication.category	example	Pattern: SNOMED-CT Code 423876004("Clinical document (record artifact)") http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
Communication.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Communication.payload.content[x]:contentAttachment.contentType	required	Pattern: application/pdf http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Communication.payload.content[x]:contentAttachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Prohibited: 4 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	AlexCommunication	A record of information transmitted from a sender to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣC	0..1	Identifier	Unique identifier ele-1: All FHIR elements must have a @value or children alex-outbox-external-reference-length: External reference size validation
value	SΣ	0..1	string	The external reference number of the Outbox record/Message ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children Required Pattern: completed
category	S	1..1	CodeableConcept	Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 423876004
display		1..1	string	Representation defined by the system Fixed Value: Clinical document (record artifact)
subject	SΣC	1..1	Reference(Patient | Group)	Focus of message ele-1: All FHIR elements must have a @value or children alex-outbox-display-length: Patient external name size validation
sent	S	1..1	dateTime	When sent ele-1: All FHIR elements must have a @value or children
sender	S	1..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	Message sender ele-1: All FHIR elements must have a @value or children
payload	S	1..1	BackboneElement	The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for content[x]		1..1		Message part content Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
content[x]:contentAttachment	C	0..1	Attachment	Message part content ele-1: All FHIR elements must have a @value or children alex-outbox-attachment-title-length: Attachment title size validation
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. ele-1: All FHIR elements must have a @value or children Required Pattern: application/pdf
data	S	1..1	base64Binary	Data inline, base64ed ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Communication.status	required	Pattern: completed http://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard
Communication.category	example	Pattern: SNOMED-CT Code 423876004("Clinical document (record artifact)") http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
Communication.payload.content[x]:contentAttachment.contentType	required	Pattern: application/pdf http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	AlexCommunication	A record of information transmitted from a sender to a receiver
identifier	C	0..1	Identifier	Unique identifier alex-outbox-external-reference-length: External reference size validation
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
category		1..1	CodeableConcept	Message category Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 423876004
display		1..1	string	Representation defined by the system Fixed Value: Clinical document (record artifact)
subject	C	1..1	Reference(Patient | Group)	Focus of message alex-outbox-display-length: Patient external name size validation
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 alex-outbox-attachment-title-length: Attachment title size validation
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
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	AlexCommunication	A record of information transmitted from a sender to a receiver
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	0..1	Identifier	Unique identifier alex-outbox-external-reference-length: External reference size validation
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 423876004
display		1..1	string	Representation defined by the system Fixed Value: 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 alex-outbox-display-length: Patient external name size validation
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 alex-outbox-attachment-title-length: Attachment title size validation
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 Bindings Purpose 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Communication.status	required	Pattern: completed http://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard
Communication.category	example	Pattern: SNOMED-CT Code 423876004("Clinical document (record artifact)") http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
Communication.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Communication.payload.content[x]:contentAttachment.contentType	required	Pattern: application/pdf http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
Communication.payload.content[x]:contentAttachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Prohibited: 4 elements

Other representations of profile: CSV, Excel, Schematron