Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver BV-00233: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' BV-00335: CommunicationRequest status MUST have the fixed value 'active'
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
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 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 CMRQ001: content SHALL include only one of string, attachment and reference.
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 BV-00319: CommunicationRequest note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CommunicationRequest.category	required	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
CommunicationRequest.subject.identifier.type	required	PatientIdentifierType http://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG
CommunicationRequest.reasonCode	required	CommunicationReason (a valid code from Communication Reason) http://nphies.sa/terminology/ValueSet/communication-reason from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00233	error	CommunicationRequest	About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319	error	CommunicationRequest.note	CommunicationRequest 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-00335	error	CommunicationRequest	CommunicationRequest status MUST have the fixed value 'active' : status = 'active'
CMRQ001	error	CommunicationRequest.payload	content 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())

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent 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-00233: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' BV-00335: CommunicationRequest status MUST have the fixed value 'active'
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	DP_Identifier_A	Unique identifier ele-1: All FHIR elements must have a @value or children
basedOn	SΣ	0..*	DP_Reference_1or3b(Resource)	Fulfills plan or proposal ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	DP_code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. ele-1: All FHIR elements must have a @value or children Required Pattern: active
category		1..1	DP_CodeableConcept	Message category Binding: CommunicationCategory (required) ele-1: All FHIR elements must have a @value or children
priority	Σ	1..1	DP_code	routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. ele-1: All FHIR elements must have a @value or children
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action ele-1: All FHIR elements must have a @value or children
subject		1..1	DP_Reference_1or2a(Nphies Patient)	Focus of message ele-1: All FHIR elements must have a @value or children
reference	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
identifier	SΣ	0..1	Identifier	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
use	?!Σ	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
type	Σ	1..1	DP_CodeableConcept	Description of identifier Binding: Patient Identifier Type (required) ele-1: All FHIR elements must have a @value or children
system	Σ	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
value	Σ	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
display	Σ	0..1	string	Text alternative for the resource ele-1: All FHIR elements must have a @value or children Max Length:200
about		1..1	DP_Reference_1or3b(Resource)	Resources that pertain to this communication request ele-1: All FHIR elements must have a @value or children
payload	C	1..*	BackboneElement	Message payload ele-1: All FHIR elements must have a @value or children CMRQ001: content SHALL include only one of string, attachment and reference.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for content[x]		1..1		Message part content Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
content[x]:contentString	S	0..1	DP_string	Message part content ele-1: All FHIR elements must have a @value or children
content[x]:contentAttachment	S	0..1	DP_Attachment	Message part content ele-1: All FHIR elements must have a @value or children
content[x]:contentReference	S	0..1	DP_Reference_1or3b(Resource)	Message part content ele-1: All FHIR elements must have a @value or children
Slices for occurrence[x]	SΣ	0..1		When scheduled Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrence[x]:occurrenceDateTime	SΣ	0..1	DP_dateTime	When scheduled ele-1: All FHIR elements must have a @value or children
recipient		1..1	DP_Reference_1or2a(Nphies Organization)	Message recipient ele-1: All FHIR elements must have a @value or children
sender	Σ	1..1	DP_Reference_1or2a(Nphies Organization)	Message sender ele-1: All FHIR elements must have a @value or children
reasonCode	SΣ	0..*	DP_CodeableConcept	Why is communication needed? Binding: Communication Reason (required) ele-1: All FHIR elements must have a @value or children
note	SC	0..*	DP_Annotation	Comments made about communication request ele-1: All FHIR elements must have a @value or children BV-00319: CommunicationRequest note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CommunicationRequest.status	required	Pattern: active http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CommunicationRequest.category	required	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
CommunicationRequest.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
CommunicationRequest.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CommunicationRequest.subject.identifier.type	required	PatientIdentifierType http://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG
CommunicationRequest.reasonCode	required	CommunicationReason (a valid code from Communication Reason) http://nphies.sa/terminology/ValueSet/communication-reason from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00233	error	CommunicationRequest	About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319	error	CommunicationRequest.note	CommunicationRequest 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-00335	error	CommunicationRequest	CommunicationRequest status MUST have the fixed value 'active' : status = 'active'
CMRQ001	error	CommunicationRequest.payload	content 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-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CommunicationRequest	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	CommunicationRequest	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	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CommunicationRequest	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
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver BV-00233: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' BV-00335: CommunicationRequest status MUST have the fixed value 'active'
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 Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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 (No ValueSet): (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 CMRQ001: content SHALL include only one of string, attachment and reference.
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 BV-00319: CommunicationRequest note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CommunicationRequest.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
CommunicationRequest.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CommunicationRequest.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CommunicationRequest.status	required	Pattern: active http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CommunicationRequest.statusReason	example
CommunicationRequest.category	required	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
CommunicationRequest.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
CommunicationRequest.medium	example	ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
CommunicationRequest.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CommunicationRequest.subject.identifier.type	required	PatientIdentifierType http://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG
CommunicationRequest.reasonCode	required	CommunicationReason (a valid code from Communication Reason) http://nphies.sa/terminology/ValueSet/communication-reason from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00233	error	CommunicationRequest	About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319	error	CommunicationRequest.note	CommunicationRequest 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-00335	error	CommunicationRequest	CommunicationRequest status MUST have the fixed value 'active' : status = 'active'
CMRQ001	error	CommunicationRequest.payload	content 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-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CommunicationRequest	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	CommunicationRequest	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	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CommunicationRequest	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()

Summary

Mandatory: 11 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• DP_canonical (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-canonical)
• DP_Identifier_A (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Identifier-A)
• DP_Reference_1or3b (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or3b)
• DP_code (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-code)
• DP_CodeableConcept (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-CodeableConcept)
• DP_Reference_1or2a (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or2a)
• Nphies Patient (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/patient)
• DP_string (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-string)
• DP_Attachment (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Attachment)
• DP_dateTime (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-dateTime)
• Nphies Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/organization)
• DP_Annotation (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Annotation)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CommunicationRequest.payload.content[x]
• The element 1 is sliced based on the value of CommunicationRequest.occurrence[x]

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver BV-00233: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' BV-00335: CommunicationRequest status MUST have the fixed value 'active'
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
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 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 CMRQ001: content SHALL include only one of string, attachment and reference.
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 BV-00319: CommunicationRequest note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CommunicationRequest.category	required	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
CommunicationRequest.subject.identifier.type	required	PatientIdentifierType http://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG
CommunicationRequest.reasonCode	required	CommunicationReason (a valid code from Communication Reason) http://nphies.sa/terminology/ValueSet/communication-reason from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00233	error	CommunicationRequest	About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319	error	CommunicationRequest.note	CommunicationRequest 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-00335	error	CommunicationRequest	CommunicationRequest status MUST have the fixed value 'active' : status = 'active'
CMRQ001	error	CommunicationRequest.payload	content 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())

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent 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-00233: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' BV-00335: CommunicationRequest status MUST have the fixed value 'active'
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	DP_Identifier_A	Unique identifier ele-1: All FHIR elements must have a @value or children
basedOn	SΣ	0..*	DP_Reference_1or3b(Resource)	Fulfills plan or proposal ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	DP_code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. ele-1: All FHIR elements must have a @value or children Required Pattern: active
category		1..1	DP_CodeableConcept	Message category Binding: CommunicationCategory (required) ele-1: All FHIR elements must have a @value or children
priority	Σ	1..1	DP_code	routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. ele-1: All FHIR elements must have a @value or children
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action ele-1: All FHIR elements must have a @value or children
subject		1..1	DP_Reference_1or2a(Nphies Patient)	Focus of message ele-1: All FHIR elements must have a @value or children
reference	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
identifier	SΣ	0..1	Identifier	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
use	?!Σ	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
type	Σ	1..1	DP_CodeableConcept	Description of identifier Binding: Patient Identifier Type (required) ele-1: All FHIR elements must have a @value or children
system	Σ	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
value	Σ	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
display	Σ	0..1	string	Text alternative for the resource ele-1: All FHIR elements must have a @value or children Max Length:200
about		1..1	DP_Reference_1or3b(Resource)	Resources that pertain to this communication request ele-1: All FHIR elements must have a @value or children
payload	C	1..*	BackboneElement	Message payload ele-1: All FHIR elements must have a @value or children CMRQ001: content SHALL include only one of string, attachment and reference.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for content[x]		1..1		Message part content Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
content[x]:contentString	S	0..1	DP_string	Message part content ele-1: All FHIR elements must have a @value or children
content[x]:contentAttachment	S	0..1	DP_Attachment	Message part content ele-1: All FHIR elements must have a @value or children
content[x]:contentReference	S	0..1	DP_Reference_1or3b(Resource)	Message part content ele-1: All FHIR elements must have a @value or children
Slices for occurrence[x]	SΣ	0..1		When scheduled Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrence[x]:occurrenceDateTime	SΣ	0..1	DP_dateTime	When scheduled ele-1: All FHIR elements must have a @value or children
recipient		1..1	DP_Reference_1or2a(Nphies Organization)	Message recipient ele-1: All FHIR elements must have a @value or children
sender	Σ	1..1	DP_Reference_1or2a(Nphies Organization)	Message sender ele-1: All FHIR elements must have a @value or children
reasonCode	SΣ	0..*	DP_CodeableConcept	Why is communication needed? Binding: Communication Reason (required) ele-1: All FHIR elements must have a @value or children
note	SC	0..*	DP_Annotation	Comments made about communication request ele-1: All FHIR elements must have a @value or children BV-00319: CommunicationRequest note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CommunicationRequest.status	required	Pattern: active http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CommunicationRequest.category	required	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
CommunicationRequest.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
CommunicationRequest.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CommunicationRequest.subject.identifier.type	required	PatientIdentifierType http://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG
CommunicationRequest.reasonCode	required	CommunicationReason (a valid code from Communication Reason) http://nphies.sa/terminology/ValueSet/communication-reason from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00233	error	CommunicationRequest	About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319	error	CommunicationRequest.note	CommunicationRequest 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-00335	error	CommunicationRequest	CommunicationRequest status MUST have the fixed value 'active' : status = 'active'
CMRQ001	error	CommunicationRequest.payload	content 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-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CommunicationRequest	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	CommunicationRequest	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	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CommunicationRequest	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
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver BV-00233: About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' BV-00335: CommunicationRequest status MUST have the fixed value 'active'
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 Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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 (No ValueSet): (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 CMRQ001: content SHALL include only one of string, attachment and reference.
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 BV-00319: CommunicationRequest note authorString value length is longer than the maximum specified length of 100 English characters and 50 Arabic characters
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CommunicationRequest.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
CommunicationRequest.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CommunicationRequest.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CommunicationRequest.status	required	Pattern: active http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CommunicationRequest.statusReason	example
CommunicationRequest.category	required	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
CommunicationRequest.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
CommunicationRequest.medium	example	ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
CommunicationRequest.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CommunicationRequest.subject.identifier.type	required	PatientIdentifierType http://nphies.sa/terminology/ValueSet/patient-identifier-type from this IG
CommunicationRequest.reasonCode	required	CommunicationReason (a valid code from Communication Reason) http://nphies.sa/terminology/ValueSet/communication-reason from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00233	error	CommunicationRequest	About element in the CommunicationRequest is not 'Claim' or 'Advanced Authorization' : about.count() = about.where(type = 'Claim').count() + about.where(type = 'ClaimResponse').count()
BV-00319	error	CommunicationRequest.note	CommunicationRequest 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-00335	error	CommunicationRequest	CommunicationRequest status MUST have the fixed value 'active' : status = 'active'
CMRQ001	error	CommunicationRequest.payload	content 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-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CommunicationRequest	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	CommunicationRequest	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	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	CommunicationRequest	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()

Summary

Mandatory: 11 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• DP_canonical (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-canonical)
• DP_Identifier_A (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Identifier-A)
• DP_Reference_1or3b (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or3b)
• DP_code (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-code)
• DP_CodeableConcept (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-CodeableConcept)
• DP_Reference_1or2a (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or2a)
• Nphies Patient (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/patient)
• DP_string (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-string)
• DP_Attachment (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Attachment)
• DP_dateTime (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-dateTime)
• Nphies Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/organization)
• DP_Annotation (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Annotation)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CommunicationRequest.payload.content[x]
• The element 1 is sliced based on the value of CommunicationRequest.occurrence[x]