Kenya Core Implementation Guide
1.0.0 - release Kenya flag

Kenya Core Implementation Guide, published by Digital Health Agency (DHA), Kenya. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Kenya-core-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: Kenya Core CommunicationRequest Profile

Official URL: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-communicationrequest Version: 1.0.0
Active as of 2026-08-11 Computable Name: KenyaCoreCommunicationRequest

Kenya Core profile for a request to convey information, e.g. a request to notify a patient of results, or to arrange a follow-up call.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-communicationrequest|1.0.0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 0..* Identifier Unique identifier
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... category S 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... priority SΣ 0..1 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 S 1..1 Reference(KenyaCore Patient Profile) Patient the communication request is about
... encounter SΣ 0..1 Reference(Kenya Core Encounter Profile) Encounter created as part of communication request
... payload S 0..* BackboneElement Message content to send
.... 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)
... occurrence[x] SΣ 0..1 When scheduled to occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn SΣ 0..1 dateTime When request transitioned to being actionable
... requester SΣ 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile) Who/what is requesting the communication
... recipient S 0..* Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core RelatedPerson Profile) Message recipient
... sender SΣ 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile) Message sender
... reasonCode SΣ 0..* CodeableConcept Why is communication needed
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... note S 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
CommunicationRequest.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
CommunicationRequest.​priority Base required Request priority 📍4.0.1 FHIR Std.
CommunicationRequest.​reasonCode Base example v3 Code System ActReason 📦3.0.0 THO v7.3

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id S 1..1 id Logical id of this artifact
... meta S 1..1 Meta Metadata about the resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-communicationrequest|1.0.0
... identifier S 0..* Identifier Unique identifier
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 1..1 CodeableConcept Description of identifier
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... category S 0..* CodeableConcept Message category
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... priority S 0..1 code routine | urgent | asap | stat
... subject S 1..1 Reference(KenyaCore Patient Profile) Patient the communication request is about
... encounter S 0..1 Reference(Kenya Core Encounter Profile) Encounter created as part of communication request
... payload S 0..* BackboneElement Message content to send
... occurrence[x] S 0..1 dateTime, Period When scheduled to occur
... authoredOn S 0..1 dateTime When request transitioned to being actionable
... requester S 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile) Who/what is requesting the communication
... recipient S 0..* Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core RelatedPerson Profile) Message recipient
... sender S 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile) Message sender
... reasonCode S 0..* CodeableConcept Why is communication needed
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... note S 0..* Annotation Comments made about communication request

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 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..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-communicationrequest|1.0.0
.... 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 SΣ 0..* Identifier Unique identifier
.... 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 ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... 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)
... basedOn Σ 0..* Reference(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 ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... statusReason 0..1 CodeableConcept Reason for current status
Binding Description: (example): Codes identifying the reason for the current state of a request.
... category S 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... priority SΣ 0..1 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 S 1..1 Reference(KenyaCore Patient Profile) Patient the communication request is about
... about 0..* Reference(Resource) Resources that pertain to this communication request
... encounter SΣ 0..1 Reference(Kenya Core Encounter Profile) Encounter created as part of communication request
... payload S 0..* BackboneElement Message content to send
.... 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)
... occurrence[x] SΣ 0..1 When scheduled to occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn SΣ 0..1 dateTime When request transitioned to being actionable
... requester SΣ 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile) Who/what is requesting the communication
... recipient S 0..* Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core RelatedPerson Profile) Message recipient
... sender SΣ 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile) Message sender
... reasonCode SΣ 0..* CodeableConcept Why is communication needed
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note S 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
CommunicationRequest.​meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CommunicationRequest.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
CommunicationRequest.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
CommunicationRequest.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
CommunicationRequest.​statusReason Base example Not State Unknown
CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
CommunicationRequest.​priority Base required Request priority 📍4.0.1 FHIR Std.
CommunicationRequest.​medium Base example ParticipationMode 📦3.0.0 THO v7.3
CommunicationRequest.​reasonCode Base example v3 Code System ActReason 📦3.0.0 THO v7.3

Constraints

Id Grade Path(s) Description Expression
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-communicationrequest|1.0.0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 0..* Identifier Unique identifier
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... category S 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... priority SΣ 0..1 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 S 1..1 Reference(KenyaCore Patient Profile) Patient the communication request is about
... encounter SΣ 0..1 Reference(Kenya Core Encounter Profile) Encounter created as part of communication request
... payload S 0..* BackboneElement Message content to send
.... 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)
... occurrence[x] SΣ 0..1 When scheduled to occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn SΣ 0..1 dateTime When request transitioned to being actionable
... requester SΣ 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile) Who/what is requesting the communication
... recipient S 0..* Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core RelatedPerson Profile) Message recipient
... sender SΣ 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile) Message sender
... reasonCode SΣ 0..* CodeableConcept Why is communication needed
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... note S 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
CommunicationRequest.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
CommunicationRequest.​priority Base required Request priority 📍4.0.1 FHIR Std.
CommunicationRequest.​reasonCode Base example v3 Code System ActReason 📦3.0.0 THO v7.3

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id S 1..1 id Logical id of this artifact
... meta S 1..1 Meta Metadata about the resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-communicationrequest|1.0.0
... identifier S 0..* Identifier Unique identifier
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 1..1 CodeableConcept Description of identifier
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... category S 0..* CodeableConcept Message category
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... priority S 0..1 code routine | urgent | asap | stat
... subject S 1..1 Reference(KenyaCore Patient Profile) Patient the communication request is about
... encounter S 0..1 Reference(Kenya Core Encounter Profile) Encounter created as part of communication request
... payload S 0..* BackboneElement Message content to send
... occurrence[x] S 0..1 dateTime, Period When scheduled to occur
... authoredOn S 0..1 dateTime When request transitioned to being actionable
... requester S 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile) Who/what is requesting the communication
... recipient S 0..* Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core RelatedPerson Profile) Message recipient
... sender S 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile) Message sender
... reasonCode S 0..* CodeableConcept Why is communication needed
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... note S 0..* Annotation Comments made about communication request

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 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..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-communicationrequest|1.0.0
.... 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 SΣ 0..* Identifier Unique identifier
.... 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 ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... 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)
... basedOn Σ 0..* Reference(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 ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... statusReason 0..1 CodeableConcept Reason for current status
Binding Description: (example): Codes identifying the reason for the current state of a request.
... category S 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... priority SΣ 0..1 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 S 1..1 Reference(KenyaCore Patient Profile) Patient the communication request is about
... about 0..* Reference(Resource) Resources that pertain to this communication request
... encounter SΣ 0..1 Reference(Kenya Core Encounter Profile) Encounter created as part of communication request
... payload S 0..* BackboneElement Message content to send
.... 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)
... occurrence[x] SΣ 0..1 When scheduled to occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn SΣ 0..1 dateTime When request transitioned to being actionable
... requester SΣ 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile) Who/what is requesting the communication
... recipient S 0..* Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core RelatedPerson Profile) Message recipient
... sender SΣ 0..1 Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile) Message sender
... reasonCode SΣ 0..* CodeableConcept Why is communication needed
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note S 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
CommunicationRequest.​meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CommunicationRequest.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
CommunicationRequest.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
CommunicationRequest.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
CommunicationRequest.​statusReason Base example Not State Unknown
CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
CommunicationRequest.​priority Base required Request priority 📍4.0.1 FHIR Std.
CommunicationRequest.​medium Base example ParticipationMode 📦3.0.0 THO v7.3
CommunicationRequest.​reasonCode Base example v3 Code System ActReason 📦3.0.0 THO v7.3

Constraints

Id Grade Path(s) Description Expression
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()

 

Other representations of profile: CSV, Excel, Schematron