Uzbekistan Digital Health Platform
0.13.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.13.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-laboratory-observation-definition | Version: 0.13.0 | ||||
| Active as of 2026-11-19 | Computable Name: UZCoreLaboratoryObservationDefinition | ||||
Uzbekistan Core Laboratory ObservationDefinition profile, used to structurally describe laboratory services provided by healthcare organizations in the Patient Portal. It allows defining the laboratory service code, related analytes, reference ranges, and permitted coded normal values required to display information about laboratory tests to Patient Portal users.
UZ Core Laboratory ObservationDefinition describes a laboratory test as a catalogue entry, not a result: what the test or panel is called and coded, which analytes it reports, in which units, by which method, and what the normal ranges are. The Patient Portal uses these definitions to show patients what a test measures and how to read their values. One definition serves the whole country: each organization that offers the test publishes a HealthcareService that points to the definition's canonical url through the service definition extension. The results themselves are Observations with the same code. Look for an existing definition by its code or identifier before you create a new one.
The elements below must always be present (mandatory) or must be supported when the data is available (Must Support). Not all of them 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.
status (draft / active / retired / unknown);code of the laboratory test or panel;useContext with the laboratory focus, which marks the resource as a laboratory definition (see the laboratory focus).A component, when present, must have its own code.
url that HealthcareService entries point to, and a business identifier;name and a title in Uzbek, with Russian and Karakalpak translations;date it was last changed and a plain-language description;subject type the test applies to (usually a patient);category (laboratory) and the test or panel code;permittedDataType, such as Quantity, CodeableConcept or string) and units (permittedUnit, UCUM);method;qualifiedValue): context, sex, range category, the range itself, or a value set of normal coded values;hasMember);component), each with its code, result types and units.Definitions are shared, so check the catalogue first. Search by the test code, by the business identifier or by the canonical URL:
GET [base]/ObservationDefinition?code=https://terminology.dhp.uz/fhir/core/CodeSystem/lab-pan-cs%7Clab-pan-74
GET [base]/ObservationDefinition?identifier=[system]%7C[value]
GET [base]/ObservationDefinition?url=[canonical-url]
Add &status=active to leave out drafts and retired definitions.
The examples below go from the smallest valid definition to a panel with its analytes. Each one validates against this profile. The complete reference instance is the hemoglobin definition.
A definition needs a status, a code and the laboratory focus in useContext. The focus is fixed: the code is focus from the HL7 usage context types and the value is the SNOMED CT concept 108252007 "Laboratory procedure". It is what lets clients tell laboratory definitions apart from other ObservationDefinitions on the server:
{
"resourceType": "ObservationDefinition",
"meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-laboratory-observation-definition"] },
"status": "active",
"useContext": [
{
"code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "focus" },
"valueCodeableConcept": {
"coding": [ { "system": "http://snomed.info/sct", "code": "108252007", "display": "Laboratory procedure" } ]
}
}
],
"code": {
"coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/lab-pan-cs", "code": "lab-pan-74" } ]
}
}
code here is lab-pan-74 (hemoglobin) from the national laboratory panel codes; LOINC and SNOMED CT codes are allowed too. Copy the focus coding exactly as shown, display included, since the profile fixes the whole value.
A full catalogue entry gives the canonical url, the names, the date and description, and how results are reported: the permittedDataType, the UCUM unit and the method:
{
"resourceType": "ObservationDefinition",
"meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-laboratory-observation-definition"] },
"url": "https://dhp.uz/fhir/core/ObservationDefinition/laboratory-hemoglobin",
"name": "HemoglobinMassPerVolumeInBlood",
"title": "Gemoglobin (HB)",
"_title": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/translation",
"extension": [
{ "url": "lang", "valueCode": "ru" },
{ "url": "content", "valueString": "Гемоглобин (HB)" }
]
}
]
},
"status": "active",
"date": "2026-01-16",
"description": "Mass concentration of hemoglobin in whole blood, shown to Patient Portal users in g/L.",
"useContext": [
{
"code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "focus" },
"valueCodeableConcept": {
"coding": [ { "system": "http://snomed.info/sct", "code": "108252007", "display": "Laboratory procedure" } ]
}
}
],
"subject": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "116154003", "display": "Patient" } ] } ],
"category": [
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "laboratory" } ] }
],
"code": {
"coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/lab-pan-cs", "code": "lab-pan-74" } ]
},
"permittedDataType": [ "Quantity" ],
"permittedUnit": [ { "system": "http://unitsofmeasure.org", "code": "g/L" } ],
"method": {
"coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/lab-methods-cs", "code": "lab-method-6" } ]
}
}
The url above is illustrative. The title is in Uzbek; Russian and Karakalpak forms go in translation extensions on the _title companion element, one per language. permittedUnit must carry a UCUM code; the national supplement gives each unit its Uzbek and Russian names. method here is spectrophotometry from the national laboratory methods.
qualifiedValue holds the normal ranges the Patient Portal shows next to a result. Repeat it for each population that has its own range; here men and women:
{
"resourceType": "ObservationDefinition",
"meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-laboratory-observation-definition"] },
"status": "active",
"useContext": [
{
"code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "focus" },
"valueCodeableConcept": {
"coding": [ { "system": "http://snomed.info/sct", "code": "108252007", "display": "Laboratory procedure" } ]
}
}
],
"code": {
"coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/lab-pan-cs", "code": "lab-pan-74" } ]
},
"permittedDataType": [ "Quantity" ],
"permittedUnit": [ { "system": "http://unitsofmeasure.org", "code": "g/L" } ],
"qualifiedValue": [
{
"context": {
"coding": [ { "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning", "code": "normal" } ]
},
"gender": "male",
"rangeCategory": "reference",
"range": {
"low": { "value": 130, "unit": "g/L", "system": "http://unitsofmeasure.org", "code": "g/L" },
"high": { "value": 170, "unit": "g/L", "system": "http://unitsofmeasure.org", "code": "g/L" }
}
},
{
"context": {
"coding": [ { "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning", "code": "normal" } ]
},
"gender": "female",
"rangeCategory": "reference",
"range": {
"low": { "value": 120, "unit": "g/L", "system": "http://unitsofmeasure.org", "code": "g/L" },
"high": { "value": 150, "unit": "g/L", "system": "http://unitsofmeasure.org", "code": "g/L" }
}
}
]
}
rangeCategory says what kind of range it is (reference / critical / absolute), context what the range means (normal, recommended, therapeutic …) and gender whom it applies to. Use age or gestationalAge in the same way for age-specific ranges. For tests with coded results, such as "negative" / "positive", point normalCodedValueSet to a value set of the normal codes instead of giving a range.
A panel such as the complete blood count lists its analytes in component. Each component has its own code, result types and units, and the panel code stays on the resource:
{
"resourceType": "ObservationDefinition",
"meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-laboratory-observation-definition"] },
"status": "active",
"useContext": [
{
"code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "focus" },
"valueCodeableConcept": {
"coding": [ { "system": "http://snomed.info/sct", "code": "108252007", "display": "Laboratory procedure" } ]
}
}
],
"category": [
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "laboratory" } ] }
],
"code": {
"coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/lab-pan-cs", "code": "lab-pan-E" } ]
},
"component": [
{
"code": {
"coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/lab-pan-cs", "code": "lab-pan-74" } ]
},
"permittedDataType": [ "Quantity" ],
"permittedUnit": [ { "system": "http://unitsofmeasure.org", "code": "g/L" } ]
},
{
"code": {
"coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/lab-pan-cs", "code": "lab-pan-75" } ]
},
"permittedDataType": [ "Quantity" ],
"permittedUnit": [ { "system": "http://unitsofmeasure.org", "code": "10*12/L" } ]
}
]
}
Catalogue panels use the national laboratory panel codes for their analytes. When a user builds a custom laboratory definition in the Patient Portal, each component.code must be a LOINC code (for example 718-7 for hemoglobin); the national codes are kept for the pre-defined catalogue. Use component when the analytes have no definition of their own; when each analyte is defined separately, as hemoglobin is above, list those definitions in hasMember instead.
For example API calls, 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..* | ObservationDefinition(5.0.0) | Definition of an observation Interfaces Implemented: MetadataResource Constraints: cnl-0, obd-0 | ||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | |||||||
![]() ![]() |
0..1 | Identifier | Identifier of the ObservationDefinition | |||||||
![]() ![]() |
C | 0..1 | string | Name for this ObservationDefinition (computer friendly) | ||||||
![]() ![]() |
0..1 | string | Observation definition title (in Uzbek language) | |||||||
![]() ![]() ![]() |
0..* | Extension | Observation definition title (in Russian and Karakalpak languages) Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1 | |||||||
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.13.0) (required) | |||||||
![]() ![]() |
0..1 | dateTime | Date last changed | |||||||
![]() ![]() |
0..1 | markdown | Natural language description of the ObservationDefinition | |||||||
![]() ![]() |
1..* | UsageContext | Content intends to support these contexts Slice: Unordered, Open by value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||
![]() ![]() ![]() |
1..1 | UsageContext | Marks this ObservationDefinition as a laboratory definition | |||||||
![]() ![]() ![]() ![]() |
1..1 | Coding | Type of context being specified Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: | |||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: | |||||||
![]() ![]() |
0..* | CodeableConcept | Type of subject for the defined observation | |||||||
![]() ![]() |
0..* | CodeableConcept | General type of observation Binding: ObservationCategoryVS (0.13.0) (example) | |||||||
![]() ![]() |
1..1 | CodeableConcept | Laboratory panel or test code displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example) | |||||||
![]() ![]() |
C | 0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) Example General: CodeableConcept | ||||||
![]() ![]() |
0..1 | CodeableConcept | Laboratory method used to perform the test or analyte measurement Binding: LabMethodsVS (0.13.0) (example) | |||||||
![]() ![]() |
C | 0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Slice: Unordered, Open by value:$this Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||
![]() ![]() ![]() |
C | 0..* | Coding | Permitted unit from UCUM Binding: UCUMUnitsSupplementVS (0.13.0) (required) | ||||||
![]() ![]() |
0..* | BackboneElement | Set of qualified values for observation results | |||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: ReferenceRangeMeaningVS (0.13.0) (extensible) | |||||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGenderVS (0.13.0) (required) Example General: female | |||||||
![]() ![]() ![]() |
0..1 | code | reference | critical | absolute Binding: ObservationRangeCategoryVS (0.13.0) (required) Example General: critical | |||||||
![]() ![]() ![]() |
0..1 | Range | Reference range used as the normal value for the laboratory analyte displayed in the Patient Portal | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set defining coded normal values for the laboratory analyte | |||||||
![]() ![]() |
0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Component results Constraints: obd-1 | ||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Laboratory analyte or indicator code included in the laboratory panel displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example)
| |||||||
![]() ![]() ![]() |
C | 0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) Example General: CodeableConcept | ||||||
![]() ![]() ![]() |
C | 0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) | ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.status | Base | required | Publication status | 📍0.13.0 | This IG |
| ObservationDefinition.useContext:laboratoryFocus.code | Base | extensible | UsageContextType | 📍1.0.1 | THO v7.5 |
| ObservationDefinition.useContext:laboratoryFocus.value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.category | Base | example | Observation category | 📍0.13.0 | This IG |
| ObservationDefinition.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.method | Base | example | Observation laboratory method | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit:ucum | Base | required | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.context | Base | extensible | Reference range meaning | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.gender | Base | required | Administrative gender | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.rangeCategory | Base | required | Observation range category | 📍0.13.0 | This IG |
| ObservationDefinition.component.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ObservationDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ObservationDefinition(5.0.0) | Definition of an observation Interfaces Implemented: MetadataResource | |||||||
![]() ![]() |
0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | |||||||
![]() ![]() |
0..1 | Identifier | Identifier of the ObservationDefinition | |||||||
![]() ![]() |
0..1 | string | Name for this ObservationDefinition (computer friendly) | |||||||
![]() ![]() |
0..1 | string | Observation definition title (in Uzbek language) | |||||||
![]() ![]() ![]() |
0..* | Extension | Observation definition title (in Russian and Karakalpak languages) Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||||
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.13.0) (required) | |||||||
![]() ![]() |
0..1 | dateTime | Date last changed | |||||||
![]() ![]() |
0..1 | markdown | Natural language description of the ObservationDefinition | |||||||
![]() ![]() |
1..* | UsageContext | Content intends to support these contexts Slice: Unordered, Open by value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||
![]() ![]() ![]() |
1..1 | UsageContext | Marks this ObservationDefinition as a laboratory definition | |||||||
![]() ![]() ![]() ![]() |
1..1 | Coding | Type of context being specified Required Pattern: | |||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value that defines the context Required Pattern: | |||||||
![]() ![]() |
0..* | CodeableConcept | Type of subject for the defined observation | |||||||
![]() ![]() |
0..* | CodeableConcept | General type of observation Binding: ObservationCategoryVS (0.13.0) (example) | |||||||
![]() ![]() |
1..1 | CodeableConcept | Laboratory panel or test code displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example) | |||||||
![]() ![]() |
0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) | |||||||
![]() ![]() |
0..1 | CodeableConcept | Laboratory method used to perform the test or analyte measurement Binding: LabMethodsVS (0.13.0) (example) | |||||||
![]() ![]() |
0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Slice: Unordered, Open by value:$this Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||
![]() ![]() ![]() |
0..* | Coding | Permitted unit from UCUM Binding: UCUMUnitsSupplementVS (0.13.0) (required) | |||||||
![]() ![]() |
0..* | BackboneElement | Set of qualified values for observation results | |||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: ReferenceRangeMeaningVS (0.13.0) (extensible) | |||||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGenderVS (0.13.0) (required) | |||||||
![]() ![]() ![]() |
0..1 | code | reference | critical | absolute Binding: ObservationRangeCategoryVS (0.13.0) (required) | |||||||
![]() ![]() ![]() |
0..1 | Range | Reference range used as the normal value for the laboratory analyte displayed in the Patient Portal | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set defining coded normal values for the laboratory analyte | |||||||
![]() ![]() |
0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |||||||
![]() ![]() |
0..* | BackboneElement | Component results | |||||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Laboratory analyte or indicator code included in the laboratory panel displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example)
| |||||||
![]() ![]() ![]() |
0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) | |||||||
![]() ![]() ![]() |
0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) | |||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.status | Base | required | Publication status | 📍0.13.0 | This IG |
| ObservationDefinition.category | Base | example | Observation category | 📍0.13.0 | This IG |
| ObservationDefinition.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.method | Base | example | Observation laboratory method | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit:ucum | Base | required | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.context | Base | extensible | Reference range meaning | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.gender | Base | required | Administrative gender | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.rangeCategory | Base | required | Observation range category | 📍0.13.0 | This IG |
| ObservationDefinition.component.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ObservationDefinition(5.0.0) | Definition of an observation Interfaces Implemented: MetadataResource Constraints: cnl-0, obd-0 | ||||||
![]() ![]() |
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..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | |||||||
![]() ![]() |
0..1 | Identifier | Identifier of the ObservationDefinition | |||||||
![]() ![]() |
0..1 | string | Business version of the ObservationDefinition | |||||||
![]() ![]() |
0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | ||||||||
![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() |
Coding | |||||||||
![]() ![]() |
C | 0..1 | string | Name for this ObservationDefinition (computer friendly) | ||||||
![]() ![]() |
0..1 | string | Observation definition title (in Uzbek language) | |||||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() |
0..* | Extension | Observation definition title (in Russian and Karakalpak languages) Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1 | |||||||
![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||||
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.13.0) (required) | |||||||
![]() ![]() |
0..1 | boolean | If for testing purposes, not real usage | |||||||
![]() ![]() |
0..1 | dateTime | Date last changed | |||||||
![]() ![]() |
0..1 | string | The name of the individual or organization that published the ObservationDefinition | |||||||
![]() ![]() |
0..* | ContactDetail | Contact details for the publisher | |||||||
![]() ![]() |
0..1 | markdown | Natural language description of the ObservationDefinition | |||||||
![]() ![]() |
1..* | UsageContext | Content intends to support these contexts Slice: Unordered, Open by value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||
![]() ![]() ![]() |
1..1 | UsageContext | Marks this ObservationDefinition as a laboratory definition | |||||||
![]() ![]() ![]() ![]() |
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..1 | Coding | Type of context being specified Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: | |||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: | |||||||
![]() ![]() |
0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Binding: JurisdictionValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used. | |||||||
![]() ![]() |
0..1 | markdown | Why this ObservationDefinition is defined | |||||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||||
![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||||
![]() ![]() |
0..1 | date | When ObservationDefinition was approved by publisher | |||||||
![]() ![]() |
0..1 | date | Date on which the asset content was last reviewed by the publisher | |||||||
![]() ![]() |
0..1 | Period | The effective date range for the ObservationDefinition | |||||||
![]() ![]() |
0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation | |||||||
![]() ![]() |
0..* | uri | Based on external definition | |||||||
![]() ![]() |
0..* | CodeableConcept | Type of subject for the defined observation | |||||||
![]() ![]() |
0..1 | CodeableConcept | Desired kind of performer for such kind of observation | |||||||
![]() ![]() |
0..* | CodeableConcept | General type of observation Binding: ObservationCategoryVS (0.13.0) (example) | |||||||
![]() ![]() |
1..1 | CodeableConcept | Laboratory panel or test code displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example) | |||||||
![]() ![]() |
C | 0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) Example General: CodeableConcept | ||||||
![]() ![]() |
0..1 | boolean | Multiple results allowed for conforming observations Example General: true | |||||||
![]() ![]() |
0..1 | CodeableConcept | Body part to be observed Binding: SNOMEDCTBodyStructures (example): SNOMED CT body structures. | |||||||
![]() ![]() |
0..1 | CodeableConcept | Laboratory method used to perform the test or analyte measurement Binding: LabMethodsVS (0.13.0) (example) | |||||||
![]() ![]() |
0..* | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | |||||||
![]() ![]() |
0..* | Reference(DeviceDefinition | Device) | Measurement device or model of device | |||||||
![]() ![]() |
0..1 | string | The preferred name to be used when reporting the observation results | |||||||
![]() ![]() |
C | 0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Slice: Unordered, Open by value:$this Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||
![]() ![]() ![]() |
C | 0..* | Coding | Permitted unit from UCUM Binding: UCUMUnitsSupplementVS (0.13.0) (required) | ||||||
![]() ![]() |
0..* | BackboneElement | Set of qualified values for observation 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 | |||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: ReferenceRangeMeaningVS (0.13.0) (extensible) | |||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Targetted population for the set of qualified values Binding: ObservationReferenceRangeAppliesToCodes (example) | |||||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGenderVS (0.13.0) (required) Example General: female | |||||||
![]() ![]() ![]() |
0..1 | Range | Applicable age range for the set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | Range | Applicable gestational age range for the set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | string | Condition associated with the set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | code | reference | critical | absolute Binding: ObservationRangeCategoryVS (0.13.0) (required) Example General: critical | |||||||
![]() ![]() ![]() |
0..1 | Range | Reference range used as the normal value for the laboratory analyte displayed in the Patient Portal | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set of valid coded values as part of this set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set defining coded normal values for the laboratory analyte | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set of abnormal coded values as part of this set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set of critical coded values as part of this set of qualified values | |||||||
![]() ![]() |
0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Component results Constraints: obd-1 | ||||||
![]() ![]() ![]() |
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 | CodeableConcept | Laboratory analyte or indicator code included in the laboratory panel displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example)
| |||||||
![]() ![]() ![]() |
C | 0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) Example General: CodeableConcept | ||||||
![]() ![]() ![]() |
C | 0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) | ||||||
![]() ![]() ![]() |
0..* | See qualifiedValue (ObservationDefinition) | Set of qualified values for observation results | |||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.status | Base | required | Publication status | 📍0.13.0 | This IG |
| ObservationDefinition.useContext:laboratoryFocus.code | Base | extensible | UsageContextType | 📍1.0.1 | THO v7.5 |
| ObservationDefinition.useContext:laboratoryFocus.value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.category | Base | example | Observation category | 📍0.13.0 | This IG |
| ObservationDefinition.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.method | Base | example | Observation laboratory method | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit:ucum | Base | required | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.context | Base | extensible | Reference range meaning | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.qualifiedValue.gender | Base | required | Administrative gender | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.rangeCategory | Base | required | Observation range category | 📍0.13.0 | This IG |
| ObservationDefinition.component.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ObservationDefinition
Summary
Mandatory: 2 elements
Must-Support: 21 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ObservationDefinition(5.0.0) | Definition of an observation Interfaces Implemented: MetadataResource Constraints: cnl-0, obd-0 | ||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | |||||||
![]() ![]() |
0..1 | Identifier | Identifier of the ObservationDefinition | |||||||
![]() ![]() |
C | 0..1 | string | Name for this ObservationDefinition (computer friendly) | ||||||
![]() ![]() |
0..1 | string | Observation definition title (in Uzbek language) | |||||||
![]() ![]() ![]() |
0..* | Extension | Observation definition title (in Russian and Karakalpak languages) Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1 | |||||||
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.13.0) (required) | |||||||
![]() ![]() |
0..1 | dateTime | Date last changed | |||||||
![]() ![]() |
0..1 | markdown | Natural language description of the ObservationDefinition | |||||||
![]() ![]() |
1..* | UsageContext | Content intends to support these contexts Slice: Unordered, Open by value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||
![]() ![]() ![]() |
1..1 | UsageContext | Marks this ObservationDefinition as a laboratory definition | |||||||
![]() ![]() ![]() ![]() |
1..1 | Coding | Type of context being specified Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: | |||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: | |||||||
![]() ![]() |
0..* | CodeableConcept | Type of subject for the defined observation | |||||||
![]() ![]() |
0..* | CodeableConcept | General type of observation Binding: ObservationCategoryVS (0.13.0) (example) | |||||||
![]() ![]() |
1..1 | CodeableConcept | Laboratory panel or test code displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example) | |||||||
![]() ![]() |
C | 0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) Example General: CodeableConcept | ||||||
![]() ![]() |
0..1 | CodeableConcept | Laboratory method used to perform the test or analyte measurement Binding: LabMethodsVS (0.13.0) (example) | |||||||
![]() ![]() |
C | 0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Slice: Unordered, Open by value:$this Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||
![]() ![]() ![]() |
C | 0..* | Coding | Permitted unit from UCUM Binding: UCUMUnitsSupplementVS (0.13.0) (required) | ||||||
![]() ![]() |
0..* | BackboneElement | Set of qualified values for observation results | |||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: ReferenceRangeMeaningVS (0.13.0) (extensible) | |||||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGenderVS (0.13.0) (required) Example General: female | |||||||
![]() ![]() ![]() |
0..1 | code | reference | critical | absolute Binding: ObservationRangeCategoryVS (0.13.0) (required) Example General: critical | |||||||
![]() ![]() ![]() |
0..1 | Range | Reference range used as the normal value for the laboratory analyte displayed in the Patient Portal | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set defining coded normal values for the laboratory analyte | |||||||
![]() ![]() |
0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Component results Constraints: obd-1 | ||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Laboratory analyte or indicator code included in the laboratory panel displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example)
| |||||||
![]() ![]() ![]() |
C | 0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) Example General: CodeableConcept | ||||||
![]() ![]() ![]() |
C | 0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) | ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.status | Base | required | Publication status | 📍0.13.0 | This IG |
| ObservationDefinition.useContext:laboratoryFocus.code | Base | extensible | UsageContextType | 📍1.0.1 | THO v7.5 |
| ObservationDefinition.useContext:laboratoryFocus.value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.category | Base | example | Observation category | 📍0.13.0 | This IG |
| ObservationDefinition.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.method | Base | example | Observation laboratory method | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit:ucum | Base | required | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.context | Base | extensible | Reference range meaning | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.gender | Base | required | Administrative gender | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.rangeCategory | Base | required | Observation range category | 📍0.13.0 | This IG |
| ObservationDefinition.component.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from ObservationDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ObservationDefinition(5.0.0) | Definition of an observation Interfaces Implemented: MetadataResource | |||||||
![]() ![]() |
0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | |||||||
![]() ![]() |
0..1 | Identifier | Identifier of the ObservationDefinition | |||||||
![]() ![]() |
0..1 | string | Name for this ObservationDefinition (computer friendly) | |||||||
![]() ![]() |
0..1 | string | Observation definition title (in Uzbek language) | |||||||
![]() ![]() ![]() |
0..* | Extension | Observation definition title (in Russian and Karakalpak languages) Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||||
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.13.0) (required) | |||||||
![]() ![]() |
0..1 | dateTime | Date last changed | |||||||
![]() ![]() |
0..1 | markdown | Natural language description of the ObservationDefinition | |||||||
![]() ![]() |
1..* | UsageContext | Content intends to support these contexts Slice: Unordered, Open by value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||
![]() ![]() ![]() |
1..1 | UsageContext | Marks this ObservationDefinition as a laboratory definition | |||||||
![]() ![]() ![]() ![]() |
1..1 | Coding | Type of context being specified Required Pattern: | |||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value that defines the context Required Pattern: | |||||||
![]() ![]() |
0..* | CodeableConcept | Type of subject for the defined observation | |||||||
![]() ![]() |
0..* | CodeableConcept | General type of observation Binding: ObservationCategoryVS (0.13.0) (example) | |||||||
![]() ![]() |
1..1 | CodeableConcept | Laboratory panel or test code displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example) | |||||||
![]() ![]() |
0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) | |||||||
![]() ![]() |
0..1 | CodeableConcept | Laboratory method used to perform the test or analyte measurement Binding: LabMethodsVS (0.13.0) (example) | |||||||
![]() ![]() |
0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Slice: Unordered, Open by value:$this Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||
![]() ![]() ![]() |
0..* | Coding | Permitted unit from UCUM Binding: UCUMUnitsSupplementVS (0.13.0) (required) | |||||||
![]() ![]() |
0..* | BackboneElement | Set of qualified values for observation results | |||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: ReferenceRangeMeaningVS (0.13.0) (extensible) | |||||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGenderVS (0.13.0) (required) | |||||||
![]() ![]() ![]() |
0..1 | code | reference | critical | absolute Binding: ObservationRangeCategoryVS (0.13.0) (required) | |||||||
![]() ![]() ![]() |
0..1 | Range | Reference range used as the normal value for the laboratory analyte displayed in the Patient Portal | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set defining coded normal values for the laboratory analyte | |||||||
![]() ![]() |
0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |||||||
![]() ![]() |
0..* | BackboneElement | Component results | |||||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Laboratory analyte or indicator code included in the laboratory panel displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example)
| |||||||
![]() ![]() ![]() |
0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) | |||||||
![]() ![]() ![]() |
0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) | |||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.status | Base | required | Publication status | 📍0.13.0 | This IG |
| ObservationDefinition.category | Base | example | Observation category | 📍0.13.0 | This IG |
| ObservationDefinition.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.method | Base | example | Observation laboratory method | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit:ucum | Base | required | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.context | Base | extensible | Reference range meaning | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.gender | Base | required | Administrative gender | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.rangeCategory | Base | required | Observation range category | 📍0.13.0 | This IG |
| ObservationDefinition.component.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ObservationDefinition(5.0.0) | Definition of an observation Interfaces Implemented: MetadataResource Constraints: cnl-0, obd-0 | ||||||
![]() ![]() |
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..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | |||||||
![]() ![]() |
0..1 | Identifier | Identifier of the ObservationDefinition | |||||||
![]() ![]() |
0..1 | string | Business version of the ObservationDefinition | |||||||
![]() ![]() |
0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | ||||||||
![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() |
Coding | |||||||||
![]() ![]() |
C | 0..1 | string | Name for this ObservationDefinition (computer friendly) | ||||||
![]() ![]() |
0..1 | string | Observation definition title (in Uzbek language) | |||||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() |
0..* | Extension | Observation definition title (in Russian and Karakalpak languages) Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1 | |||||||
![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||||
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.13.0) (required) | |||||||
![]() ![]() |
0..1 | boolean | If for testing purposes, not real usage | |||||||
![]() ![]() |
0..1 | dateTime | Date last changed | |||||||
![]() ![]() |
0..1 | string | The name of the individual or organization that published the ObservationDefinition | |||||||
![]() ![]() |
0..* | ContactDetail | Contact details for the publisher | |||||||
![]() ![]() |
0..1 | markdown | Natural language description of the ObservationDefinition | |||||||
![]() ![]() |
1..* | UsageContext | Content intends to support these contexts Slice: Unordered, Open by value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||
![]() ![]() ![]() |
1..1 | UsageContext | Marks this ObservationDefinition as a laboratory definition | |||||||
![]() ![]() ![]() ![]() |
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..1 | Coding | Type of context being specified Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: | |||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: | |||||||
![]() ![]() |
0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Binding: JurisdictionValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used. | |||||||
![]() ![]() |
0..1 | markdown | Why this ObservationDefinition is defined | |||||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||||
![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||||
![]() ![]() |
0..1 | date | When ObservationDefinition was approved by publisher | |||||||
![]() ![]() |
0..1 | date | Date on which the asset content was last reviewed by the publisher | |||||||
![]() ![]() |
0..1 | Period | The effective date range for the ObservationDefinition | |||||||
![]() ![]() |
0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation | |||||||
![]() ![]() |
0..* | uri | Based on external definition | |||||||
![]() ![]() |
0..* | CodeableConcept | Type of subject for the defined observation | |||||||
![]() ![]() |
0..1 | CodeableConcept | Desired kind of performer for such kind of observation | |||||||
![]() ![]() |
0..* | CodeableConcept | General type of observation Binding: ObservationCategoryVS (0.13.0) (example) | |||||||
![]() ![]() |
1..1 | CodeableConcept | Laboratory panel or test code displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example) | |||||||
![]() ![]() |
C | 0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) Example General: CodeableConcept | ||||||
![]() ![]() |
0..1 | boolean | Multiple results allowed for conforming observations Example General: true | |||||||
![]() ![]() |
0..1 | CodeableConcept | Body part to be observed Binding: SNOMEDCTBodyStructures (example): SNOMED CT body structures. | |||||||
![]() ![]() |
0..1 | CodeableConcept | Laboratory method used to perform the test or analyte measurement Binding: LabMethodsVS (0.13.0) (example) | |||||||
![]() ![]() |
0..* | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | |||||||
![]() ![]() |
0..* | Reference(DeviceDefinition | Device) | Measurement device or model of device | |||||||
![]() ![]() |
0..1 | string | The preferred name to be used when reporting the observation results | |||||||
![]() ![]() |
C | 0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Slice: Unordered, Open by value:$this Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||
![]() ![]() ![]() |
C | 0..* | Coding | Permitted unit from UCUM Binding: UCUMUnitsSupplementVS (0.13.0) (required) | ||||||
![]() ![]() |
0..* | BackboneElement | Set of qualified values for observation 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 | |||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: ReferenceRangeMeaningVS (0.13.0) (extensible) | |||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Targetted population for the set of qualified values Binding: ObservationReferenceRangeAppliesToCodes (example) | |||||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGenderVS (0.13.0) (required) Example General: female | |||||||
![]() ![]() ![]() |
0..1 | Range | Applicable age range for the set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | Range | Applicable gestational age range for the set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | string | Condition associated with the set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | code | reference | critical | absolute Binding: ObservationRangeCategoryVS (0.13.0) (required) Example General: critical | |||||||
![]() ![]() ![]() |
0..1 | Range | Reference range used as the normal value for the laboratory analyte displayed in the Patient Portal | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set of valid coded values as part of this set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set defining coded normal values for the laboratory analyte | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set of abnormal coded values as part of this set of qualified values | |||||||
![]() ![]() ![]() |
0..1 | canonical(ValueSet) | Value set of critical coded values as part of this set of qualified values | |||||||
![]() ![]() |
0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Component results Constraints: obd-1 | ||||||
![]() ![]() ![]() |
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 | CodeableConcept | Laboratory analyte or indicator code included in the laboratory panel displayed in the Patient Portal Binding: ObservationCodesVS (0.13.0) (example)
| |||||||
![]() ![]() ![]() |
C | 0..* | code | Allowed value types for laboratory observation results Binding: PermittedDataTypeVS (0.13.0) (required) Example General: CodeableConcept | ||||||
![]() ![]() ![]() |
C | 0..* | Coding | Permitted unit of measure for the laboratory analyte value in uzbek and russian translations Binding: UCUMUnitsSupplementVS (0.13.0) (preferred) | ||||||
![]() ![]() ![]() |
0..* | See qualifiedValue (ObservationDefinition) | Set of qualified values for observation results | |||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.status | Base | required | Publication status | 📍0.13.0 | This IG |
| ObservationDefinition.useContext:laboratoryFocus.code | Base | extensible | UsageContextType | 📍1.0.1 | THO v7.5 |
| ObservationDefinition.useContext:laboratoryFocus.value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.category | Base | example | Observation category | 📍0.13.0 | This IG |
| ObservationDefinition.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.method | Base | example | Observation laboratory method | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.permittedUnit:ucum | Base | required | UCUM unit | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.context | Base | extensible | Reference range meaning | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍5.0.0 | FHIR Std. |
| ObservationDefinition.qualifiedValue.gender | Base | required | Administrative gender | 📍0.13.0 | This IG |
| ObservationDefinition.qualifiedValue.rangeCategory | Base | required | Observation range category | 📍0.13.0 | This IG |
| ObservationDefinition.component.code | Base | example | Observation codes | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedDataType | Base | required | Permitted data type | 📍0.13.0 | This IG |
| ObservationDefinition.component.permittedUnit | Base | preferred | UCUM unit | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ObservationDefinition
Summary
Mandatory: 2 elements
Must-Support: 21 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Common API interactions for this profile. Requests require a JWT access token - see Security and authentication. [base] is the FHIR server base URL; | separates a code system from its value and must be URL-encoded as %7C.
Read a definition by server id, and its earlier versions
GET [base]/ObservationDefinition/[id]
GET [base]/ObservationDefinition/[id]/_history
Search
GET [base]/ObservationDefinition?code=https://terminology.dhp.uz/fhir/core/CodeSystem/lab-pan-cs%7Clab-pan-74
GET [base]/ObservationDefinition?identifier=[system]%7C[value]
GET [base]/ObservationDefinition?url=[canonical-url]
GET [base]/ObservationDefinition?category=laboratory&status=active
GET [base]/ObservationDefinition?method=https://terminology.dhp.uz/fhir/core/CodeSystem/lab-methods-cs%7Clab-method-6
GET [base]/ObservationDefinition?title=Gemoglobin
GET [base]/ObservationDefinition?_profile=https://dhp.uz/fhir/core/StructureDefinition/uz-core-laboratory-observation-definition
The last query returns only laboratory definitions, since every one of them declares this profile.
Create a definition
POST [base]/ObservationDefinition
{
"resourceType": "ObservationDefinition",
"meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-laboratory-observation-definition" ] },
"url": "[canonical-url]",
"status": "draft",
"useContext": [ { "code": { ... "focus" }, "valueCodeableConcept": { ... "108252007" } } ],
"code": { "coding": [ { "system": "http://loinc.org", "code": "..." } ] },
...
}
Update an existing definition (e.g. set status to active once it is reviewed, or retired when the test is withdrawn)
PUT [base]/ObservationDefinition/[id]
If-Match: W/"3" # the ETag from your last read; 412 if it changed since
{
"resourceType": "ObservationDefinition",
"id": "[id]",
"meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-laboratory-observation-definition" ] },
"status": "active",
...
}
Keep the url unchanged on update: HealthcareService entries point to the definition by it.
See the CapabilityStatement for the full list of supported search parameters.