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
| 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AlexCommunication | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣC | 0..1 | Identifier | Unique identifier Constraints: alex-outbox-external-reference-length |
![]() ![]() ![]() |
SΣ | 0..1 | string | The external reference number of the Outbox record/Message Example General: 123456 |
![]() ![]() |
?!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 |
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 423876004 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: Clinical document (record artifact) |
![]() ![]() |
SΣC | 1..1 | Reference(Patient | Group) | Focus of message Constraints: alex-outbox-display-length |
![]() ![]() |
S | 1..1 | dateTime | When sent |
![]() ![]() |
S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
![]() ![]() |
S | 1..1 | BackboneElement | The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Message part content Slice: Unordered, Closed by type:$this | ||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
C | 0..1 | Attachment | Message part content Constraints: alex-outbox-attachment-title-length |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
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 |
Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AlexCommunication | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
S | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() |
C | 0..1 | Identifier | Unique identifier Constraints: alex-outbox-external-reference-length |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..1 | string | The external reference number of the Outbox record/Message | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Required Pattern: completed | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: 423876004 | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: Clinical document (record artifact) | |
![]() ![]() |
C | 1..1 | Reference(Patient | Group) | Focus of message Constraints: alex-outbox-display-length |
![]() ![]() |
1..1 | BackboneElement | The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
C | 0..1 | Attachment | Message part content Constraints: alex-outbox-attachment-title-length |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. Required Pattern: application/pdf | |
![]() ![]() ![]() ![]() ![]() |
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 | ||||
| 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
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AlexCommunication | A record of information transmitted from a sender to a receiver | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
SΣ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣC | 0..1 | Identifier | Unique identifier Constraints: alex-outbox-external-reference-length | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The external reference number of the Outbox record/Message Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
?!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 | ||||
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 423876004 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: Clinical document (record artifact) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣC | 1..1 | Reference(Patient | Group) | Focus of message Constraints: alex-outbox-display-length | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | External name of patient | ||||
![]() ![]() |
S | 1..1 | dateTime | When sent | ||||
![]() ![]() |
S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||||
![]() ![]() |
S | 1..1 | BackboneElement | The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Message part content Slice: Unordered, Closed by type:$this | ||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Attachment | Message part content Constraints: alex-outbox-attachment-title-length | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
Documentation for this format | ||||||||
| 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. |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AlexCommunication | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣC | 0..1 | Identifier | Unique identifier Constraints: alex-outbox-external-reference-length |
![]() ![]() ![]() |
SΣ | 0..1 | string | The external reference number of the Outbox record/Message Example General: 123456 |
![]() ![]() |
?!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 |
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 423876004 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: Clinical document (record artifact) |
![]() ![]() |
SΣC | 1..1 | Reference(Patient | Group) | Focus of message Constraints: alex-outbox-display-length |
![]() ![]() |
S | 1..1 | dateTime | When sent |
![]() ![]() |
S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
![]() ![]() |
S | 1..1 | BackboneElement | The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Message part content Slice: Unordered, Closed by type:$this | ||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
C | 0..1 | Attachment | Message part content Constraints: alex-outbox-attachment-title-length |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
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 |
Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AlexCommunication | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
S | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() |
C | 0..1 | Identifier | Unique identifier Constraints: alex-outbox-external-reference-length |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..1 | string | The external reference number of the Outbox record/Message | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Required Pattern: completed | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: 423876004 | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: Clinical document (record artifact) | |
![]() ![]() |
C | 1..1 | Reference(Patient | Group) | Focus of message Constraints: alex-outbox-display-length |
![]() ![]() |
1..1 | BackboneElement | The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
C | 0..1 | Attachment | Message part content Constraints: alex-outbox-attachment-title-length |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. Required Pattern: application/pdf | |
![]() ![]() ![]() ![]() ![]() |
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 | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AlexCommunication | A record of information transmitted from a sender to a receiver | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
SΣ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣC | 0..1 | Identifier | Unique identifier Constraints: alex-outbox-external-reference-length | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The external reference number of the Outbox record/Message Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
?!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 | ||||
![]() ![]() |
S | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 423876004 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: Clinical document (record artifact) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣC | 1..1 | Reference(Patient | Group) | Focus of message Constraints: alex-outbox-display-length | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | External name of patient | ||||
![]() ![]() |
S | 1..1 | dateTime | When sent | ||||
![]() ![]() |
S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||||
![]() ![]() |
S | 1..1 | BackboneElement | The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Message part content Slice: Unordered, Closed by type:$this | ||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Attachment | Message part content Constraints: alex-outbox-attachment-title-length | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
Documentation for this format | ||||||||
| 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. |
| 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
Other representations of profile: CSV, Excel, Schematron