Uzbekistan Digital Health Platform
0.5.0 - ci-build
Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-socioeconomic-observation | Version: 0.5.0 | ||||
| Active as of 2025-06-11 | Computable Name: UZCoreSocioeconomicObservation | ||||
Uzbekistan Core socioeconomic observation profile, used to represent patients' benefits, education, profession, and social status.
UZ Core Socioeconomic Observation captures a patient's preferential/benefit category and socioeconomic status - the facts that influence reimbursement eligibility, such as a disability or social-benefit group, as well as education, profession, and social status. It is modelled as an Observation so it lives alongside clinical observations but is categorised distinctly. Use the Observation endpoint to read and search these records.
The elements below must always be present (mandatory) or must be supported when the data is available (Must Support) - not all are required, but your system must populate each Must Support element when it has the data and process it on receipt. This is the human-readable summary; the formal views below give the exact cardinalities, types, and terminology bindings.
Every Socioeconomic Observation must carry a subject - the Patient the record is about (1..1), a code carrying the socioeconomic observation type through the required socioeconomicType coding slice (1..1) - one of Eligible for benefit, Educational achievement, Occupation, or Social status (SNOMED CT, bound to the DHP socioeconomic-observation-codes value set) - an effectiveDateTime (when the data was recorded or applies, 1..1), and a status inherited from the base resource.
socioeconomicType slice), and the effectiveDateTime listed above.The
value[x]is a CodeableConcept whose value set depends on thecode: benefits use BenefitsVS, education uses EducationVS, profession uses PositionAndProfessionVS, and social status uses SocialStatusVS. Pick the value set that matches the chosen type code.
The examples below go from the smallest instance the server will accept to a fully populated socioeconomic record. Copy one and adapt it - every value shown validates against this profile. The full reference instances are linked at the bottom of the page (for example education, social status, profession, benefits).
Four elements carry the whole record: the status and the subject (the Patient it is about), the code saying which kind of socioeconomic fact this is (through the required socioeconomicType coding slice, always a SNOMED CT code from http://snomed.info/sct), and the effectiveDateTime when it was recorded. The result itself goes in valueCodeableConcept. This education-level record already passes validation:
{
"resourceType": "Observation",
"language": "uz",
"meta": {
"profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-socioeconomic-observation" ]
},
"status": "final",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "105421008",
"display": "Educational achievement"
}
]
},
"subject": { "reference": "Patient/example-salim" },
"valueCodeableConcept": {
"coding": [
{
"system": "https://terminology.dhp.uz/fhir/core/CodeSystem/education-cs",
"code": "regis0005.00004",
"display": "O'rtacha"
}
]
},
"effectiveDateTime": "2025-06-11"
}
The code is what selects the kind of fact; here 105421008 (Educational achievement) means the valueCodeableConcept is drawn from EducationVS. The subject is a plain Reference, so the target sits directly under reference ("subject": { "reference": "Patient/example-salim" }).
Swap the type code and the result value set together - they always move as a pair. For a patient's social status, the code is 82996008 (Social status) and the valueCodeableConcept is drawn from SocialStatusVS:
{
"resourceType": "Observation",
"language": "uz",
"meta": {
"profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-socioeconomic-observation" ]
},
"status": "final",
"code": {
"coding": [
{ "system": "http://snomed.info/sct", "code": "82996008", "display": "Social status" }
]
},
"subject": { "reference": "Patient/example-salim" },
"valueCodeableConcept": {
"coding": [
{
"system": "https://terminology.dhp.uz/fhir/core/CodeSystem/social-status-cs",
"code": "regis0010.00003",
"display": "Ishlaydi"
}
]
},
"effectiveDateTime": "2025-06-11"
}
The only thing that changes between a benefits, education, profession, or social-status record is the SNOMED code and the matching valueCodeableConcept system. Keep the two in step - the result code system below must match the type code in the same row. Each system links to the value set of codes you can use:
| Socioeconomic fact | code (SNOMED CT) |
valueCodeableConcept system |
|---|---|---|
| Eligible for benefit | 1303306008 |
https://terminology.dhp.uz/fhir/core/CodeSystem/benefits-cs |
| Educational achievement | 105421008 |
https://terminology.dhp.uz/fhir/core/CodeSystem/education-cs |
| Occupation | 14679004 |
https://terminology.dhp.uz/fhir/core/CodeSystem/position-and-profession-cs |
| Social status | 82996008 |
https://terminology.dhp.uz/fhir/core/CodeSystem/social-status-cs |
For an occupation record, the code is 14679004 (Occupation) and the result comes from the profession code system:
{
"resourceType": "Observation",
"language": "uz",
"meta": {
"profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-socioeconomic-observation" ]
},
"status": "final",
"code": {
"coding": [
{ "system": "http://snomed.info/sct", "code": "14679004", "display": "Occupation" }
]
},
"subject": { "reference": "Patient/example-salim" },
"valueCodeableConcept": {
"coding": [
{
"system": "https://terminology.dhp.uz/fhir/core/CodeSystem/position-and-profession-cs",
"code": "1321.20",
"display": "Bosh mexanik"
}
]
},
"effectiveDateTime": "2025-06-11"
}
See Terminology for how the bound value sets are published.
For example API calls and a sample payload, see the Quick Start at the bottom of this page.
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: ![]() ![]() | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Observation(5.0.0) | Measurements and simple assertions Constraints: obs-6, obs-7, obs-8 | |||||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||||||||||||
![]() ![]() |
SΣC | 1..1 | CodeableConcept | Socioeconomic observation type. Education level code is aligned with EE MPI SocialHistory Education Level profile Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||||||||||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||||||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Required socioeconomic observation type code Binding: SocioeconomicObservationCodesVS (0.5.0) (required) | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |||||||||||||||
![]() ![]() |
SΣ | 1..1 | Reference(UZ Core Patient(0.5.0)) | Who and/or what the observation is about | |||||||||||||||
![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | |||||||||||||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date when the socioeconomic data was recorded or applicable | |||||||||||||||
![]() ![]() |
ΣC | 0..1 | CodeableConcept | One of the sample valuesets that can be used is BenefitsVS. For all others, see the table: Binding: BenefitsVS (0.5.0) (example)
| |||||||||||||||
Documentation for this format | |||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Observation Status | 📍5.0.0 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Observation.code.coding:socioeconomicType | Base | required | Socioeconomic Observation Codes | 📍0.5.0 | This IG |
| Observation.value[x] | Base | example | Types of benefits | 📍0.5.0 | This IG |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | 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 | Observation.implicitRules, Observation.modifierExtension, Observation.status, Observation.code, Observation.code.coding, Observation.code.coding:socioeconomicType, Observation.code.coding:socioeconomicType.system, Observation.subject, Observation.effective[x], Observation.effective[x]:effectiveDateTime, Observation.value[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Observation.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.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.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| obs-8 | error | Observation | bodyStructure SHALL only be present if Observation.bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Observation(5.0.0) | Measurements and simple assertions | ||||||||||||||||
![]() ![]() |
S | 1..1 | CodeableConcept | Socioeconomic observation type. Education level code is aligned with EE MPI SocialHistory Education Level profile | |||||||||||||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||||||||||||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Required socioeconomic observation type code Binding: SocioeconomicObservationCodesVS (0.5.0) (required) | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||||||||||||||
![]() ![]() |
S | 1..1 | Reference(UZ Core Patient(0.5.0)) | Who and/or what the observation is about | |||||||||||||||
![]() ![]() |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | ||||||||||||||||
![]() ![]() ![]() |
S | 1..1 | dateTime | Date when the socioeconomic data was recorded or applicable | |||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | One of the sample valuesets that can be used is BenefitsVS. For all others, see the table: Binding: BenefitsVS (0.5.0) (example)
| ||||||||||||||||
Documentation for this format | |||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.code.coding:socioeconomicType | Base | required | Socioeconomic Observation Codes | 📍0.5.0 | This IG |
| Observation.value[x] | Base | example | Types of benefits | 📍0.5.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Observation(5.0.0) | Measurements and simple assertions Constraints: obs-6, obs-7, obs-8 | |||||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||||||||||||
![]() ![]() |
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 | ||||||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | ||||||||||||||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for observation | |||||||||||||||
![]() ![]() |
Σ | 0..1 | canonical(ObservationDefinition), Reference(ObservationDefinition) | Instantiates FHIR ObservationDefinition | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||||||||||||
![]() ![]() |
0..* | BackboneElement | Triggering observation(s) | ||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Observation) | Triggering observation | |||||||||||||||
![]() ![]() ![]() |
Σ | 1..1 | code | reflex | repeat | re-run Binding: TriggeredBytype (required): The type of TriggeredBy Observation. | |||||||||||||||
![]() ![]() ![]() |
0..1 | string | Reason that the observation was triggered | ||||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) | Part of referenced event | |||||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||||||||||||
![]() ![]() |
0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||||||
![]() ![]() |
SΣC | 1..1 | CodeableConcept | Socioeconomic observation type. Education level code is aligned with EE MPI SocialHistory Education Level profile Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||||||||||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||||||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Required socioeconomic observation type code Binding: SocioeconomicObservationCodesVS (0.5.0) (required) | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||
![]() ![]() |
SΣ | 1..1 | Reference(UZ Core Patient(0.5.0)) | Who and/or what the observation is about | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||||||||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||||||||||
![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | |||||||||||||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date when the socioeconomic data was recorded or applicable | |||||||||||||||
![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||||||||||||
![]() ![]() |
ΣC | 0..1 | CodeableConcept | One of the sample valuesets that can be used is BenefitsVS. For all others, see the table: Binding: BenefitsVS (0.5.0) (example)
| |||||||||||||||
![]() ![]() |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | |||||||||||||||
![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||||||
![]() ![]() |
0..* | Annotation | Comments about the observation | ||||||||||||||||
![]() ![]() |
C | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||||||||||||
![]() ![]() |
C | 0..1 | Reference(BodyStructure) | Observed body structure | |||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||||||||||||||
![]() ![]() |
C | 0..1 | Reference(Specimen | Group) | Specimen used for this observation Constraints: obs-9 | |||||||||||||||
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | A reference to the device that generates the measurements or the device settings for the device | ||||||||||||||||
![]() ![]() |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | |||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(5.0.0) | Low Range, if relevant | |||||||||||||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(5.0.0) | High Range, if relevant | |||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Normal value, if relevant Binding: ObservationReferenceRangeNormalValueCodes (extensible): Codes identifying the normal value of the observation. | ||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | ||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | ||||||||||||||||
![]() ![]() ![]() |
0..1 | Range | Applicable age range, if relevant | ||||||||||||||||
![]() ![]() ![]() |
C | 0..1 | markdown | Text based reference range in an observation | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | ImagingSelection | QuestionnaireResponse | Observation | MolecularSequence | GenomicStudy) | Related resource from which the observation is made | |||||||||||||||
![]() ![]() |
ΣC | 0..* | BackboneElement | Component results | |||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||||
![]() ![]() ![]() |
ΣC | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Actual component result | ||||||||||||||||
![]() ![]() ![]() ![]() |
Quantity | ||||||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | ||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||
![]() ![]() ![]() ![]() |
boolean | ||||||||||||||||||
![]() ![]() ![]() ![]() |
integer | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Range | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Ratio | ||||||||||||||||||
![]() ![]() ![]() ![]() |
SampledData | ||||||||||||||||||
![]() ![]() ![]() ![]() |
time | ||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Period | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Attachment | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Reference(MolecularSequence) | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||||||
![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | ||||||||||||||||
Documentation for this format | |||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Observation.triggeredBy.type | Base | required | triggered Bytype | 📍5.0.0 | FHIR Std. |
| Observation.status | Base | required | Observation Status | 📍5.0.0 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍5.0.0 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Observation.code.coding:socioeconomicType | Base | required | Socioeconomic Observation Codes | 📍0.5.0 | This IG |
| Observation.value[x] | Base | example | Types of benefits | 📍0.5.0 | This IG |
| Observation.dataAbsentReason | Base | extensible | Data Absent Reason | 📍5.0.0 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍5.0.0 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍5.0.0 | FHIR Std. |
| Observation.referenceRange.normalValue | Base | extensible | Observation Reference Range Normal Value Codes | 📍5.0.0 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍5.0.0 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍5.0.0 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | Data Absent Reason | 📍5.0.0 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍5.0.0 | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | 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 | Observation.meta, Observation.implicitRules, Observation.language, Observation.text, Observation.extension, Observation.modifierExtension, Observation.identifier, Observation.instantiates[x], Observation.basedOn, Observation.triggeredBy, Observation.triggeredBy.extension, Observation.triggeredBy.modifierExtension, Observation.triggeredBy.observation, Observation.triggeredBy.type, Observation.triggeredBy.reason, Observation.partOf, Observation.status, Observation.category, Observation.code, Observation.code.extension, Observation.code.coding, Observation.code.coding:socioeconomicType, Observation.code.coding:socioeconomicType.extension, Observation.code.coding:socioeconomicType.system, Observation.code.coding:socioeconomicType.version, Observation.code.coding:socioeconomicType.code, Observation.code.coding:socioeconomicType.display, Observation.code.coding:socioeconomicType.userSelected, Observation.code.text, Observation.subject, Observation.focus, Observation.encounter, Observation.effective[x], Observation.effective[x]:effectiveDateTime, Observation.issued, Observation.performer, Observation.value[x], Observation.dataAbsentReason, Observation.interpretation, Observation.note, Observation.bodySite, Observation.bodyStructure, Observation.method, Observation.specimen, Observation.device, Observation.referenceRange, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.normalValue, Observation.referenceRange.type, Observation.referenceRange.appliesTo, Observation.referenceRange.age, Observation.referenceRange.text, Observation.hasMember, Observation.derivedFrom, Observation.component, Observation.component.extension, Observation.component.modifierExtension, Observation.component.code, Observation.component.value[x], Observation.component.dataAbsentReason, Observation.component.interpretation, Observation.component.referenceRange | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Observation.extension, Observation.modifierExtension, Observation.triggeredBy.extension, Observation.triggeredBy.modifierExtension, Observation.code.extension, Observation.code.coding:socioeconomicType.extension, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.component.extension, Observation.component.modifierExtension | 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.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| obs-8 | error | Observation | bodyStructure SHALL only be present if Observation.bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| obs-9 | error | Observation.specimen | If Observation.specimen is a reference to Group, the group can only have specimens |
(reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)
|
Summary
Mandatory: 5 elements
Must-Support: 4 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: ![]() ![]() | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Observation(5.0.0) | Measurements and simple assertions Constraints: obs-6, obs-7, obs-8 | |||||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||||||||||||
![]() ![]() |
SΣC | 1..1 | CodeableConcept | Socioeconomic observation type. Education level code is aligned with EE MPI SocialHistory Education Level profile Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||||||||||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||||||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Required socioeconomic observation type code Binding: SocioeconomicObservationCodesVS (0.5.0) (required) | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |||||||||||||||
![]() ![]() |
SΣ | 1..1 | Reference(UZ Core Patient(0.5.0)) | Who and/or what the observation is about | |||||||||||||||
![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | |||||||||||||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date when the socioeconomic data was recorded or applicable | |||||||||||||||
![]() ![]() |
ΣC | 0..1 | CodeableConcept | One of the sample valuesets that can be used is BenefitsVS. For all others, see the table: Binding: BenefitsVS (0.5.0) (example)
| |||||||||||||||
Documentation for this format | |||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Observation Status | 📍5.0.0 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Observation.code.coding:socioeconomicType | Base | required | Socioeconomic Observation Codes | 📍0.5.0 | This IG |
| Observation.value[x] | Base | example | Types of benefits | 📍0.5.0 | This IG |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | 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 | Observation.implicitRules, Observation.modifierExtension, Observation.status, Observation.code, Observation.code.coding, Observation.code.coding:socioeconomicType, Observation.code.coding:socioeconomicType.system, Observation.subject, Observation.effective[x], Observation.effective[x]:effectiveDateTime, Observation.value[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Observation.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.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.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| obs-8 | error | Observation | bodyStructure SHALL only be present if Observation.bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Observation(5.0.0) | Measurements and simple assertions | ||||||||||||||||
![]() ![]() |
S | 1..1 | CodeableConcept | Socioeconomic observation type. Education level code is aligned with EE MPI SocialHistory Education Level profile | |||||||||||||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||||||||||||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Required socioeconomic observation type code Binding: SocioeconomicObservationCodesVS (0.5.0) (required) | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||||||||||||||
![]() ![]() |
S | 1..1 | Reference(UZ Core Patient(0.5.0)) | Who and/or what the observation is about | |||||||||||||||
![]() ![]() |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | ||||||||||||||||
![]() ![]() ![]() |
S | 1..1 | dateTime | Date when the socioeconomic data was recorded or applicable | |||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | One of the sample valuesets that can be used is BenefitsVS. For all others, see the table: Binding: BenefitsVS (0.5.0) (example)
| ||||||||||||||||
Documentation for this format | |||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.code.coding:socioeconomicType | Base | required | Socioeconomic Observation Codes | 📍0.5.0 | This IG |
| Observation.value[x] | Base | example | Types of benefits | 📍0.5.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Observation(5.0.0) | Measurements and simple assertions Constraints: obs-6, obs-7, obs-8 | |||||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||||||||||||
![]() ![]() |
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 | ||||||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | ||||||||||||||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for observation | |||||||||||||||
![]() ![]() |
Σ | 0..1 | canonical(ObservationDefinition), Reference(ObservationDefinition) | Instantiates FHIR ObservationDefinition | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||||||||||||
![]() ![]() |
0..* | BackboneElement | Triggering observation(s) | ||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Observation) | Triggering observation | |||||||||||||||
![]() ![]() ![]() |
Σ | 1..1 | code | reflex | repeat | re-run Binding: TriggeredBytype (required): The type of TriggeredBy Observation. | |||||||||||||||
![]() ![]() ![]() |
0..1 | string | Reason that the observation was triggered | ||||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) | Part of referenced event | |||||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||||||||||||
![]() ![]() |
0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||||||
![]() ![]() |
SΣC | 1..1 | CodeableConcept | Socioeconomic observation type. Education level code is aligned with EE MPI SocialHistory Education Level profile Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||||||||||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||||||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Required socioeconomic observation type code Binding: SocioeconomicObservationCodesVS (0.5.0) (required) | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||
![]() ![]() |
SΣ | 1..1 | Reference(UZ Core Patient(0.5.0)) | Who and/or what the observation is about | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||||||||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||||||||||
![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | |||||||||||||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date when the socioeconomic data was recorded or applicable | |||||||||||||||
![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||||||||||||
![]() ![]() |
ΣC | 0..1 | CodeableConcept | One of the sample valuesets that can be used is BenefitsVS. For all others, see the table: Binding: BenefitsVS (0.5.0) (example)
| |||||||||||||||
![]() ![]() |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | |||||||||||||||
![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||||||
![]() ![]() |
0..* | Annotation | Comments about the observation | ||||||||||||||||
![]() ![]() |
C | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||||||||||||
![]() ![]() |
C | 0..1 | Reference(BodyStructure) | Observed body structure | |||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||||||||||||||
![]() ![]() |
C | 0..1 | Reference(Specimen | Group) | Specimen used for this observation Constraints: obs-9 | |||||||||||||||
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | A reference to the device that generates the measurements or the device settings for the device | ||||||||||||||||
![]() ![]() |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | |||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(5.0.0) | Low Range, if relevant | |||||||||||||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(5.0.0) | High Range, if relevant | |||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Normal value, if relevant Binding: ObservationReferenceRangeNormalValueCodes (extensible): Codes identifying the normal value of the observation. | ||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | ||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | ||||||||||||||||
![]() ![]() ![]() |
0..1 | Range | Applicable age range, if relevant | ||||||||||||||||
![]() ![]() ![]() |
C | 0..1 | markdown | Text based reference range in an observation | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |||||||||||||||
![]() ![]() |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | ImagingSelection | QuestionnaireResponse | Observation | MolecularSequence | GenomicStudy) | Related resource from which the observation is made | |||||||||||||||
![]() ![]() |
ΣC | 0..* | BackboneElement | Component results | |||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||||
![]() ![]() ![]() |
ΣC | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Actual component result | ||||||||||||||||
![]() ![]() ![]() ![]() |
Quantity | ||||||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | ||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||
![]() ![]() ![]() ![]() |
boolean | ||||||||||||||||||
![]() ![]() ![]() ![]() |
integer | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Range | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Ratio | ||||||||||||||||||
![]() ![]() ![]() ![]() |
SampledData | ||||||||||||||||||
![]() ![]() ![]() ![]() |
time | ||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Period | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Attachment | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Reference(MolecularSequence) | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||||||
![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | ||||||||||||||||
Documentation for this format | |||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Observation.triggeredBy.type | Base | required | triggered Bytype | 📍5.0.0 | FHIR Std. |
| Observation.status | Base | required | Observation Status | 📍5.0.0 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍5.0.0 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Observation.code.coding:socioeconomicType | Base | required | Socioeconomic Observation Codes | 📍0.5.0 | This IG |
| Observation.value[x] | Base | example | Types of benefits | 📍0.5.0 | This IG |
| Observation.dataAbsentReason | Base | extensible | Data Absent Reason | 📍5.0.0 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍5.0.0 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍5.0.0 | FHIR Std. |
| Observation.referenceRange.normalValue | Base | extensible | Observation Reference Range Normal Value Codes | 📍5.0.0 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍5.0.0 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍5.0.0 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | Data Absent Reason | 📍5.0.0 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍5.0.0 | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | 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 | Observation.meta, Observation.implicitRules, Observation.language, Observation.text, Observation.extension, Observation.modifierExtension, Observation.identifier, Observation.instantiates[x], Observation.basedOn, Observation.triggeredBy, Observation.triggeredBy.extension, Observation.triggeredBy.modifierExtension, Observation.triggeredBy.observation, Observation.triggeredBy.type, Observation.triggeredBy.reason, Observation.partOf, Observation.status, Observation.category, Observation.code, Observation.code.extension, Observation.code.coding, Observation.code.coding:socioeconomicType, Observation.code.coding:socioeconomicType.extension, Observation.code.coding:socioeconomicType.system, Observation.code.coding:socioeconomicType.version, Observation.code.coding:socioeconomicType.code, Observation.code.coding:socioeconomicType.display, Observation.code.coding:socioeconomicType.userSelected, Observation.code.text, Observation.subject, Observation.focus, Observation.encounter, Observation.effective[x], Observation.effective[x]:effectiveDateTime, Observation.issued, Observation.performer, Observation.value[x], Observation.dataAbsentReason, Observation.interpretation, Observation.note, Observation.bodySite, Observation.bodyStructure, Observation.method, Observation.specimen, Observation.device, Observation.referenceRange, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.normalValue, Observation.referenceRange.type, Observation.referenceRange.appliesTo, Observation.referenceRange.age, Observation.referenceRange.text, Observation.hasMember, Observation.derivedFrom, Observation.component, Observation.component.extension, Observation.component.modifierExtension, Observation.component.code, Observation.component.value[x], Observation.component.dataAbsentReason, Observation.component.interpretation, Observation.component.referenceRange | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Observation.extension, Observation.modifierExtension, Observation.triggeredBy.extension, Observation.triggeredBy.modifierExtension, Observation.code.extension, Observation.code.coding:socioeconomicType.extension, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.component.extension, Observation.component.modifierExtension | 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.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| obs-8 | error | Observation | bodyStructure SHALL only be present if Observation.bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| obs-9 | error | Observation.specimen | If Observation.specimen is a reference to Group, the group can only have specimens |
(reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)
|
Summary
Mandatory: 5 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
This profile is on Observation, so use the Observation endpoint. [base] is the FHIR server base URL; | separates system from value and must be URL-encoded as %7C.
Read by server id
GET [base]/Observation/[id]
Find socioeconomic observations
GET [base]/Observation?patient=Patient/[id]&category=social-history
GET [base]/Observation?patient=Patient/[id]&code=http://snomed.info/sct%7C1303306008
GET [base]/Observation?patient=Patient/[id]&date=ge2025-01-01
GET [base]/Observation?patient=Patient/[id]&status=final
Create
POST [base]/Observation
{
"resourceType": "Observation",
"meta": {
"profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-socioeconomic-observation" ]
},
"status": "final",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1303306008",
"display": "Eligible for benefit"
}
]
},
"subject": { "reference": "Patient/[id]" },
"effectiveDateTime": "2025-06-11",
...
}
Update (e.g. correct a recorded value by setting status to corrected) - PUT the full resource back with the new status / value[x]:
PUT [base]/Observation/[id]
If-Match: W/"3" # the ETag from your last read; 412 if it changed since
See the CapabilityStatement for all supported search parameters.