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 CommunicationRequest

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

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

Nphies CommunicationRequest Profile

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: BV-00233, BV-00335
... 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..1 DP_Identifier_A Unique identifier
... basedOn SΣ 0..* DP_Reference_1or3b(Resource) Fulfills plan or proposal
... status ?!Σ 1..1 DP_code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
Required Pattern: active
... category 1..1 DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority Σ 1..1 DP_code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... subject 1..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 request
... payload C 1..* BackboneElement Message payload
Constraints: CMRQ001
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Closed by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentString S 0..1 DP_string Message part content
..... content[x]:contentAttachment S 0..1 DP_Attachment Message part content
..... content[x]:contentReference S 0..1 DP_Reference_1or3b(Resource) Message part content
... Slices for occurrence[x] SΣ 0..1 When scheduled
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrence[x]:occurrenceDateTime SΣ 0..1 DP_dateTime When scheduled
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender Σ 1..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode SΣ 0..* DP_CodeableConcept Why is communication needed?
Binding: Communication Reason (required)
... note SC 0..* DP_Annotation Comments made about communication request
Constraints: BV-00319

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
BV-00233errorCommunicationRequestAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319errorCommunicationRequest.noteCommunicationRequest 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
BV-00335errorCommunicationRequestCommunicationRequest status MUST have the fixed value 'active'
: status = 'active'
CMRQ001errorCommunicationRequest.payloadcontent SHALL include only one of string, attachment and reference.
: content.exists() implies (content.ofType(string).exists() xor content.ofType(Attachment).exists() xor content.ofType(Reference).exists())
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationRequestA 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 CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: BV-00233, BV-00335
... 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..1 DP_Identifier_A Unique identifier
... status 1..1 DP_code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required Pattern: active
... category 1..1 DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority 1..1 DP_code routine | urgent | asap | stat
... subject 1..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 request
... payload C 1..* BackboneElement Message payload
Constraints: CMRQ001
.... Slices for content[x] 1..1 string, Attachment, Reference(Resource) Message part content
Slice: Unordered, Open by type:$this
..... content[x]:contentString S 0..1 DP_string Message part content
..... content[x]:contentAttachment S 0..1 DP_Attachment Message part content
..... content[x]:contentReference S 0..1 DP_Reference_1or3b(Resource) Message part content
... Slices for occurrence[x] S 0..1 dateTime, Period When scheduled
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 DP_dateTime When scheduled
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender 1..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode S 0..* DP_CodeableConcept Why is communication needed?
Binding: Communication Reason (required)
... note SC 0..* DP_Annotation Comments made about communication request
Constraints: BV-00319

doco Documentation for this format

Terminology Bindings (Differential)

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

Constraints

IdGradePath(s)DetailsRequirements
BV-00233errorCommunicationRequestAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319errorCommunicationRequest.noteCommunicationRequest 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
BV-00335errorCommunicationRequestCommunicationRequest status MUST have the fixed value 'active'
: status = 'active'
CMRQ001errorCommunicationRequest.payloadcontent SHALL include only one of string, attachment and reference.
: content.exists() implies (content.ofType(string).exists() xor content.ofType(Attachment).exists() xor content.ofType(Reference).exists())
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: BV-00233, BV-00335
... 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..1 DP_Identifier_A Unique identifier
... basedOn SΣ 0..* DP_Reference_1or3b(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 DP_code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
Required Pattern: active
... statusReason 0..1 CodeableConcept Reason for current status
Binding Description: (example): Codes identifying the reason for the current state of a request.
... category 1..1 DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority Σ 1..1 DP_code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
... subject 1..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
... about 1..1 DP_Reference_1or3b(Resource) Resources that pertain to this communication request
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... payload C 1..* BackboneElement Message payload
Constraints: CMRQ001
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Closed by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentString S 0..1 DP_string Message part content
..... content[x]:contentAttachment S 0..1 DP_Attachment Message part content
..... content[x]:contentReference S 0..1 DP_Reference_1or3b(Resource) Message part content
... Slices for occurrence[x] SΣ 0..1 When scheduled
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrence[x]:occurrenceDateTime SΣ 0..1 DP_dateTime When scheduled
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender Σ 1..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode SΣ 0..* DP_CodeableConcept Why is communication needed?
Binding: Communication Reason (required)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note SC 0..* DP_Annotation Comments made about communication request
Constraints: BV-00319

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
BV-00233errorCommunicationRequestAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319errorCommunicationRequest.noteCommunicationRequest 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
BV-00335errorCommunicationRequestCommunicationRequest status MUST have the fixed value 'active'
: status = 'active'
CMRQ001errorCommunicationRequest.payloadcontent SHALL include only one of string, attachment and reference.
: content.exists() implies (content.ofType(string).exists() xor content.ofType(Attachment).exists() xor content.ofType(Reference).exists())
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationRequestA 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
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: BV-00233, BV-00335
... 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..1 DP_Identifier_A Unique identifier
... basedOn SΣ 0..* DP_Reference_1or3b(Resource) Fulfills plan or proposal
... status ?!Σ 1..1 DP_code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
Required Pattern: active
... category 1..1 DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority Σ 1..1 DP_code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... subject 1..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 request
... payload C 1..* BackboneElement Message payload
Constraints: CMRQ001
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Closed by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentString S 0..1 DP_string Message part content
..... content[x]:contentAttachment S 0..1 DP_Attachment Message part content
..... content[x]:contentReference S 0..1 DP_Reference_1or3b(Resource) Message part content
... Slices for occurrence[x] SΣ 0..1 When scheduled
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrence[x]:occurrenceDateTime SΣ 0..1 DP_dateTime When scheduled
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender Σ 1..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode SΣ 0..* DP_CodeableConcept Why is communication needed?
Binding: Communication Reason (required)
... note SC 0..* DP_Annotation Comments made about communication request
Constraints: BV-00319

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
BV-00233errorCommunicationRequestAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319errorCommunicationRequest.noteCommunicationRequest 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
BV-00335errorCommunicationRequestCommunicationRequest status MUST have the fixed value 'active'
: status = 'active'
CMRQ001errorCommunicationRequest.payloadcontent SHALL include only one of string, attachment and reference.
: content.exists() implies (content.ofType(string).exists() xor content.ofType(Attachment).exists() xor content.ofType(Reference).exists())
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationRequestA 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 CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: BV-00233, BV-00335
... 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..1 DP_Identifier_A Unique identifier
... status 1..1 DP_code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required Pattern: active
... category 1..1 DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority 1..1 DP_code routine | urgent | asap | stat
... subject 1..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 request
... payload C 1..* BackboneElement Message payload
Constraints: CMRQ001
.... Slices for content[x] 1..1 string, Attachment, Reference(Resource) Message part content
Slice: Unordered, Open by type:$this
..... content[x]:contentString S 0..1 DP_string Message part content
..... content[x]:contentAttachment S 0..1 DP_Attachment Message part content
..... content[x]:contentReference S 0..1 DP_Reference_1or3b(Resource) Message part content
... Slices for occurrence[x] S 0..1 dateTime, Period When scheduled
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 DP_dateTime When scheduled
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender 1..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode S 0..* DP_CodeableConcept Why is communication needed?
Binding: Communication Reason (required)
... note SC 0..* DP_Annotation Comments made about communication request
Constraints: BV-00319

doco Documentation for this format

Terminology Bindings (Differential)

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

Constraints

IdGradePath(s)DetailsRequirements
BV-00233errorCommunicationRequestAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319errorCommunicationRequest.noteCommunicationRequest 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
BV-00335errorCommunicationRequestCommunicationRequest status MUST have the fixed value 'active'
: status = 'active'
CMRQ001errorCommunicationRequest.payloadcontent SHALL include only one of string, attachment and reference.
: content.exists() implies (content.ofType(string).exists() xor content.ofType(Attachment).exists() xor content.ofType(Reference).exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: BV-00233, BV-00335
... 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..1 DP_Identifier_A Unique identifier
... basedOn SΣ 0..* DP_Reference_1or3b(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 DP_code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
Required Pattern: active
... statusReason 0..1 CodeableConcept Reason for current status
Binding Description: (example): Codes identifying the reason for the current state of a request.
... category 1..1 DP_CodeableConcept Message category
Binding: CommunicationCategory (required)
... priority Σ 1..1 DP_code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
... subject 1..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
... about 1..1 DP_Reference_1or3b(Resource) Resources that pertain to this communication request
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... payload C 1..* BackboneElement Message payload
Constraints: CMRQ001
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Closed by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentString S 0..1 DP_string Message part content
..... content[x]:contentAttachment S 0..1 DP_Attachment Message part content
..... content[x]:contentReference S 0..1 DP_Reference_1or3b(Resource) Message part content
... Slices for occurrence[x] SΣ 0..1 When scheduled
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrence[x]:occurrenceDateTime SΣ 0..1 DP_dateTime When scheduled
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... recipient 1..1 DP_Reference_1or2a(Nphies Organization) Message recipient
... sender Σ 1..1 DP_Reference_1or2a(Nphies Organization) Message sender
... reasonCode SΣ 0..* DP_CodeableConcept Why is communication needed?
Binding: Communication Reason (required)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note SC 0..* DP_Annotation Comments made about communication request
Constraints: BV-00319

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
BV-00233errorCommunicationRequestAbout element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization'
: about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319errorCommunicationRequest.noteCommunicationRequest 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
BV-00335errorCommunicationRequestCommunicationRequest status MUST have the fixed value 'active'
: status = 'active'
CMRQ001errorCommunicationRequest.payloadcontent SHALL include only one of string, attachment and reference.
: content.exists() implies (content.ofType(string).exists() xor content.ofType(Attachment).exists() xor content.ofType(Reference).exists())
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationRequestA 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