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/StructureDefinition/np-core-lab-panel-observation | Version: 1.0.0 | ||||
| Active as of 2026-10-14 | Computable Name: NPCoreLabPanelObservation | ||||
Sets minimum expectations for representing a laboratory panel — a named grouping of related test results such as a CBC or LFT — in Nepal.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
C | 0..* | NPCoreObservation | Measurements and simple assertions Constraints: obs-6, obs-7, np-labpanel-1 | ||||||||||||
  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 | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||||||||
  Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
   category:lab |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred) Required Pattern: At least the following
| |||||||||||||
  id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
 text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (extensible)
| |||||||||||||
 subject |
1..1 | Reference(NP Core Patient) | Who and/or what the observation is about
| |||||||||||||
| encounter |
0..1 | Reference(NP Core Encounter) | Healthcare event during which this observation is made
| |||||||||||||
 effective[x] |
0..1 | Clinically relevant time/time-period for observation
| ||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||
| effectivePeriod |
Period | |||||||||||||||
| effectiveTiming |
Timing | |||||||||||||||
| effectiveInstant |
instant | |||||||||||||||
| performer |
0..* | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Organization | NP Core Patient | NP Core RelatedPerson | CareTeam) | Who is responsible for the observation
| |||||||||||||
| note |
0..* | Annotation | Comments about the observation
| |||||||||||||
| specimen |
0..1 | Reference(NP Core Specimen) | Specimen used for this observation
| |||||||||||||
| hasMember |
0..* | Reference(NP Core Laboratory Result Observation) | Related resource that belongs to the Observation group
| |||||||||||||
 derivedFrom |
0..* | Reference(NP Core Clinical Document Reference | ImagingStudy | Media | QuestionnaireResponse | NP Core Observation | MolecularSequence) | Source the panel is derived from; SHALL include a clinical document or imaging study when hasMember is absent
| |||||||||||||
| type |
1..1 | uri | Resource type of the source; SHALL be populated so np-labpanel-1 can be evaluated Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
| |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| Observation |
|||
| status |
|
|
|
| Slices for category |
|
|
|
 category:lab |
|
|
|
| code |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| effective[x] |
|
|
|
| performer |
|
|
|
| value[x] |
|
|
|
| note |
|
|
|
| specimen |
|
|
|
| hasMember |
|
|
|
| derivedFrom |
|
|
|
| type |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.category:lab | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Observation.derivedFrom.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | 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 | Observation | 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 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | 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()
|
| np-labpanel-1 | error | Observation | A laboratory panel SHALL either have panel members (hasMember) or be derived from a clinical document or imaging study (at least one derivedFrom whose type is DocumentReference or ImagingStudy). |
hasMember.exists() or derivedFrom.where(type.endsWith('DocumentReference') or type.endsWith('ImagingStudy')).exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
This structure is derived from NPCoreObservation
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | NPCoreObservation | Measurements and simple assertions Constraints: np-labpanel-1 | ||||||||
| Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| category:lab |
1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following | |||||||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||
 value[x] |
0..0 | Actual result | ||||||||||
| specimen |
0..1 | Reference(NP Core Specimen) | Specimen used for this observation
| |||||||||
| referenceRange |
0..0 | Provides guide for interpretation | ||||||||||
| hasMember |
0..* | Reference(NP Core Laboratory Result Observation) | Related resource that belongs to the Observation group
| |||||||||
| derivedFrom |
0..* | Reference(NP Core Clinical Document Reference | ImagingStudy | Media | QuestionnaireResponse | NP Core Observation | MolecularSequence) | Source the panel is derived from; SHALL include a clinical document or imaging study when hasMember is absent
| |||||||||
| type |
1..1 | uri | Resource type of the source; SHALL be populated so np-labpanel-1 can be evaluated
| |||||||||
| Documentation for this format | ||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| Observation |
|||
| Slices for category |
|||
| specimen |
|
|
|
| hasMember |
|
|
|
| derivedFrom |
|
|
|
| type |
|
|
|
| Documentation for this format | |||
| Id | Grade | Path(s) | Description | Expression |
| np-labpanel-1 | error | Observation | A laboratory panel SHALL either have panel members (hasMember) or be derived from a clinical document or imaging study (at least one derivedFrom whose type is DocumentReference or ImagingStudy). |
hasMember.exists() or derivedFrom.where(type.endsWith('DocumentReference') or type.endsWith('ImagingStudy')).exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | NPCoreObservation | Measurements and simple assertions Constraints: obs-6, obs-7, np-labpanel-1 | ||||||||||||
| 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.
| |||||||||||||
| 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 | Business Identifier for observation | |||||||||||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||||||||||
| partOf |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||||||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||||||||
| Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| category:lab |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred) Required Pattern: At least the following
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (extensible)
| |||||||||||||
| subject |
1..1 | Reference(NP Core Patient) | Who and/or what the observation is about
| |||||||||||||
| focus |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||||||||
| encounter |
0..1 | Reference(NP Core Encounter) | Healthcare event during which this observation is made
| |||||||||||||
| effective[x] |
0..1 | Clinically relevant time/time-period for observation
| ||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||
| effectivePeriod |
Period | |||||||||||||||
| effectiveTiming |
Timing | |||||||||||||||
| effectiveInstant |
instant | |||||||||||||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||||||||||
| performer |
0..* | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Organization | NP Core Patient | NP Core RelatedPerson | CareTeam) | Who is responsible for the observation
| |||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||
| note |
0..* | Annotation | Comments about the observation
| |||||||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||||||||||
| specimen |
0..1 | Reference(NP Core Specimen) | Specimen used for this observation
| |||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||
| hasMember |
0..* | Reference(NP Core Laboratory Result Observation) | Related resource that belongs to the Observation group
| |||||||||||||
| derivedFrom |
0..* | Reference(NP Core Clinical Document Reference | ImagingStudy | Media | QuestionnaireResponse | NP Core Observation | MolecularSequence) | Source the panel is derived from; SHALL include a clinical document or imaging study when hasMember is absent
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
1..1 | uri | Resource type of the source; SHALL be populated so np-labpanel-1 can be evaluated Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
| |||||||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||||||
| component |
0..* | BackboneElement | Component results | |||||||||||||
| 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 | |||||||||||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||||||||||
| value[x] |
0..1 | Actual component result | ||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||
| valueString |
string | |||||||||||||||
| valueBoolean |
boolean | |||||||||||||||
| valueInteger |
integer | |||||||||||||||
| valueRange |
Range | |||||||||||||||
| valueRatio |
Ratio | |||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||
| valueTime |
time | |||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||
| valuePeriod |
Period | |||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| Observation |
|||
| status |
|
|
|
| Slices for category |
|
|
|
| category:lab |
|
|
|
| code |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| effective[x] |
|
|
|
| performer |
|
|
|
| value[x] |
|
|
|
| note |
|
|
|
| specimen |
|
|
|
| hasMember |
|
|
|
| derivedFrom |
|
|
|
| type |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.category:lab | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.derivedFrom.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | 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 | Observation | 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 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | 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()
|
| np-labpanel-1 | error | Observation | A laboratory panel SHALL either have panel members (hasMember) or be derived from a clinical document or imaging study (at least one derivedFrom whose type is DocumentReference or ImagingStudy). |
hasMember.exists() or derivedFrom.where(type.endsWith('DocumentReference') or type.endsWith('ImagingStudy')).exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| Observation |
|||
| status |
|
|
|
| Slices for category |
|
|
|
| category:lab |
|
|
|
| code |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| effective[x] |
|
|
|
| performer |
|
|
|
| value[x] |
|
|
|
| note |
|
|
|
| specimen |
|
|
|
| hasMember |
|
|
|
| derivedFrom |
|
|
|
| type |
|
|
|
| Documentation for this format | |||
This structure is derived from NPCoreObservation
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | NPCoreObservation | Measurements and simple assertions Constraints: obs-6, obs-7, np-labpanel-1 | ||||||||||||
| 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 | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||||||||
| Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| category:lab |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred) Required Pattern: At least the following
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (extensible)
| |||||||||||||
| subject |
1..1 | Reference(NP Core Patient) | Who and/or what the observation is about
| |||||||||||||
| encounter |
0..1 | Reference(NP Core Encounter) | Healthcare event during which this observation is made
| |||||||||||||
| effective[x] |
0..1 | Clinically relevant time/time-period for observation
| ||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||
| effectivePeriod |
Period | |||||||||||||||
| effectiveTiming |
Timing | |||||||||||||||
| effectiveInstant |
instant | |||||||||||||||
| performer |
0..* | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Organization | NP Core Patient | NP Core RelatedPerson | CareTeam) | Who is responsible for the observation
| |||||||||||||
| note |
0..* | Annotation | Comments about the observation
| |||||||||||||
| specimen |
0..1 | Reference(NP Core Specimen) | Specimen used for this observation
| |||||||||||||
| hasMember |
0..* | Reference(NP Core Laboratory Result Observation) | Related resource that belongs to the Observation group
| |||||||||||||
| derivedFrom |
0..* | Reference(NP Core Clinical Document Reference | ImagingStudy | Media | QuestionnaireResponse | NP Core Observation | MolecularSequence) | Source the panel is derived from; SHALL include a clinical document or imaging study when hasMember is absent
| |||||||||||||
| type |
1..1 | uri | Resource type of the source; SHALL be populated so np-labpanel-1 can be evaluated Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
| |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| Observation |
|||
| status |
|
|
|
| Slices for category |
|
|
|
| category:lab |
|
|
|
| code |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| effective[x] |
|
|
|
| performer |
|
|
|
| value[x] |
|
|
|
| note |
|
|
|
| specimen |
|
|
|
| hasMember |
|
|
|
| derivedFrom |
|
|
|
| type |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.category:lab | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Observation.derivedFrom.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | 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 | Observation | 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 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | 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()
|
| np-labpanel-1 | error | Observation | A laboratory panel SHALL either have panel members (hasMember) or be derived from a clinical document or imaging study (at least one derivedFrom whose type is DocumentReference or ImagingStudy). |
hasMember.exists() or derivedFrom.where(type.endsWith('DocumentReference') or type.endsWith('ImagingStudy')).exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
Differential View
This structure is derived from NPCoreObservation
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | NPCoreObservation | Measurements and simple assertions Constraints: np-labpanel-1 | ||||||||
| Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| category:lab |
1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following | |||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||
| value[x] |
0..0 | Actual result | ||||||||||
| specimen |
0..1 | Reference(NP Core Specimen) | Specimen used for this observation
| |||||||||
| referenceRange |
0..0 | Provides guide for interpretation | ||||||||||
| hasMember |
0..* | Reference(NP Core Laboratory Result Observation) | Related resource that belongs to the Observation group
| |||||||||
| derivedFrom |
0..* | Reference(NP Core Clinical Document Reference | ImagingStudy | Media | QuestionnaireResponse | NP Core Observation | MolecularSequence) | Source the panel is derived from; SHALL include a clinical document or imaging study when hasMember is absent
| |||||||||
| type |
1..1 | uri | Resource type of the source; SHALL be populated so np-labpanel-1 can be evaluated
| |||||||||
| Documentation for this format | ||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| Observation |
|||
| Slices for category |
|||
| specimen |
|
|
|
| hasMember |
|
|
|
| derivedFrom |
|
|
|
| type |
|
|
|
| Documentation for this format | |||
| Id | Grade | Path(s) | Description | Expression |
| np-labpanel-1 | error | Observation | A laboratory panel SHALL either have panel members (hasMember) or be derived from a clinical document or imaging study (at least one derivedFrom whose type is DocumentReference or ImagingStudy). |
hasMember.exists() or derivedFrom.where(type.endsWith('DocumentReference') or type.endsWith('ImagingStudy')).exists()
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | NPCoreObservation | Measurements and simple assertions Constraints: obs-6, obs-7, np-labpanel-1 | ||||||||||||
| 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.
| |||||||||||||
| 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 | Business Identifier for observation | |||||||||||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||||||||||
| partOf |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||||||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||||||||
| Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| category:lab |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred) Required Pattern: At least the following
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (extensible)
| |||||||||||||
| subject |
1..1 | Reference(NP Core Patient) | Who and/or what the observation is about
| |||||||||||||
| focus |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||||||||
| encounter |
0..1 | Reference(NP Core Encounter) | Healthcare event during which this observation is made
| |||||||||||||
| effective[x] |
0..1 | Clinically relevant time/time-period for observation
| ||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||
| effectivePeriod |
Period | |||||||||||||||
| effectiveTiming |
Timing | |||||||||||||||
| effectiveInstant |
instant | |||||||||||||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||||||||||
| performer |
0..* | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Organization | NP Core Patient | NP Core RelatedPerson | CareTeam) | Who is responsible for the observation
| |||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||
| note |
0..* | Annotation | Comments about the observation
| |||||||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||||||||||
| specimen |
0..1 | Reference(NP Core Specimen) | Specimen used for this observation
| |||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||
| hasMember |
0..* | Reference(NP Core Laboratory Result Observation) | Related resource that belongs to the Observation group
| |||||||||||||
| derivedFrom |
0..* | Reference(NP Core Clinical Document Reference | ImagingStudy | Media | QuestionnaireResponse | NP Core Observation | MolecularSequence) | Source the panel is derived from; SHALL include a clinical document or imaging study when hasMember is absent
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
1..1 | uri | Resource type of the source; SHALL be populated so np-labpanel-1 can be evaluated Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
| |||||||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||||||
| component |
0..* | BackboneElement | Component results | |||||||||||||
| 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 | |||||||||||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||||||||||
| value[x] |
0..1 | Actual component result | ||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||
| valueString |
string | |||||||||||||||
| valueBoolean |
boolean | |||||||||||||||
| valueInteger |
integer | |||||||||||||||
| valueRange |
Range | |||||||||||||||
| valueRatio |
Ratio | |||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||
| valueTime |
time | |||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||
| valuePeriod |
Period | |||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| Observation |
|||
| status |
|
|
|
| Slices for category |
|
|
|
| category:lab |
|
|
|
| code |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| effective[x] |
|
|
|
| performer |
|
|
|
| value[x] |
|
|
|
| note |
|
|
|
| specimen |
|
|
|
| hasMember |
|
|
|
| derivedFrom |
|
|
|
| type |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.category:lab | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.derivedFrom.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | 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 | Observation | 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 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | 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()
|
| np-labpanel-1 | error | Observation | A laboratory panel SHALL either have panel members (hasMember) or be derived from a clinical document or imaging study (at least one derivedFrom whose type is DocumentReference or ImagingStudy). |
hasMember.exists() or derivedFrom.where(type.endsWith('DocumentReference') or type.endsWith('ImagingStudy')).exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| Observation |
|||
| status |
|
|
|
| Slices for category |
|
|
|
| category:lab |
|
|
|
| code |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| effective[x] |
|
|
|
| performer |
|
|
|
| value[x] |
|
|
|
| note |
|
|
|
| specimen |
|
|
|
| hasMember |
|
|
|
| derivedFrom |
|
|
|
| type |
|
|
|
| Documentation for this format | |||
This structure is derived from NPCoreObservation
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
