NP Core Implementation Guide
1.0.0 - Release
NP Core Implementation Guide
1.0.0 - Release
NP Core Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.digitalhealth.gov.np/core/CapabilityStatement/np-core-consumer-capabilitystatement | Version: 1.0.0 | ||||
| Active as of 2026-06-22 | Computable Name: NPCoreConsumerCapabilityStatement | ||||
Capabilities expected of an NP Core Consumer: a system (e.g. analytics platform, patient portal, decision support) that receives and uses NP Core resources. Corresponds to the NPCoreConsumer actor.
Raw OpenAPI-Swagger Definition file | Download
Language: en
json, xmlNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
clientAn NP Core Consumer SHOULD support all of the NP Core profiles listed below, unless it plays a limited or specialised role in clinical or information workflows, such as a viewing application that displays only laboratory results. A Consumer SHALL declare exactly which NP Core profiles it supports in its own CapabilityStatement, by asserting instantiates of the NP Core Consumer CapabilityStatement and listing each supported profile in rest.resource.supportedProfile. A Consumer SHALL be capable of receiving and meaningfully processing every profile it declares, retrieved via the read and search-type interactions, without error or data loss. The search parameters below are those a Consumer SHALL or SHOULD be able to issue against an NP Core Server; the expectation is recorded on each entry with the capabilitystatement-expectation extension.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Patient | Supported Profiles NP Core Patient | y | y | identifier, name, birthdate, family, given, gender, address-state, address-city | |||||
| Practitioner | Supported Profiles NP Core Practitioner | y | y | identifier, name | |||||
| PractitionerRole | Supported Profiles NP Core PractitionerRole | y | y | practitioner, organization, identifier, role, specialty | |||||
| RelatedPerson | Supported Profiles NP Core RelatedPerson | y | y | patient, identifier, name | |||||
| Organization | Supported Profiles NP Core Organization NP Core Health Facility | y | y | identifier, name, type, address, partof | |||||
| Location | Supported Profiles NP Core Location | y | y | organization, name, identifier, type, address | |||||
| HealthcareService | Supported Profiles NP Core HealthcareService | y | y | organization, name, identifier, location, service-type | |||||
| Encounter | Supported Profiles NP Core Encounter | y | y | patient, date, identifier, status, class, type, service-provider | |||||
| Condition | Supported Profiles NP Core Condition | y | y | patient, category, clinical-status, code, onset-date, encounter | |||||
| Observation | Supported Profiles NP Core Observation NP Core Blood Pressure Observation NP Core Body Height Observation NP Core Body Temperature Observation NP Core Body Weight Observation NP Core Heart Rate Observation NP Core Oxygen Saturation Observation NP Core Vital Signs Panel NP Core Laboratory Result Observation NP Core Laboratory Panel Observation | y | y | patient, category, code, date, status, encounter | |||||
| DiagnosticReport | Supported Profiles NP Core Laboratory Report NP Core Radiology Report | y | y | patient, category, code, date, status, encounter | |||||
| AllergyIntolerance | Supported Profiles NP Core Allergy Intolerance | y | y | patient, clinical-status, category, date | |||||
| Immunization | Supported Profiles NP Core Immunization | y | y | patient, date, vaccine-code, status | |||||
| Procedure | Supported Profiles NP Core Procedure | y | y | patient, date, code, status, encounter | |||||
| Specimen | Supported Profiles NP Core Specimen | y | y | patient, identifier, type, status | |||||
| Device | Supported Profiles NP Core Device | y | y | patient, identifier, type, status | |||||
| Medication | Supported Profiles NP Core Medication | y | y | code, identifier, status, form | |||||
| MedicationRequest | Supported Profiles NP Core MedicationRequest | y | y | patient, status, intent, authoredon, encounter | |||||
| MedicationDispense | Supported Profiles NP Core MedicationDispense | y | y | patient, status, whenhandedover | |||||
| MedicationStatement | Supported Profiles NP Core MedicationStatement | y | y | patient, status, effective | |||||
| MedicationAdministration | Supported Profiles NP Core MedicationAdministration | y | y | patient, status, effective-time | |||||
| ServiceRequest | Supported Profiles NP Core Service Request NP Core Referral Request | y | y | patient, status, intent, code, authored, encounter | |||||
| DocumentReference | Supported Profiles NP Core Clinical Document Reference | y | y | patient, type, date, category, status |
Patient?identifier= is the primary national patient lookup and SHALL be supported for every national identifier system defined by this guide. Servers SHALL also support the combination name+birthdate for demographic matching.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | |
| SHALL | name | string | |
| SHALL | birthdate | date | |
| SHOULD | family | string | |
| SHOULD | given | string | |
| SHOULD | gender | token | |
| SHOULD | address-state | string | |
| SHOULD | address-city | string |
Practitioner?identifier= SHALL be supported for the NHWR code and for every council registration system defined by this guide.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | |
| SHALL | name | string |
Servers SHALL support finding the roles a practitioner holds (practitioner) and the practitioners working for a facility (organization).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | practitioner | reference | |
| SHALL | organization | reference | |
| SHOULD | identifier | token | |
| SHOULD | role | token | |
| SHOULD | specialty | token |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHOULD | identifier | token | |
| SHOULD | name | string |
Organization?identifier= SHALL be supported for the NHFR facility code, which is how a facility is resolved from an encounter or report.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | |
| SHALL | name | string | |
| SHOULD | type | token | |
| SHOULD | address | string | |
| SHOULD | partof | reference |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | organization | reference | |
| SHALL | name | string | |
| SHOULD | identifier | token | |
| SHOULD | type | token | |
| SHOULD | address | string |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | organization | reference | |
| SHALL | name | string | |
| SHOULD | identifier | token | |
| SHOULD | location | reference | |
| SHOULD | service-type | token |
Servers SHALL support the combination patient+date.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | date | date | |
| SHALL | identifier | token | |
| SHALL | status | token | |
| SHOULD | class | token | |
| SHOULD | type | token | |
| SHOULD | service-provider | reference |
Servers SHALL support the combinations patient+category and patient+clinical-status, which separate a patient's active problem list from their encounter diagnoses.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | category | token | |
| SHALL | clinical-status | token | |
| SHOULD | code | token | |
| SHOULD | onset-date | date | |
| SHOULD | encounter | reference |
NP Core Observation
NP Core Blood Pressure Observation
NP Core Body Height Observation
NP Core Body Temperature Observation
NP Core Body Weight Observation
NP Core Heart Rate Observation
NP Core Oxygen Saturation Observation
NP Core Vital Signs Panel
NP Core Laboratory Result Observation
NP Core Laboratory Panel Observation
Servers SHALL support the combinations patient+category, patient+code and patient+category+date, and SHOULD support patient+code+date. status SHALL be supported so a consumer can exclude preliminary and entered-in-error results.
Servers SHALL support the combinations patient+category and patient+category+date. status SHALL be supported so a consumer can exclude preliminary and entered-in-error reports.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHOULD | clinical-status | token | |
| SHOULD | category | token | |
| SHOULD | date | date |
Servers SHALL support the combination patient+date, and vaccine-code, which national EPI coverage reporting depends on.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | date | date | |
| SHALL | vaccine-code | token | |
| SHOULD | status | token |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHOULD | identifier | token | |
| SHOULD | type | token | |
| SHOULD | status | token |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | identifier | token | |
| SHOULD | type | token | |
| SHOULD | status | token |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | |
| SHOULD | identifier | token | |
| SHOULD | status | token | |
| SHOULD | form | token |
Servers SHALL support the combination patient+status, which is how a current medication list is retrieved.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | status | token | |
| SHOULD | intent | token | |
| SHOULD | authoredon | date | |
| SHOULD | encounter | reference |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHOULD | status | token | |
| SHOULD | whenhandedover | date |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHOULD | status | token | |
| SHOULD | effective-time | date |
Servers SHALL support the combination patient+status, which is how outstanding referrals and orders are found.
Servers SHALL support the combination patient+type, which is how a discharge summary or referral letter is retrieved for a patient.