Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/communication | Version: 0.3.0 | |||
Draft as of 2025-06-23 | Computable Name: NphiesCommunication | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
Nphies Communication Profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver BV-00148: The provided resource identifier in the about element is invalid BV-00234: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' |
![]() ![]() ![]() |
1..1 | id | Logical id of this artifact Max Length:64 | |
![]() ![]() ![]() |
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() ![]() |
1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
1..* | DP_Identifier_A | Unique identifier | |
![]() ![]() ![]() |
S | 0..* | DP_Reference_1or3b(Resource) | Request fulfilled by this communication |
![]() ![]() ![]() |
1..1 | DP_code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Required Pattern: completed | |
![]() ![]() ![]() |
S | 0..* | DP_CodeableConcept | Message category Binding: CommunicationCategory (required) |
![]() ![]() ![]() |
S | 0..1 | DP_code | routine | urgent | asap | stat |
![]() ![]() ![]() |
0..* | DP_CodeableConcept | A channel of communication Binding: ParticipationMode (required) | |
![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2a(Nphies Patient) | Focus of message |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | DP_CodeableConcept | Description of identifier Binding: Patient Identifier Type (required) | |
![]() ![]() ![]() |
1..1 | DP_Reference_1or3b(Resource) | Resources that pertain to this communication | |
![]() ![]() ![]() |
S | 0..1 | DP_dateTime | When sent |
![]() ![]() ![]() |
1..1 | DP_Reference_1or2a(Nphies Organization) | Message recipient | |
![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2a(Nphies Organization) | Message sender |
![]() ![]() ![]() |
S | 0..* | DP_CodeableConcept | Indication for message Binding: Communication Reason (required) |
![]() ![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_string | Message part content |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Attachment | Message part content |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Reference_1or3b(Resource) | Message part content |
![]() ![]() ![]() |
SC | 0..* | DP_Annotation | Comments made about the communication BV-00320: Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters |
![]() |
Path | Conformance | ValueSet | URI |
Communication.category | required | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | |
Communication.medium | required | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | |
Communication.subject.identifier.type | required | PatientIdentifierTypehttp://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG | |
Communication.reasonCode | required | CommunicationReason (a valid code from Communication Reason)http://nphies.sa/terminology/ValueSet/communication-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00148 | error | Communication | The provided resource identifier in the about element is invalid : about.exists() | |
BV-00234 | error | Communication | About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count() | |
BV-00320 | error | Communication.note | Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters : author.exists() implies author.length() <= 100 |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | 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 BV-00148: The provided resource identifier in the about element is invalid BV-00234: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' |
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 |
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
Σ | 1..* | DP_Identifier_A | Unique identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | DP_Reference_1or3b(Resource) | Request fulfilled by this communication ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 1..1 | DP_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 |
![]() ![]() ![]() |
S | 0..* | DP_CodeableConcept | Message category Binding: CommunicationCategory (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | DP_code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | DP_CodeableConcept | A channel of communication Binding: ParticipationMode (required) ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
SΣ | 0..1 | DP_Reference_1or2a(Nphies Patient) | Focus of message ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children Max Length:250 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Description of identifier Binding: Patient Identifier Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 Max Length:50 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children Max Length:200 |
![]() ![]() ![]() |
1..1 | DP_Reference_1or3b(Resource) | Resources that pertain to this communication ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | DP_dateTime | When sent ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..1 | DP_Reference_1or2a(Nphies Organization) | Message recipient ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2a(Nphies Organization) | Message sender ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | DP_CodeableConcept | Indication for message Binding: Communication Reason (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | Message part content ele-1: All FHIR elements must have a @value or children | ||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_string | Message part content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Attachment | Message part content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Reference_1or3b(Resource) | Message part content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SC | 0..* | DP_Annotation | Comments made about the communication ele-1: All FHIR elements must have a @value or children BV-00320: Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters |
![]() |
Path | Conformance | ValueSet / Code | URI |
Communication.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Communication.category | required | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | |
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | |
Communication.medium | required | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | |
Communication.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Communication.subject.identifier.type | required | PatientIdentifierTypehttp://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG | |
Communication.reasonCode | required | CommunicationReason (a valid code from Communication Reason)http://nphies.sa/terminology/ValueSet/communication-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00148 | error | Communication | The provided resource identifier in the about element is invalid : about.exists() | |
BV-00234 | error | Communication | About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count() | |
BV-00320 | error | Communication.note | Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters : author.exists() implies author.length() <= 100 | |
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() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver BV-00148: The provided resource identifier in the about element is invalid BV-00234: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' | ||||
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 | ||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | DP_Identifier_A | Unique identifier | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
SΣ | 0..* | DP_Reference_1or3b(Resource) | Request fulfilled by this communication | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of this action | ||||
![]() ![]() ![]() |
0..* | Reference(Communication) | Reply to | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | DP_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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() ![]() |
S | 0..* | DP_CodeableConcept | Message category Binding: CommunicationCategory (required) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | DP_code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
![]() ![]() ![]() |
0..* | DP_CodeableConcept | A channel of communication Binding: ParticipationMode (required) | |||||
![]() ![]() ![]() |
SΣ | 0..1 | DP_Reference_1or2a(Nphies Patient) | Focus of message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL Max Length:250 | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Description of identifier Binding: Patient Identifier Type (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource Max Length:200 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
![]() ![]() ![]() |
1..1 | DP_Reference_1or3b(Resource) | Resources that pertain to this communication | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
S | 0..1 | DP_dateTime | When sent | ||||
![]() ![]() ![]() |
0..1 | dateTime | When received | |||||
![]() ![]() ![]() |
1..1 | DP_Reference_1or2a(Nphies Organization) | Message recipient | |||||
![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2a(Nphies Organization) | Message sender | ||||
![]() ![]() ![]() |
SΣ | 0..* | DP_CodeableConcept | Indication for message Binding: Communication Reason (required) | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_string | Message part content | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Attachment | Message part content | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Reference_1or3b(Resource) | Message part content | ||||
![]() ![]() ![]() |
SC | 0..* | DP_Annotation | Comments made about the communication BV-00320: Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Communication.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Communication.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Communication.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard | ||||
Communication.category | required | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | ||||
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Communication.medium | required | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
Communication.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Communication.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Communication.subject.identifier.type | required | PatientIdentifierTypehttp://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG | ||||
Communication.topic | example | CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topic from the FHIR Standard | ||||
Communication.reasonCode | required | CommunicationReason (a valid code from Communication Reason)http://nphies.sa/terminology/ValueSet/communication-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00148 | error | Communication | The provided resource identifier in the about element is invalid : about.exists() | |
BV-00234 | error | Communication | About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count() | |
BV-00320 | error | Communication.note | Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters : author.exists() implies author.length() <= 100 | |
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 Communication
Summary
Mandatory: 7 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver BV-00148: The provided resource identifier in the about element is invalid BV-00234: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' |
![]() ![]() ![]() |
1..1 | id | Logical id of this artifact Max Length:64 | |
![]() ![]() ![]() |
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() ![]() |
1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
1..* | DP_Identifier_A | Unique identifier | |
![]() ![]() ![]() |
S | 0..* | DP_Reference_1or3b(Resource) | Request fulfilled by this communication |
![]() ![]() ![]() |
1..1 | DP_code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Required Pattern: completed | |
![]() ![]() ![]() |
S | 0..* | DP_CodeableConcept | Message category Binding: CommunicationCategory (required) |
![]() ![]() ![]() |
S | 0..1 | DP_code | routine | urgent | asap | stat |
![]() ![]() ![]() |
0..* | DP_CodeableConcept | A channel of communication Binding: ParticipationMode (required) | |
![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2a(Nphies Patient) | Focus of message |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | DP_CodeableConcept | Description of identifier Binding: Patient Identifier Type (required) | |
![]() ![]() ![]() |
1..1 | DP_Reference_1or3b(Resource) | Resources that pertain to this communication | |
![]() ![]() ![]() |
S | 0..1 | DP_dateTime | When sent |
![]() ![]() ![]() |
1..1 | DP_Reference_1or2a(Nphies Organization) | Message recipient | |
![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2a(Nphies Organization) | Message sender |
![]() ![]() ![]() |
S | 0..* | DP_CodeableConcept | Indication for message Binding: Communication Reason (required) |
![]() ![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_string | Message part content |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Attachment | Message part content |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Reference_1or3b(Resource) | Message part content |
![]() ![]() ![]() |
SC | 0..* | DP_Annotation | Comments made about the communication BV-00320: Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters |
![]() |
Path | Conformance | ValueSet | URI |
Communication.category | required | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | |
Communication.medium | required | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | |
Communication.subject.identifier.type | required | PatientIdentifierTypehttp://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG | |
Communication.reasonCode | required | CommunicationReason (a valid code from Communication Reason)http://nphies.sa/terminology/ValueSet/communication-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00148 | error | Communication | The provided resource identifier in the about element is invalid : about.exists() | |
BV-00234 | error | Communication | About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count() | |
BV-00320 | error | Communication.note | Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters : author.exists() implies author.length() <= 100 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | 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 BV-00148: The provided resource identifier in the about element is invalid BV-00234: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' |
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 |
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
Σ | 1..* | DP_Identifier_A | Unique identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | DP_Reference_1or3b(Resource) | Request fulfilled by this communication ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 1..1 | DP_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 |
![]() ![]() ![]() |
S | 0..* | DP_CodeableConcept | Message category Binding: CommunicationCategory (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | DP_code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | DP_CodeableConcept | A channel of communication Binding: ParticipationMode (required) ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
SΣ | 0..1 | DP_Reference_1or2a(Nphies Patient) | Focus of message ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children Max Length:250 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Description of identifier Binding: Patient Identifier Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 Max Length:50 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children Max Length:200 |
![]() ![]() ![]() |
1..1 | DP_Reference_1or3b(Resource) | Resources that pertain to this communication ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | DP_dateTime | When sent ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..1 | DP_Reference_1or2a(Nphies Organization) | Message recipient ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2a(Nphies Organization) | Message sender ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | DP_CodeableConcept | Indication for message Binding: Communication Reason (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | Message part content ele-1: All FHIR elements must have a @value or children | ||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_string | Message part content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Attachment | Message part content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Reference_1or3b(Resource) | Message part content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SC | 0..* | DP_Annotation | Comments made about the communication ele-1: All FHIR elements must have a @value or children BV-00320: Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters |
![]() |
Path | Conformance | ValueSet / Code | URI |
Communication.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Communication.category | required | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | |
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | |
Communication.medium | required | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | |
Communication.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Communication.subject.identifier.type | required | PatientIdentifierTypehttp://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG | |
Communication.reasonCode | required | CommunicationReason (a valid code from Communication Reason)http://nphies.sa/terminology/ValueSet/communication-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00148 | error | Communication | The provided resource identifier in the about element is invalid : about.exists() | |
BV-00234 | error | Communication | About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count() | |
BV-00320 | error | Communication.note | Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters : author.exists() implies author.length() <= 100 | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver BV-00148: The provided resource identifier in the about element is invalid BV-00234: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' | ||||
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 | ||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | DP_Identifier_A | Unique identifier | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
SΣ | 0..* | DP_Reference_1or3b(Resource) | Request fulfilled by this communication | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of this action | ||||
![]() ![]() ![]() |
0..* | Reference(Communication) | Reply to | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | DP_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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() ![]() |
S | 0..* | DP_CodeableConcept | Message category Binding: CommunicationCategory (required) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | DP_code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
![]() ![]() ![]() |
0..* | DP_CodeableConcept | A channel of communication Binding: ParticipationMode (required) | |||||
![]() ![]() ![]() |
SΣ | 0..1 | DP_Reference_1or2a(Nphies Patient) | Focus of message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL Max Length:250 | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Description of identifier Binding: Patient Identifier Type (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource Max Length:200 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
![]() ![]() ![]() |
1..1 | DP_Reference_1or3b(Resource) | Resources that pertain to this communication | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
S | 0..1 | DP_dateTime | When sent | ||||
![]() ![]() ![]() |
0..1 | dateTime | When received | |||||
![]() ![]() ![]() |
1..1 | DP_Reference_1or2a(Nphies Organization) | Message recipient | |||||
![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2a(Nphies Organization) | Message sender | ||||
![]() ![]() ![]() |
SΣ | 0..* | DP_CodeableConcept | Indication for message Binding: Communication Reason (required) | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Message payload Slice: Unordered, Open by type:$this.content | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_string | Message part content | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Attachment | Message part content | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Message payload | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_Reference_1or3b(Resource) | Message part content | ||||
![]() ![]() ![]() |
SC | 0..* | DP_Annotation | Comments made about the communication BV-00320: Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Communication.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Communication.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Communication.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard | ||||
Communication.category | required | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | ||||
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Communication.medium | required | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
Communication.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Communication.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Communication.subject.identifier.type | required | PatientIdentifierTypehttp://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG | ||||
Communication.topic | example | CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topic from the FHIR Standard | ||||
Communication.reasonCode | required | CommunicationReason (a valid code from Communication Reason)http://nphies.sa/terminology/ValueSet/communication-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00148 | error | Communication | The provided resource identifier in the about element is invalid : about.exists() | |
BV-00234 | error | Communication | About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count() | |
BV-00320 | error | Communication.note | Communication note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters : author.exists() implies author.length() <= 100 | |
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 Communication
Summary
Mandatory: 7 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron