PH eReferral Implementation Guide, published by SILab CoP IG Accelerator (eReferral). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/niccoreyes/ph-ereferral/ and changes regularly. See the Directory of published versions
Resource Profile: EReferral Observation
| Official URL: urn://example.com/ph-ereferral/fhir/StructureDefinition/ereferral-observation | Version: 0.1.0 | ||||
| Draft as of 2026-05-26 | Computable Name: ERefObservation | ||||
Profile for clinical observations in the Philippine eReferral context. Supports vital signs, laboratory results, and clinical measurements included in referral clinical summaries. Referenced via ServiceRequest.supportingInfo and ServiceRequest.reasonReference.
Usages:
- Examples for this Profile: Observation/ExampleERefObservationBP, Observation/ExampleERefObservationChiefComplaint, Observation/ExampleERefObservationECG, Observation/ExampleERefObservationHeartRate... Show 5 more
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description Differentials, Snapshots, and other representations.
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
  Observation |
|||
  category |
|
|
|
  coding |
|
|
|
  text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
 Slices for value[x] |
|||
  value[x]:valueCodeableConcept |
|
|
|
  coding |
|
|
|
 text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| method |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| referenceRange |
|||
| type |
|
|
|
| coding |
|
|
|
| text |
|
|
|
 appliesTo |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| component |
|||
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Terminology Bindings
| 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.code | Base | example | 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.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. |
Constraints
| 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()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
| Observation |
0..* | PHCoreObservation | Measurements and simple assertions | |
 subject |
S | 0..1 | Reference(ERefPatient) | Who and/or what the observation is about |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | PHCoreObservation | Measurements and simple assertions Constraints: obs-6, obs-7 | ||||||||||||
| 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 | PH Core ServiceRequest) | Fulfills plan, proposal or order | ||||||||||||
| partOf |
Σ | 0..* | Reference(PH Core Medication Administration | PH Core Medication Dispense | PH Core Medication Statement | PH Core Procedure | PH Core Immunization | ImagingStudy) | Part of referenced event | ||||||||||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||||||||||
| category |
SO | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| subject |
SΣ | 0..1 | Reference(ERefPatient) | 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(PH 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(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | CareTeam) | Who is responsible for the observation | ||||||||||||
| Slices for value[x] |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||||||||||
 valueQuantity |
Quantity | |||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||
| valueString |
string | |||||||||||||||
| valueBoolean |
boolean | |||||||||||||||
| valueInteger |
integer | |||||||||||||||
| valueRange |
Range | |||||||||||||||
| valueRatio |
Ratio | |||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||
| valueTime |
time | |||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||
| valuePeriod |
Period | |||||||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConcept | Actual result
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| note |
0..* | Annotation | Comments about the observation | |||||||||||||
| bodySite |
SO | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| method |
SO | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||||||||||
| 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 | ||||||||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | ||||||||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | ||||||||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| appliesTo |
SO | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||||||||
| text |
0..1 | string | Text based reference range in an observation | |||||||||||||
| hasMember |
Σ | 0..* | Reference(PH Core Observation | Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||||||||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | PH Core Observation | Observation | MolecularSequence) | Related measurements the observation is made from | ||||||||||||
| 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 |
SOΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for value[x] |
Σ | 0..1 | Actual component result Slice: Unordered, Open by type:$this | |||||||||||||
| valueQuantity |
Quantity | |||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||
| valueString |
string | |||||||||||||||
| valueBoolean |
boolean | |||||||||||||||
| valueInteger |
integer | |||||||||||||||
| valueRange |
Range | |||||||||||||||
| valueRatio |
Ratio | |||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||
| valueTime |
time | |||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||
| valuePeriod |
Period | |||||||||||||||
| value[x]:valueCodeableConcept |
SOΣ | 0..1 | CodeableConcept | Actual component result
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Observation |
|||
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| method |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| referenceRange |
|||
| type |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| appliesTo |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| component |
|||
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Terminology Bindings
| 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.code | Base | example | 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.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. |
Constraints
| 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()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.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()
|
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Observation |
|||
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| method |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| referenceRange |
|||
| type |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| appliesTo |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| component |
|||
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | PHCoreObservation | Measurements and simple assertions Constraints: obs-6, obs-7 | ||||||||||||
| 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. | ||||||||||||
| category |
SO | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| subject |
SΣ | 0..1 | Reference(ERefPatient) | Who and/or what the observation is about | ||||||||||||
| Slices for value[x] |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||||||||||
| valueQuantity |
Quantity | |||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||
| valueString |
string | |||||||||||||||
| valueBoolean |
boolean | |||||||||||||||
| valueInteger |
integer | |||||||||||||||
| valueRange |
Range | |||||||||||||||
| valueRatio |
Ratio | |||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||
| valueTime |
time | |||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||
| valuePeriod |
Period | |||||||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConcept | Actual result
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| bodySite |
SO | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| method |
SO | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| appliesTo |
SO | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for value[x] |
Σ | 0..1 | Actual component result Slice: Unordered, Open by type:$this | |||||||||||||
| valueQuantity |
Quantity | |||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||
| valueString |
string | |||||||||||||||
| valueBoolean |
boolean | |||||||||||||||
| valueInteger |
integer | |||||||||||||||
| valueRange |
Range | |||||||||||||||
| valueRatio |
Ratio | |||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||
| valueTime |
time | |||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||
| valuePeriod |
Period | |||||||||||||||
| value[x]:valueCodeableConcept |
SOΣ | 0..1 | CodeableConcept | Actual component result
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Observation |
|||
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| method |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| referenceRange |
|||
| type |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| appliesTo |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| component |
|||
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Terminology Bindings
| 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.code | Base | example | 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.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. |
Constraints
| 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()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | PHCoreObservation | Measurements and simple assertions | |
| subject |
S | 0..1 | Reference(ERefPatient) | Who and/or what the observation is about |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | PHCoreObservation | Measurements and simple assertions Constraints: obs-6, obs-7 | ||||||||||||
| 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 | PH Core ServiceRequest) | Fulfills plan, proposal or order | ||||||||||||
| partOf |
Σ | 0..* | Reference(PH Core Medication Administration | PH Core Medication Dispense | PH Core Medication Statement | PH Core Procedure | PH Core Immunization | ImagingStudy) | Part of referenced event | ||||||||||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||||||||||
| category |
SO | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| subject |
SΣ | 0..1 | Reference(ERefPatient) | 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(PH 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(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | CareTeam) | Who is responsible for the observation | ||||||||||||
| Slices for value[x] |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||||||||||
| valueQuantity |
Quantity | |||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||
| valueString |
string | |||||||||||||||
| valueBoolean |
boolean | |||||||||||||||
| valueInteger |
integer | |||||||||||||||
| valueRange |
Range | |||||||||||||||
| valueRatio |
Ratio | |||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||
| valueTime |
time | |||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||
| valuePeriod |
Period | |||||||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConcept | Actual result
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| note |
0..* | Annotation | Comments about the observation | |||||||||||||
| bodySite |
SO | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| method |
SO | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||||||||||
| 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 | ||||||||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | ||||||||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | ||||||||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| appliesTo |
SO | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||||||||
| text |
0..1 | string | Text based reference range in an observation | |||||||||||||
| hasMember |
Σ | 0..* | Reference(PH Core Observation | Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||||||||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | PH Core Observation | Observation | MolecularSequence) | Related measurements the observation is made from | ||||||||||||
| 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 |
SOΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for value[x] |
Σ | 0..1 | Actual component result Slice: Unordered, Open by type:$this | |||||||||||||
| valueQuantity |
Quantity | |||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||
| valueString |
string | |||||||||||||||
| valueBoolean |
boolean | |||||||||||||||
| valueInteger |
integer | |||||||||||||||
| valueRange |
Range | |||||||||||||||
| valueRatio |
Ratio | |||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||
| valueTime |
time | |||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||
| valuePeriod |
Period | |||||||||||||||
| value[x]:valueCodeableConcept |
SOΣ | 0..1 | CodeableConcept | Actual component result
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Observation |
|||
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| method |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| referenceRange |
|||
| type |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| appliesTo |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| component |
|||
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Terminology Bindings
| 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.code | Base | example | 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.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. |
Constraints
| 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()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.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()
|
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Observation |
|||
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| method |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| referenceRange |
|||
| type |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| appliesTo |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| component |
|||
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for value[x] |
|||
| value[x]:valueCodeableConcept |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| dataAbsentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| interpretation |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Other representations of profile: CSV, Excel, Schematron