HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
0.1.0 -
HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
0.1.0 -
HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-communication-request | Version: 0.1.0 | |||
| Active as of 2026-08-12 | Computable Name: ZMCoreCommunicationRequest | |||
A governed request from a Ministry health system to the Unified Health Communication Hub to route and deliver information.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and their representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
6..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:dataClassification |
S | 1..1 | CodeableConcept | Communication Data Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification Binding: Zambia Communication Data Classification Value Set (required) |
| extension:fallbackChannel |
S | 0..* | CodeableConcept | Communication Fallback Channel URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-fallback-channel Binding: Zambia Communication Channel Value Set (required) |
| extension:approvedTemplate |
S | 1..1 | Identifier | Approved Communication Template URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template |
| extension:messageLanguage |
S | 1..1 | code | Communication Message Language URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language Binding: AllLanguages (required) |
| extension:acknowledgementRequired |
S | 1..1 | boolean | Communication Acknowledgement Required URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-acknowledgement-required |
| extension:expiry |
S | 1..1 | instant | Communication Expiry URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-expiry |
 extension:requestingSystem |
S | 1..1 | Reference(Organization | Device) | Communication Requesting System URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-requesting-system |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 1..* | Identifier | Unique identifier |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
 value |
SΣC | 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. |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request. |
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. |
| category |
S | 1..* | CodeableConcept | Message category Binding: Zambia Communication Lane Value Set (required) |
| priority |
SΣ | 1..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 |
S | 1..1 | CodeableConcept | A channel of communication Binding: Zambia Communication Channel Value Set (required) |
 subject |
S | 0..1 | Reference(Patient | Group) | Focus of message |
| about |
S | 0..* | Reference(Resource) | Resources that pertain to this communication request |
| encounter |
SΣ | 0..1 | Reference(Encounter) | The Encounter during which this CommunicationRequest was created |
| payload |
S | 1..* | BackboneElement | Message payload |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
  content[x] |
S | 1..1 | Message part content | |
 contentAttachment |
Attachment | |||
| contentReference |
Reference(Resource) | |||
| contentCodeableConcept |
CodeableConcept | |||
| occurrence[x] |
SΣ | 1..1 | When scheduled | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| authoredOn |
SΣ | 1..1 | dateTime | When request transitioned to being actionable |
| requester |
SΣ | 1..1 | Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile) | Who asks for the information to be shared |
| recipient |
S | 1..* | Reference(ZM-Core Patient Profile | ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Recipient Group Profile | ZM-Core Healthcare Service Profile | CareTeam | RelatedPerson) | Who to share the information with |
| informationProvider |
SΣ | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) | Who should share the information |
| reason |
SΣ | 1..* | CodeableReference(Resource) | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. |
| note |
S | 0..* | Annotation | Comments made about communication request |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | CommunicationRequest Status Reason | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.category | Base | required | Zambia Communication Lane Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.medium | Base | required | Zambia Communication Channel Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.reason | Base | example | v3 Code System ActReason | 📦3.0.0 | THO v7.1 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.category | Base | required | Zambia Communication Lane Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.medium | Base | required | Zambia Communication Channel Value Set | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| Slices for extension |
6..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:dataClassification |
S | 1..1 | CodeableConcept | Communication Data Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification Binding: Zambia Communication Data Classification Value Set (required) | ||||
| extension:fallbackChannel |
S | 0..* | CodeableConcept | Communication Fallback Channel URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-fallback-channel Binding: Zambia Communication Channel Value Set (required) | ||||
| extension:approvedTemplate |
S | 1..1 | Identifier | Approved Communication Template URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template | ||||
| extension:messageLanguage |
S | 1..1 | code | Communication Message Language URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language Binding: AllLanguages (required) | ||||
| extension:acknowledgementRequired |
S | 1..1 | boolean | Communication Acknowledgement Required URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-acknowledgement-required | ||||
| extension:expiry |
S | 1..1 | instant | Communication Expiry URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-expiry | ||||
| extension:requestingSystem |
S | 1..1 | Reference(Organization | Device) | Communication Requesting System URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-requesting-system | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..* | Identifier | Unique identifier | ||||
| id |
0..1 | id | 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 |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (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ΣC | 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 |
S | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request. | ||||
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | ||||
| category |
S | 1..* | CodeableConcept | Message category Binding: Zambia Communication Lane Value Set (required) | ||||
| priority |
SΣ | 1..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 |
S | 1..1 | CodeableConcept | A channel of communication Binding: Zambia Communication Channel Value Set (required) | ||||
| subject |
S | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| about |
S | 0..* | Reference(Resource) | Resources that pertain to this communication request | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | The Encounter during which this CommunicationRequest was created | ||||
| payload |
S | 1..* | BackboneElement | Message payload | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
S | 1..1 | Message part content | |||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| contentCodeableConcept |
CodeableConcept | |||||||
| occurrence[x] |
SΣ | 1..1 | When scheduled | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| authoredOn |
SΣ | 1..1 | dateTime | When request transitioned to being actionable | ||||
| requester |
SΣ | 1..1 | Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile) | Who asks for the information to be shared | ||||
| recipient |
S | 1..* | Reference(ZM-Core Patient Profile | ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Recipient Group Profile | ZM-Core Healthcare Service Profile | CareTeam | RelatedPerson) | Who to share the information with | ||||
| informationProvider |
SΣ | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) | Who should share the information | ||||
| reason |
SΣ | 1..* | CodeableReference(Resource) | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
| note |
S | 0..* | Annotation | Comments made about communication request | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | CommunicationRequest Status Reason | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.category | Base | required | Zambia Communication Lane Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.medium | Base | required | Zambia Communication Channel Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.reason | Base | example | v3 Code System ActReason | 📦3.0.0 | THO v7.1 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 18 elements
Must-Support: 28 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
6..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:dataClassification |
S | 1..1 | CodeableConcept | Communication Data Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification Binding: Zambia Communication Data Classification Value Set (required) |
| extension:fallbackChannel |
S | 0..* | CodeableConcept | Communication Fallback Channel URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-fallback-channel Binding: Zambia Communication Channel Value Set (required) |
| extension:approvedTemplate |
S | 1..1 | Identifier | Approved Communication Template URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template |
| extension:messageLanguage |
S | 1..1 | code | Communication Message Language URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language Binding: AllLanguages (required) |
| extension:acknowledgementRequired |
S | 1..1 | boolean | Communication Acknowledgement Required URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-acknowledgement-required |
| extension:expiry |
S | 1..1 | instant | Communication Expiry URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-expiry |
| extension:requestingSystem |
S | 1..1 | Reference(Organization | Device) | Communication Requesting System URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-requesting-system |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..* | Identifier | Unique identifier |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣC | 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. |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request. |
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. |
| category |
S | 1..* | CodeableConcept | Message category Binding: Zambia Communication Lane Value Set (required) |
| priority |
SΣ | 1..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 |
S | 1..1 | CodeableConcept | A channel of communication Binding: Zambia Communication Channel Value Set (required) |
| subject |
S | 0..1 | Reference(Patient | Group) | Focus of message |
| about |
S | 0..* | Reference(Resource) | Resources that pertain to this communication request |
| encounter |
SΣ | 0..1 | Reference(Encounter) | The Encounter during which this CommunicationRequest was created |
| payload |
S | 1..* | BackboneElement | Message payload |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| content[x] |
S | 1..1 | Message part content | |
| contentAttachment |
Attachment | |||
| contentReference |
Reference(Resource) | |||
| contentCodeableConcept |
CodeableConcept | |||
| occurrence[x] |
SΣ | 1..1 | When scheduled | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| authoredOn |
SΣ | 1..1 | dateTime | When request transitioned to being actionable |
| requester |
SΣ | 1..1 | Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile) | Who asks for the information to be shared |
| recipient |
S | 1..* | Reference(ZM-Core Patient Profile | ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Recipient Group Profile | ZM-Core Healthcare Service Profile | CareTeam | RelatedPerson) | Who to share the information with |
| informationProvider |
SΣ | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) | Who should share the information |
| reason |
SΣ | 1..* | CodeableReference(Resource) | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. |
| note |
S | 0..* | Annotation | Comments made about communication request |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | CommunicationRequest Status Reason | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.category | Base | required | Zambia Communication Lane Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.medium | Base | required | Zambia Communication Channel Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.reason | Base | example | v3 Code System ActReason | 📦3.0.0 | THO v7.1 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.category | Base | required | Zambia Communication Lane Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.medium | Base | required | Zambia Communication Channel Value Set | 📦0.1.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| Slices for extension |
6..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:dataClassification |
S | 1..1 | CodeableConcept | Communication Data Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification Binding: Zambia Communication Data Classification Value Set (required) | ||||
| extension:fallbackChannel |
S | 0..* | CodeableConcept | Communication Fallback Channel URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-fallback-channel Binding: Zambia Communication Channel Value Set (required) | ||||
| extension:approvedTemplate |
S | 1..1 | Identifier | Approved Communication Template URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template | ||||
| extension:messageLanguage |
S | 1..1 | code | Communication Message Language URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language Binding: AllLanguages (required) | ||||
| extension:acknowledgementRequired |
S | 1..1 | boolean | Communication Acknowledgement Required URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-acknowledgement-required | ||||
| extension:expiry |
S | 1..1 | instant | Communication Expiry URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-expiry | ||||
| extension:requestingSystem |
S | 1..1 | Reference(Organization | Device) | Communication Requesting System URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-requesting-system | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..* | Identifier | Unique identifier | ||||
| id |
0..1 | id | 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 |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (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ΣC | 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 |
S | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request. | ||||
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | ||||
| category |
S | 1..* | CodeableConcept | Message category Binding: Zambia Communication Lane Value Set (required) | ||||
| priority |
SΣ | 1..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 |
S | 1..1 | CodeableConcept | A channel of communication Binding: Zambia Communication Channel Value Set (required) | ||||
| subject |
S | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| about |
S | 0..* | Reference(Resource) | Resources that pertain to this communication request | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | The Encounter during which this CommunicationRequest was created | ||||
| payload |
S | 1..* | BackboneElement | Message payload | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
S | 1..1 | Message part content | |||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| contentCodeableConcept |
CodeableConcept | |||||||
| occurrence[x] |
SΣ | 1..1 | When scheduled | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| authoredOn |
SΣ | 1..1 | dateTime | When request transitioned to being actionable | ||||
| requester |
SΣ | 1..1 | Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile) | Who asks for the information to be shared | ||||
| recipient |
S | 1..* | Reference(ZM-Core Patient Profile | ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Recipient Group Profile | ZM-Core Healthcare Service Profile | CareTeam | RelatedPerson) | Who to share the information with | ||||
| informationProvider |
SΣ | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) | Who should share the information | ||||
| reason |
SΣ | 1..* | CodeableReference(Resource) | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
| note |
S | 0..* | Annotation | Comments made about communication request | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | CommunicationRequest Status Reason | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.category | Base | required | Zambia Communication Lane Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.medium | Base | required | Zambia Communication Channel Value Set | 📦0.1.0 | This IG |
| CommunicationRequest.reason | Base | example | v3 Code System ActReason | 📦3.0.0 | THO v7.1 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 18 elements
Must-Support: 28 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
