Healthcare Financial Services IG Edition 1
0.3.0 - STU-Ballot Saudi Arabia flag

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

Resource Profile: Nphies Communication

Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/communication Version: 0.3.0
Draft as of 2025-07-30 Computable Name: NphiesCommunication

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Nphies Communication Profile

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: BV-00148, BV-00234
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 1..* DP_Identifier_A Unique identifier
... basedOn SΣ 0..* DP_Reference_1or3b(Resource) Request fulfilled by this communication
... status ?!Σ 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
... category S 0..* DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority SΣ 0..1 DP_code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium 0..* DP_CodeableConcept A channel of communication
Binding: ParticipationMode (required)
... subject SΣ 0..1 DP_Reference_1or2a(Nphies Patient) Focus of message
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
Max Length:250
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
.... display Σ 0..1 string Text alternative for the resource
Max Length:200
... about 1..1 DP_Reference_1or3b(Resource) Resources that pertain to this communication
... sent S 0..1 DP_dateTime When sent
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender S 0..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode SΣ 0..* DP_CodeableConcept Indication for message
Binding: Communication Reason (required)
... Slices for payload 1..* BackboneElement Message payload
Slice: Unordered, Open by type:$this.content
.... payload:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] 1..1 Message part content
...... contentString string
...... contentAttachment Attachment
...... contentReference Reference(Resource)
.... payload:string S 0..* BackboneElement Message payload
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_string Message part content
.... payload:attachment S 0..* BackboneElement Message payload
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_Attachment Message part content
.... payload:reference S 0..* BackboneElement Message payload
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_Reference_1or3b(Resource) Message part content
... note SC 0..* DP_Annotation Comments made about the communication
Constraints: BV-00320

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Communication.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Communication.categoryrequiredCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
From the FHIR Standard
Communication.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
Communication.mediumrequiredParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.subject.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Communication.subject.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
Communication.reasonCoderequiredCommunicationReason(a valid code from Communication Reason)
http://nphies.sa/terminology/ValueSet/communication-reason
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00148errorCommunicationThe provided resource identifier in the about element is invalid
: about.exists()
BV-00234errorCommunicationAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00320errorCommunication.noteCommunication 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-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf 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-4errorCommunicationIf 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-5errorCommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: BV-00148, BV-00234
... id 1..1 id Logical id of this artifact
Max Length:64
... meta 1..1 Meta Metadata about the resource
.... profile 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 1..* DP_Identifier_A Unique identifier
... status 1..1 DP_code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Required Pattern: completed
... category S 0..* DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority S 0..1 DP_code routine | urgent | asap | stat
... medium 0..* DP_CodeableConcept A channel of communication
Binding: ParticipationMode (required)
... subject S 0..1 DP_Reference_1or2a(Nphies Patient) Focus of message
.... identifier
..... type 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
... about 1..1 DP_Reference_1or3b(Resource) Resources that pertain to this communication
... sent S 0..1 DP_dateTime When sent
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender S 0..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode S 0..* DP_CodeableConcept Indication for message
Binding: Communication Reason (required)
... Slices for payload 1..* BackboneElement Message payload
Slice: Unordered, Open by type:$this.content
.... payload:string S 0..* BackboneElement Message payload
..... content[x] S 1..1 DP_string Message part content
.... payload:attachment S 0..* BackboneElement Message payload
..... content[x] S 1..1 DP_Attachment Message part content
.... payload:reference S 0..* BackboneElement Message payload
..... content[x] S 1..1 DP_Reference_1or3b(Resource) Message part content
... note SC 0..* DP_Annotation Comments made about the communication
Constraints: BV-00320

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Communication.categoryrequiredCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
From the FHIR Standard
Communication.mediumrequiredParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.subject.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
Communication.reasonCoderequiredCommunicationReason(a valid code from Communication Reason)
http://nphies.sa/terminology/ValueSet/communication-reason
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00148errorCommunicationThe provided resource identifier in the about element is invalid
: about.exists()
BV-00234errorCommunicationAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00320errorCommunication.noteCommunication 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
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: BV-00148, BV-00234
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* DP_Identifier_A Unique identifier
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* DP_Reference_1or3b(Resource) Request fulfilled by this communication
... partOf Σ 0..* Reference(Resource) Part of this action
... inResponseTo 0..* Reference(Communication) Reply to
... status ?!Σ 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
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
... category S 0..* DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority SΣ 0..1 DP_code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium 0..* DP_CodeableConcept A channel of communication
Binding: ParticipationMode (required)
... subject SΣ 0..1 DP_Reference_1or2a(Nphies Patient) Focus of message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
Max Length:250
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display Σ 0..1 string Text alternative for the resource
Max Length:200
... topic 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
... about 1..1 DP_Reference_1or3b(Resource) Resources that pertain to this communication
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... sent S 0..1 DP_dateTime When sent
... received 0..1 dateTime When received
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender S 0..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode SΣ 0..* DP_CodeableConcept Indication for message
Binding: Communication Reason (required)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why was communication done?
... Slices for payload 1..* BackboneElement Message payload
Slice: Unordered, Open by type:$this.content
.... payload:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] 1..1 Message part content
...... contentString string
...... contentAttachment Attachment
...... contentReference Reference(Resource)
.... payload:string S 0..* BackboneElement Message payload
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_string Message part content
.... payload:attachment S 0..* BackboneElement Message payload
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_Attachment Message part content
.... payload:reference S 0..* BackboneElement Message payload
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_Reference_1or3b(Resource) Message part content
... note SC 0..* DP_Annotation Comments made about the communication
Constraints: BV-00320

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Communication.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Communication.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Communication.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Communication.statusReasonexampleCommunicationNotDoneReason
http://hl7.org/fhir/ValueSet/communication-not-done-reason
From the FHIR Standard
Communication.categoryrequiredCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
From the FHIR Standard
Communication.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
Communication.mediumrequiredParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Communication.subject.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Communication.subject.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
Communication.topicexampleCommunicationTopic
http://hl7.org/fhir/ValueSet/communication-topic
From the FHIR Standard
Communication.reasonCoderequiredCommunicationReason(a valid code from Communication Reason)
http://nphies.sa/terminology/ValueSet/communication-reason
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00148errorCommunicationThe provided resource identifier in the about element is invalid
: about.exists()
BV-00234errorCommunicationAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00320errorCommunication.noteCommunication 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-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf 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-4errorCommunicationIf 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-5errorCommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: BV-00148, BV-00234
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 1..* DP_Identifier_A Unique identifier
... basedOn SΣ 0..* DP_Reference_1or3b(Resource) Request fulfilled by this communication
... status ?!Σ 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
... category S 0..* DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority SΣ 0..1 DP_code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium 0..* DP_CodeableConcept A channel of communication
Binding: ParticipationMode (required)
... subject SΣ 0..1 DP_Reference_1or2a(Nphies Patient) Focus of message
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
Max Length:250
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
.... display Σ 0..1 string Text alternative for the resource
Max Length:200
... about 1..1 DP_Reference_1or3b(Resource) Resources that pertain to this communication
... sent S 0..1 DP_dateTime When sent
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender S 0..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode SΣ 0..* DP_CodeableConcept Indication for message
Binding: Communication Reason (required)
... Slices for payload 1..* BackboneElement Message payload
Slice: Unordered, Open by type:$this.content
.... payload:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] 1..1 Message part content
...... contentString string
...... contentAttachment Attachment
...... contentReference Reference(Resource)
.... payload:string S 0..* BackboneElement Message payload
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_string Message part content
.... payload:attachment S 0..* BackboneElement Message payload
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_Attachment Message part content
.... payload:reference S 0..* BackboneElement Message payload
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_Reference_1or3b(Resource) Message part content
... note SC 0..* DP_Annotation Comments made about the communication
Constraints: BV-00320

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Communication.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Communication.categoryrequiredCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
From the FHIR Standard
Communication.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
Communication.mediumrequiredParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.subject.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Communication.subject.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
Communication.reasonCoderequiredCommunicationReason(a valid code from Communication Reason)
http://nphies.sa/terminology/ValueSet/communication-reason
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00148errorCommunicationThe provided resource identifier in the about element is invalid
: about.exists()
BV-00234errorCommunicationAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00320errorCommunication.noteCommunication 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-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf 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-4errorCommunicationIf 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-5errorCommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: BV-00148, BV-00234
... id 1..1 id Logical id of this artifact
Max Length:64
... meta 1..1 Meta Metadata about the resource
.... profile 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 1..* DP_Identifier_A Unique identifier
... status 1..1 DP_code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Required Pattern: completed
... category S 0..* DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority S 0..1 DP_code routine | urgent | asap | stat
... medium 0..* DP_CodeableConcept A channel of communication
Binding: ParticipationMode (required)
... subject S 0..1 DP_Reference_1or2a(Nphies Patient) Focus of message
.... identifier
..... type 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
... about 1..1 DP_Reference_1or3b(Resource) Resources that pertain to this communication
... sent S 0..1 DP_dateTime When sent
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender S 0..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode S 0..* DP_CodeableConcept Indication for message
Binding: Communication Reason (required)
... Slices for payload 1..* BackboneElement Message payload
Slice: Unordered, Open by type:$this.content
.... payload:string S 0..* BackboneElement Message payload
..... content[x] S 1..1 DP_string Message part content
.... payload:attachment S 0..* BackboneElement Message payload
..... content[x] S 1..1 DP_Attachment Message part content
.... payload:reference S 0..* BackboneElement Message payload
..... content[x] S 1..1 DP_Reference_1or3b(Resource) Message part content
... note SC 0..* DP_Annotation Comments made about the communication
Constraints: BV-00320

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Communication.categoryrequiredCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
From the FHIR Standard
Communication.mediumrequiredParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.subject.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
Communication.reasonCoderequiredCommunicationReason(a valid code from Communication Reason)
http://nphies.sa/terminology/ValueSet/communication-reason
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00148errorCommunicationThe provided resource identifier in the about element is invalid
: about.exists()
BV-00234errorCommunicationAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00320errorCommunication.noteCommunication 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

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: BV-00148, BV-00234
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* DP_Identifier_A Unique identifier
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* DP_Reference_1or3b(Resource) Request fulfilled by this communication
... partOf Σ 0..* Reference(Resource) Part of this action
... inResponseTo 0..* Reference(Communication) Reply to
... status ?!Σ 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
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
... category S 0..* DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority SΣ 0..1 DP_code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium 0..* DP_CodeableConcept A channel of communication
Binding: ParticipationMode (required)
... subject SΣ 0..1 DP_Reference_1or2a(Nphies Patient) Focus of message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
Max Length:250
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display Σ 0..1 string Text alternative for the resource
Max Length:200
... topic 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
... about 1..1 DP_Reference_1or3b(Resource) Resources that pertain to this communication
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... sent S 0..1 DP_dateTime When sent
... received 0..1 dateTime When received
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender S 0..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode SΣ 0..* DP_CodeableConcept Indication for message
Binding: Communication Reason (required)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why was communication done?
... Slices for payload 1..* BackboneElement Message payload
Slice: Unordered, Open by type:$this.content
.... payload:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] 1..1 Message part content
...... contentString string
...... contentAttachment Attachment
...... contentReference Reference(Resource)
.... payload:string S 0..* BackboneElement Message payload
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_string Message part content
.... payload:attachment S 0..* BackboneElement Message payload
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_Attachment Message part content
.... payload:reference S 0..* BackboneElement Message payload
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... content[x] S 1..1 DP_Reference_1or3b(Resource) Message part content
... note SC 0..* DP_Annotation Comments made about the communication
Constraints: BV-00320

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Communication.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Communication.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Communication.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Communication.statusReasonexampleCommunicationNotDoneReason
http://hl7.org/fhir/ValueSet/communication-not-done-reason
From the FHIR Standard
Communication.categoryrequiredCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
From the FHIR Standard
Communication.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
Communication.mediumrequiredParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Communication.subject.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Communication.subject.identifier.typerequiredPatientIdentifierType
http://nphies.sa/terminology/ValueSet/patient-identifier-type
From this IG
Communication.topicexampleCommunicationTopic
http://hl7.org/fhir/ValueSet/communication-topic
From the FHIR Standard
Communication.reasonCoderequiredCommunicationReason(a valid code from Communication Reason)
http://nphies.sa/terminology/ValueSet/communication-reason
From this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00148errorCommunicationThe provided resource identifier in the about element is invalid
: about.exists()
BV-00234errorCommunicationAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00320errorCommunication.noteCommunication 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-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf 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-4errorCommunicationIf 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-5errorCommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron