LK NEHR Sri Lanka Patient Summary (IPS based) Implementation Guide
0.1.0 - STU1

LK NEHR Sri Lanka Patient Summary (IPS based) Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Notifiable Diseases Notified

Official URL: http://fhir.health.gov.lk/ips/StructureDefinition/notifiable-diseases-notified | Version: 0.1.0
Active as of 2025-06-18 | Computable Name: NotifiableDiseasesNotified

Represents a message communicated to the practitioner about a patient's encounter.

Usages:

- Use this Profile: HHIMS IPS Bundle and HHIMS Transactional Bundle
- Refer to this Profile: HHIMS Composition
- Examples for this Profile: Communication/NotifiableDiseasesNotifiedExample

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender to a receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
subject | Σ | 1..1 | Reference(Patient) | Focus of message
encounter | Σ | 1..1 | Reference(Target Facility Encounter) | Encounter created as part of
sent | S | 0..1 | dateTime | When sent
sender | S | 0..1 | Reference(Device Information) | Message sender
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Communication.status | required | EventStatus `http://hl7.org/fhir/ValueSet/event-status|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Communication | 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 | Communication | 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 | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Communication | 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 Communication

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Communication |  |  | Communication |
subject |  | 1..1 | Reference(Patient) | Focus of message
encounter |  | 1..1 | Reference(Target Facility Encounter) | Encounter created as part of
sent | S | 0..1 | dateTime | When sent
sender | S | 0..1 | Reference(Device Information) | Message sender
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender 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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
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 | Σ | 0..* | Identifier | Unique identifier
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication
partOf | Σ | 0..* | Reference(Resource) | Part of this action
inResponseTo |  | 0..* | Reference(Communication) | Reply to
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
category |  | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
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 | Reference(Patient) | Focus of message
topic |  | 0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
about |  | 0..* | Reference(Resource) | Resources that pertain to this communication
encounter | Σ | 1..1 | Reference(Target Facility Encounter) | Encounter created as part of
sent | S | 0..1 | dateTime | When sent
received |  | 0..1 | dateTime | When received
recipient |  | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 0..1 | Reference(Device Information) | Message sender
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done?
payload |  | 0..* | BackboneElement | Message payload
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
content[x] |  | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
note |  | 0..* | Annotation | Comments made about the communication
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Communication.status | required | EventStatus `http://hl7.org/fhir/ValueSet/event-status|4.0.1` From the FHIR Standard
Communication.statusReason | example | CommunicationNotDoneReason `http://hl7.org/fhir/ValueSet/communication-not-done-reason` From the FHIR Standard
Communication.category | example | CommunicationCategory `http://hl7.org/fhir/ValueSet/communication-category` From the FHIR Standard
Communication.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` From the FHIR Standard
Communication.medium | example | ParticipationMode `http://terminology.hl7.org/ValueSet/v3-ParticipationMode`
Communication.topic | example | CommunicationTopic `http://hl7.org/fhir/ValueSet/communication-topic` From the FHIR Standard
Communication.reasonCode | example | SNOMEDCTClinicalFindings `http://hl7.org/fhir/ValueSet/clinical-findings` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Communication | 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 | Communication | 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 | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Communication | 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 Communication

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

- Patient (http://fhir.health.gov.lk/ips/StructureDefinition/ips-patient)
- Target Facility Encounter (http://fhir.health.gov.lk/ips/StructureDefinition/target-facility-encounter)
- Device Information (http://fhir.health.gov.lk/ips/StructureDefinition/device-information)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender to a receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
subject | Σ | 1..1 | Reference(Patient) | Focus of message
encounter | Σ | 1..1 | Reference(Target Facility Encounter) | Encounter created as part of
sent | S | 0..1 | dateTime | When sent
sender | S | 0..1 | Reference(Device Information) | Message sender
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Communication.status | required | EventStatus `http://hl7.org/fhir/ValueSet/event-status|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Communication | 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 | Communication | 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 | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Communication | 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 Communication

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Communication |  |  | Communication |
subject |  | 1..1 | Reference(Patient) | Focus of message
encounter |  | 1..1 | Reference(Target Facility Encounter) | Encounter created as part of
sent | S | 0..1 | dateTime | When sent
sender | S | 0..1 | Reference(Device Information) | Message sender
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender 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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
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 | Σ | 0..* | Identifier | Unique identifier
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication
partOf | Σ | 0..* | Reference(Resource) | Part of this action
inResponseTo |  | 0..* | Reference(Communication) | Reply to
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
category |  | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
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 | Reference(Patient) | Focus of message
topic |  | 0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
about |  | 0..* | Reference(Resource) | Resources that pertain to this communication
encounter | Σ | 1..1 | Reference(Target Facility Encounter) | Encounter created as part of
sent | S | 0..1 | dateTime | When sent
received |  | 0..1 | dateTime | When received
recipient |  | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 0..1 | Reference(Device Information) | Message sender
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done?
payload |  | 0..* | BackboneElement | Message payload
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
content[x] |  | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
note |  | 0..* | Annotation | Comments made about the communication
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Communication.status | required | EventStatus `http://hl7.org/fhir/ValueSet/event-status|4.0.1` From the FHIR Standard
Communication.statusReason | example | CommunicationNotDoneReason `http://hl7.org/fhir/ValueSet/communication-not-done-reason` From the FHIR Standard
Communication.category | example | CommunicationCategory `http://hl7.org/fhir/ValueSet/communication-category` From the FHIR Standard
Communication.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` From the FHIR Standard
Communication.medium | example | ParticipationMode `http://terminology.hl7.org/ValueSet/v3-ParticipationMode`
Communication.topic | example | CommunicationTopic `http://hl7.org/fhir/ValueSet/communication-topic` From the FHIR Standard
Communication.reasonCode | example | SNOMEDCTClinicalFindings `http://hl7.org/fhir/ValueSet/clinical-findings` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Communication | 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 | Communication | 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 | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Communication | 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 Communication

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

- Patient (http://fhir.health.gov.lk/ips/StructureDefinition/ips-patient)
- Target Facility Encounter (http://fhir.health.gov.lk/ips/StructureDefinition/target-facility-encounter)
- Device Information (http://fhir.health.gov.lk/ips/StructureDefinition/device-information)

Other representations of profile: CSV, Excel, Schematron