Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-ObservationDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_ObservationDefinition_R4 | ||
This cross-version profile allows R5 ObservationDefinition content to be represented via FHIR R4 ObservationDefinition resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ObservationDefinition | 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 | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ObservationDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ObservationDefinition.implicitRules, ObservationDefinition.extension, ObservationDefinition.extension:url, ObservationDefinition.extension:version, ObservationDefinition.extension:versionAlgorithm, ObservationDefinition.extension:name, ObservationDefinition.extension:title, ObservationDefinition.extension:experimental, ObservationDefinition.extension:date, ObservationDefinition.extension:publisher, ObservationDefinition.extension:contact, ObservationDefinition.extension:description, ObservationDefinition.extension:useContext, ObservationDefinition.extension:jurisdiction, ObservationDefinition.extension:purpose, ObservationDefinition.extension:copyright, ObservationDefinition.extension:copyrightLabel, ObservationDefinition.extension:approvalDate, ObservationDefinition.extension:lastReviewDate, ObservationDefinition.extension:effectivePeriod, ObservationDefinition.extension:derivedFromCanonical, ObservationDefinition.extension:derivedFromUri, ObservationDefinition.extension:subject, ObservationDefinition.extension:performerType, ObservationDefinition.extension:bodySite, ObservationDefinition.extension:specimen, ObservationDefinition.extension:device, ObservationDefinition.extension:hasMember, ObservationDefinition.extension:component, ObservationDefinition.extension:qualifiedValue, ObservationDefinition.modifierExtension, ObservationDefinition.modifierExtension:status, ObservationDefinition.code | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ObservationDefinition.extension, ObservationDefinition.extension:url, ObservationDefinition.extension:version, ObservationDefinition.extension:versionAlgorithm, ObservationDefinition.extension:name, ObservationDefinition.extension:title, ObservationDefinition.extension:experimental, ObservationDefinition.extension:date, ObservationDefinition.extension:publisher, ObservationDefinition.extension:contact, ObservationDefinition.extension:description, ObservationDefinition.extension:useContext, ObservationDefinition.extension:jurisdiction, ObservationDefinition.extension:purpose, ObservationDefinition.extension:copyright, ObservationDefinition.extension:copyrightLabel, ObservationDefinition.extension:approvalDate, ObservationDefinition.extension:lastReviewDate, ObservationDefinition.extension:effectivePeriod, ObservationDefinition.extension:derivedFromCanonical, ObservationDefinition.extension:derivedFromUri, ObservationDefinition.extension:subject, ObservationDefinition.extension:performerType, ObservationDefinition.extension:bodySite, ObservationDefinition.extension:specimen, ObservationDefinition.extension:device, ObservationDefinition.extension:hasMember, ObservationDefinition.extension:component, ObservationDefinition.extension:qualifiedValue, ObservationDefinition.modifierExtension, ObservationDefinition.modifierExtension:status | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ObservationDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  ObservationDefinition |
0..* | ObservationDefinition(4.0.1) | Definition of an observation | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages  (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
   extension:url |
0..1 | uri | R5: Logical canonical URL to reference this ObservationDefinition (globally unique) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-url Constraints: ext-1 | |||||
| extension:version |
0..1 | string | R5: Business version of the ObservationDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-version Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:name |
0..1 | string | R5: Name for this ObservationDefinition (computer friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: Name for this ObservationDefinition (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |||||
| extension:experimental |
0..1 | boolean | R5: If for testing purposes, not real usage (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental Constraints: ext-1 | |||||
| extension:date |
0..1 | dateTime | R5: Date last changed (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-date Constraints: ext-1 | |||||
| extension:publisher |
0..1 | string | R5: The name of the individual or organization that published the ObservationDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | R5: Contact details for the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-contact Constraints: ext-1 | |||||
| extension:description |
0..1 | markdown | R5: Natural language description of the ObservationDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | R5: Content intends to support these contexts (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext Constraints: ext-1 | |||||
| extension:jurisdiction |
0..* | CodeableConcept | R5: Intended jurisdiction for this ObservationDefinition (if applicable) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.jurisdiction Constraints: ext-1 | |||||
| extension:purpose |
0..1 | markdown | R5: Why this ObservationDefinition is defined (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose Constraints: ext-1 | |||||
| extension:copyright |
0..1 | markdown | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| extension:approvalDate |
0..1 | date | R5: When ObservationDefinition was approved by publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate Constraints: ext-1 | |||||
| extension:lastReviewDate |
0..1 | date | R5: Date on which the asset content was last reviewed by the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate Constraints: ext-1 | |||||
| extension:effectivePeriod |
0..1 | Period | R5: The effective date range for the ObservationDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod Constraints: ext-1 | |||||
| extension:derivedFromCanonical |
0..* | canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) | R5: Based on FHIR definition of another observation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.derivedFromCanonical Constraints: ext-1 | |||||
| extension:derivedFromUri |
0..* | uri | R5: Based on external definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.derivedFromUri Constraints: ext-1 | |||||
| extension:subject |
0..* | CodeableConcept | R5: Type of subject for the defined observation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.subject Constraints: ext-1 | |||||
| extension:performerType |
0..1 | CodeableConcept | R5: Desired kind of performer for such kind of observation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.performerType Constraints: ext-1 | |||||
| extension:bodySite |
0..1 | CodeableConcept | R5: Body part to be observed (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.bodySite Constraints: ext-1 | |||||
| extension:specimen |
0..* | Reference(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4(0.1.0) | SpecimenDefinition) | R5: Kind of specimen used by this type of observation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.specimen Constraints: ext-1 | |||||
| extension:device |
0..* | Reference(Cross-version Profile for R5.DeviceDefinition for use in FHIR R4(0.1.0) | DeviceDefinition | Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device) | R5: Measurement device or model of device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.device Constraints: ext-1 | |||||
| extension:hasMember |
0..* | Reference(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition | Cross-version Profile for R5.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) | R5: Definitions of related resources belonging to this kind of observation group (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.hasMember Constraints: ext-1 | |||||
| extension:component |
0..* | (Complex) | R5: Component results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.component Constraints: ext-1 | |||||
 extension:qualifiedValue |
0..* | (Complex) | R5: Set of qualified values for observation results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue Constraints: ext-1 | |||||
 Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:status |
?! | 1..1 | code | R5: draft | active | retired | unknown (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. Constraints: ext-1 | ||||
| category |
Σ | 0..* | CodeableConcept | Category of observation Binding: ObservationCategoryCodes (example): Codes for high level observation categories. | ||||
| code |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier for this ObservationDefinition instance | ||||
| permittedDataType |
0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept | |||||
| multipleResultsAllowed |
0..1 | boolean | Multiple results allowed Example General: true | |||||
| method |
0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example): Methods for simple observations. | |||||
| preferredReportName |
0..1 | string | Preferred report name | |||||
| quantitativeDetails |
0..1 | BackboneElement | Characteristics of quantitative results | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| customaryUnit |
0..1 | CodeableConcept | Customary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | |||||
| unit |
0..1 | CodeableConcept | SI unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | |||||
| conversionFactor |
0..1 | decimal | SI to Customary unit conversion factor | |||||
 decimalPrecision |
0..1 | integer | Decimal precision of observation quantitative results | |||||
| qualifiedInterval |
0..* | BackboneElement | Qualified range for continuous and ordinal observation results | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| category |
0..1 | code | reference | critical | absolute Binding: ObservationRangeCategory (required): Codes identifying the category of observation range. Example General: critical | |||||
| range |
0..1 | Range | The interval itself, for continuous or ordinal observations | |||||
| context |
0..1 | CodeableConcept | Range context qualifier Binding: ObservationReferenceRangeMeaningCodes (extensible): Code identifying the health context of a range. | |||||
| appliesTo |
0..* | CodeableConcept | Targetted population of the range Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Example General: female | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| gestationalAge |
0..1 | Range | Applicable gestational age range, if relevant | |||||
| condition |
0..1 | string | Condition associated with the reference range | |||||
 validCodedValueSet |
0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:validCodedValueSet |
0..1 | canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | R5: Value set of valid coded values as part of this set of qualified values additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue.validCodedValueSet Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| normalCodedValueSet |
0..1 | Reference(ValueSet) | Value set of normal coded values for the observations conforming to this ObservationDefinition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:normalCodedValueSet |
0..1 | canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | R5: Value set of normal coded values as part of this set of qualified values additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue.normalCodedValueSet Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| abnormalCodedValueSet |
0..1 | Reference(ValueSet) | Value set of abnormal coded values for the observations conforming to this ObservationDefinition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:abnormalCodedValueSet |
0..1 | canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | R5: Value set of abnormal coded values as part of this set of qualified values additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue.abnormalCodedValueSet Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
 criticalCodedValueSet |
0..1 | Reference(ValueSet) | Value set of critical coded values for the observations conforming to this ObservationDefinition | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:criticalCodedValueSet |
0..1 | canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | R5: Value set of critical coded values as part of this set of qualified values additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue.criticalCodedValueSet Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| ObservationDefinition.category | Base | example | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.permittedDataType | Base | required | ObservationDataType | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.quantitativeDetails.customaryUnit | Base | extensible | UCUM Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.quantitativeDetails.unit | Base | extensible | UCUM Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.qualifiedInterval.category | Base | required | ObservationRangeCategory | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.qualifiedInterval.context | Base | extensible | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.qualifiedInterval.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.qualifiedInterval.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.validCodedValueSet.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| ObservationDefinition.normalCodedValueSet.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| ObservationDefinition.abnormalCodedValueSet.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| ObservationDefinition.criticalCodedValueSet.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ObservationDefinition | 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 | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ObservationDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ObservationDefinition.meta, ObservationDefinition.implicitRules, ObservationDefinition.language, ObservationDefinition.text, ObservationDefinition.extension, ObservationDefinition.extension:url, ObservationDefinition.extension:version, ObservationDefinition.extension:versionAlgorithm, ObservationDefinition.extension:name, ObservationDefinition.extension:title, ObservationDefinition.extension:experimental, ObservationDefinition.extension:date, ObservationDefinition.extension:publisher, ObservationDefinition.extension:contact, ObservationDefinition.extension:description, ObservationDefinition.extension:useContext, ObservationDefinition.extension:jurisdiction, ObservationDefinition.extension:purpose, ObservationDefinition.extension:copyright, ObservationDefinition.extension:copyrightLabel, ObservationDefinition.extension:approvalDate, ObservationDefinition.extension:lastReviewDate, ObservationDefinition.extension:effectivePeriod, ObservationDefinition.extension:derivedFromCanonical, ObservationDefinition.extension:derivedFromUri, ObservationDefinition.extension:subject, ObservationDefinition.extension:performerType, ObservationDefinition.extension:bodySite, ObservationDefinition.extension:specimen, ObservationDefinition.extension:device, ObservationDefinition.extension:hasMember, ObservationDefinition.extension:component, ObservationDefinition.extension:qualifiedValue, ObservationDefinition.modifierExtension, ObservationDefinition.modifierExtension:status, ObservationDefinition.category, ObservationDefinition.code, ObservationDefinition.identifier, ObservationDefinition.permittedDataType, ObservationDefinition.multipleResultsAllowed, ObservationDefinition.method, ObservationDefinition.preferredReportName, ObservationDefinition.quantitativeDetails, ObservationDefinition.quantitativeDetails.extension, ObservationDefinition.quantitativeDetails.modifierExtension, ObservationDefinition.quantitativeDetails.customaryUnit, ObservationDefinition.quantitativeDetails.unit, ObservationDefinition.quantitativeDetails.conversionFactor, ObservationDefinition.quantitativeDetails.decimalPrecision, ObservationDefinition.qualifiedInterval, ObservationDefinition.qualifiedInterval.extension, ObservationDefinition.qualifiedInterval.modifierExtension, ObservationDefinition.qualifiedInterval.category, ObservationDefinition.qualifiedInterval.range, ObservationDefinition.qualifiedInterval.context, ObservationDefinition.qualifiedInterval.appliesTo, ObservationDefinition.qualifiedInterval.gender, ObservationDefinition.qualifiedInterval.age, ObservationDefinition.qualifiedInterval.gestationalAge, ObservationDefinition.qualifiedInterval.condition, ObservationDefinition.validCodedValueSet, ObservationDefinition.validCodedValueSet.extension, ObservationDefinition.validCodedValueSet.extension:validCodedValueSet, ObservationDefinition.validCodedValueSet.reference, ObservationDefinition.validCodedValueSet.type, ObservationDefinition.validCodedValueSet.identifier, ObservationDefinition.validCodedValueSet.display, ObservationDefinition.normalCodedValueSet, ObservationDefinition.normalCodedValueSet.extension, ObservationDefinition.normalCodedValueSet.extension:normalCodedValueSet, ObservationDefinition.normalCodedValueSet.reference, ObservationDefinition.normalCodedValueSet.type, ObservationDefinition.normalCodedValueSet.identifier, ObservationDefinition.normalCodedValueSet.display, ObservationDefinition.abnormalCodedValueSet, ObservationDefinition.abnormalCodedValueSet.extension, ObservationDefinition.abnormalCodedValueSet.extension:abnormalCodedValueSet, ObservationDefinition.abnormalCodedValueSet.reference, ObservationDefinition.abnormalCodedValueSet.type, ObservationDefinition.abnormalCodedValueSet.identifier, ObservationDefinition.abnormalCodedValueSet.display, ObservationDefinition.criticalCodedValueSet, ObservationDefinition.criticalCodedValueSet.extension, ObservationDefinition.criticalCodedValueSet.extension:criticalCodedValueSet, ObservationDefinition.criticalCodedValueSet.reference, ObservationDefinition.criticalCodedValueSet.type, ObservationDefinition.criticalCodedValueSet.identifier, ObservationDefinition.criticalCodedValueSet.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ObservationDefinition.extension, ObservationDefinition.extension:url, ObservationDefinition.extension:version, ObservationDefinition.extension:versionAlgorithm, ObservationDefinition.extension:name, ObservationDefinition.extension:title, ObservationDefinition.extension:experimental, ObservationDefinition.extension:date, ObservationDefinition.extension:publisher, ObservationDefinition.extension:contact, ObservationDefinition.extension:description, ObservationDefinition.extension:useContext, ObservationDefinition.extension:jurisdiction, ObservationDefinition.extension:purpose, ObservationDefinition.extension:copyright, ObservationDefinition.extension:copyrightLabel, ObservationDefinition.extension:approvalDate, ObservationDefinition.extension:lastReviewDate, ObservationDefinition.extension:effectivePeriod, ObservationDefinition.extension:derivedFromCanonical, ObservationDefinition.extension:derivedFromUri, ObservationDefinition.extension:subject, ObservationDefinition.extension:performerType, ObservationDefinition.extension:bodySite, ObservationDefinition.extension:specimen, ObservationDefinition.extension:device, ObservationDefinition.extension:hasMember, ObservationDefinition.extension:component, ObservationDefinition.extension:qualifiedValue, ObservationDefinition.modifierExtension, ObservationDefinition.modifierExtension:status, ObservationDefinition.quantitativeDetails.extension, ObservationDefinition.quantitativeDetails.modifierExtension, ObservationDefinition.qualifiedInterval.extension, ObservationDefinition.qualifiedInterval.modifierExtension, ObservationDefinition.validCodedValueSet.extension, ObservationDefinition.validCodedValueSet.extension:validCodedValueSet, ObservationDefinition.normalCodedValueSet.extension, ObservationDefinition.normalCodedValueSet.extension:normalCodedValueSet, ObservationDefinition.abnormalCodedValueSet.extension, ObservationDefinition.abnormalCodedValueSet.extension:abnormalCodedValueSet, ObservationDefinition.criticalCodedValueSet.extension, ObservationDefinition.criticalCodedValueSet.extension:criticalCodedValueSet | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ObservationDefinition
Summary
Mandatory: 1 element
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ObservationDefinition | 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 | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ObservationDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ObservationDefinition.implicitRules, ObservationDefinition.extension, ObservationDefinition.extension:url, ObservationDefinition.extension:version, ObservationDefinition.extension:versionAlgorithm, ObservationDefinition.extension:name, ObservationDefinition.extension:title, ObservationDefinition.extension:experimental, ObservationDefinition.extension:date, ObservationDefinition.extension:publisher, ObservationDefinition.extension:contact, ObservationDefinition.extension:description, ObservationDefinition.extension:useContext, ObservationDefinition.extension:jurisdiction, ObservationDefinition.extension:purpose, ObservationDefinition.extension:copyright, ObservationDefinition.extension:copyrightLabel, ObservationDefinition.extension:approvalDate, ObservationDefinition.extension:lastReviewDate, ObservationDefinition.extension:effectivePeriod, ObservationDefinition.extension:derivedFromCanonical, ObservationDefinition.extension:derivedFromUri, ObservationDefinition.extension:subject, ObservationDefinition.extension:performerType, ObservationDefinition.extension:bodySite, ObservationDefinition.extension:specimen, ObservationDefinition.extension:device, ObservationDefinition.extension:hasMember, ObservationDefinition.extension:component, ObservationDefinition.extension:qualifiedValue, ObservationDefinition.modifierExtension, ObservationDefinition.modifierExtension:status, ObservationDefinition.code | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ObservationDefinition.extension, ObservationDefinition.extension:url, ObservationDefinition.extension:version, ObservationDefinition.extension:versionAlgorithm, ObservationDefinition.extension:name, ObservationDefinition.extension:title, ObservationDefinition.extension:experimental, ObservationDefinition.extension:date, ObservationDefinition.extension:publisher, ObservationDefinition.extension:contact, ObservationDefinition.extension:description, ObservationDefinition.extension:useContext, ObservationDefinition.extension:jurisdiction, ObservationDefinition.extension:purpose, ObservationDefinition.extension:copyright, ObservationDefinition.extension:copyrightLabel, ObservationDefinition.extension:approvalDate, ObservationDefinition.extension:lastReviewDate, ObservationDefinition.extension:effectivePeriod, ObservationDefinition.extension:derivedFromCanonical, ObservationDefinition.extension:derivedFromUri, ObservationDefinition.extension:subject, ObservationDefinition.extension:performerType, ObservationDefinition.extension:bodySite, ObservationDefinition.extension:specimen, ObservationDefinition.extension:device, ObservationDefinition.extension:hasMember, ObservationDefinition.extension:component, ObservationDefinition.extension:qualifiedValue, ObservationDefinition.modifierExtension, ObservationDefinition.modifierExtension:status | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ObservationDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ObservationDefinition |
0..* | ObservationDefinition(4.0.1) | Definition of an observation | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:url |
0..1 | uri | R5: Logical canonical URL to reference this ObservationDefinition (globally unique) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-url Constraints: ext-1 | |||||
| extension:version |
0..1 | string | R5: Business version of the ObservationDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-version Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:name |
0..1 | string | R5: Name for this ObservationDefinition (computer friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: Name for this ObservationDefinition (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |||||
| extension:experimental |
0..1 | boolean | R5: If for testing purposes, not real usage (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental Constraints: ext-1 | |||||
| extension:date |
0..1 | dateTime | R5: Date last changed (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-date Constraints: ext-1 | |||||
| extension:publisher |
0..1 | string | R5: The name of the individual or organization that published the ObservationDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | R5: Contact details for the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-contact Constraints: ext-1 | |||||
| extension:description |
0..1 | markdown | R5: Natural language description of the ObservationDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | R5: Content intends to support these contexts (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext Constraints: ext-1 | |||||
| extension:jurisdiction |
0..* | CodeableConcept | R5: Intended jurisdiction for this ObservationDefinition (if applicable) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.jurisdiction Constraints: ext-1 | |||||
| extension:purpose |
0..1 | markdown | R5: Why this ObservationDefinition is defined (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose Constraints: ext-1 | |||||
| extension:copyright |
0..1 | markdown | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| extension:approvalDate |
0..1 | date | R5: When ObservationDefinition was approved by publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate Constraints: ext-1 | |||||
| extension:lastReviewDate |
0..1 | date | R5: Date on which the asset content was last reviewed by the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate Constraints: ext-1 | |||||
| extension:effectivePeriod |
0..1 | Period | R5: The effective date range for the ObservationDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod Constraints: ext-1 | |||||
| extension:derivedFromCanonical |
0..* | canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) | R5: Based on FHIR definition of another observation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.derivedFromCanonical Constraints: ext-1 | |||||
| extension:derivedFromUri |
0..* | uri | R5: Based on external definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.derivedFromUri Constraints: ext-1 | |||||
| extension:subject |
0..* | CodeableConcept | R5: Type of subject for the defined observation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.subject Constraints: ext-1 | |||||
| extension:performerType |
0..1 | CodeableConcept | R5: Desired kind of performer for such kind of observation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.performerType Constraints: ext-1 | |||||
| extension:bodySite |
0..1 | CodeableConcept | R5: Body part to be observed (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.bodySite Constraints: ext-1 | |||||
| extension:specimen |
0..* | Reference(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4(0.1.0) | SpecimenDefinition) | R5: Kind of specimen used by this type of observation (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.specimen Constraints: ext-1 | |||||
| extension:device |
0..* | Reference(Cross-version Profile for R5.DeviceDefinition for use in FHIR R4(0.1.0) | DeviceDefinition | Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device) | R5: Measurement device or model of device (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.device Constraints: ext-1 | |||||
| extension:hasMember |
0..* | Reference(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition | Cross-version Profile for R5.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) | R5: Definitions of related resources belonging to this kind of observation group (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.hasMember Constraints: ext-1 | |||||
| extension:component |
0..* | (Complex) | R5: Component results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.component Constraints: ext-1 | |||||
| extension:qualifiedValue |
0..* | (Complex) | R5: Set of qualified values for observation results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:status |
?! | 1..1 | code | R5: draft | active | retired | unknown (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. Constraints: ext-1 | ||||
| category |
Σ | 0..* | CodeableConcept | Category of observation Binding: ObservationCategoryCodes (example): Codes for high level observation categories. | ||||
| code |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier for this ObservationDefinition instance | ||||
| permittedDataType |
0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept | |||||
| multipleResultsAllowed |
0..1 | boolean | Multiple results allowed Example General: true | |||||
| method |
0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example): Methods for simple observations. | |||||
| preferredReportName |
0..1 | string | Preferred report name | |||||
| quantitativeDetails |
0..1 | BackboneElement | Characteristics of quantitative results | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| customaryUnit |
0..1 | CodeableConcept | Customary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | |||||
| unit |
0..1 | CodeableConcept | SI unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | |||||
| conversionFactor |
0..1 | decimal | SI to Customary unit conversion factor | |||||
| decimalPrecision |
0..1 | integer | Decimal precision of observation quantitative results | |||||
| qualifiedInterval |
0..* | BackboneElement | Qualified range for continuous and ordinal observation results | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| category |
0..1 | code | reference | critical | absolute Binding: ObservationRangeCategory (required): Codes identifying the category of observation range. Example General: critical | |||||
| range |
0..1 | Range | The interval itself, for continuous or ordinal observations | |||||
| context |
0..1 | CodeableConcept | Range context qualifier Binding: ObservationReferenceRangeMeaningCodes (extensible): Code identifying the health context of a range. | |||||
| appliesTo |
0..* | CodeableConcept | Targetted population of the range Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Example General: female | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| gestationalAge |
0..1 | Range | Applicable gestational age range, if relevant | |||||
| condition |
0..1 | string | Condition associated with the reference range | |||||
| validCodedValueSet |
0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:validCodedValueSet |
0..1 | canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | R5: Value set of valid coded values as part of this set of qualified values additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue.validCodedValueSet Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| normalCodedValueSet |
0..1 | Reference(ValueSet) | Value set of normal coded values for the observations conforming to this ObservationDefinition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:normalCodedValueSet |
0..1 | canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | R5: Value set of normal coded values as part of this set of qualified values additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue.normalCodedValueSet Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| abnormalCodedValueSet |
0..1 | Reference(ValueSet) | Value set of abnormal coded values for the observations conforming to this ObservationDefinition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:abnormalCodedValueSet |
0..1 | canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | R5: Value set of abnormal coded values as part of this set of qualified values additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue.abnormalCodedValueSet Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| criticalCodedValueSet |
0..1 | Reference(ValueSet) | Value set of critical coded values for the observations conforming to this ObservationDefinition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:criticalCodedValueSet |
0..1 | canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | R5: Value set of critical coded values as part of this set of qualified values additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.qualifiedValue.criticalCodedValueSet Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ObservationDefinition.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| ObservationDefinition.category | Base | example | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.permittedDataType | Base | required | ObservationDataType | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.quantitativeDetails.customaryUnit | Base | extensible | UCUM Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.quantitativeDetails.unit | Base | extensible | UCUM Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.qualifiedInterval.category | Base | required | ObservationRangeCategory | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.qualifiedInterval.context | Base | extensible | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.qualifiedInterval.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.qualifiedInterval.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| ObservationDefinition.validCodedValueSet.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| ObservationDefinition.normalCodedValueSet.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| ObservationDefinition.abnormalCodedValueSet.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| ObservationDefinition.criticalCodedValueSet.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ObservationDefinition | 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 | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ObservationDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ObservationDefinition.meta, ObservationDefinition.implicitRules, ObservationDefinition.language, ObservationDefinition.text, ObservationDefinition.extension, ObservationDefinition.extension:url, ObservationDefinition.extension:version, ObservationDefinition.extension:versionAlgorithm, ObservationDefinition.extension:name, ObservationDefinition.extension:title, ObservationDefinition.extension:experimental, ObservationDefinition.extension:date, ObservationDefinition.extension:publisher, ObservationDefinition.extension:contact, ObservationDefinition.extension:description, ObservationDefinition.extension:useContext, ObservationDefinition.extension:jurisdiction, ObservationDefinition.extension:purpose, ObservationDefinition.extension:copyright, ObservationDefinition.extension:copyrightLabel, ObservationDefinition.extension:approvalDate, ObservationDefinition.extension:lastReviewDate, ObservationDefinition.extension:effectivePeriod, ObservationDefinition.extension:derivedFromCanonical, ObservationDefinition.extension:derivedFromUri, ObservationDefinition.extension:subject, ObservationDefinition.extension:performerType, ObservationDefinition.extension:bodySite, ObservationDefinition.extension:specimen, ObservationDefinition.extension:device, ObservationDefinition.extension:hasMember, ObservationDefinition.extension:component, ObservationDefinition.extension:qualifiedValue, ObservationDefinition.modifierExtension, ObservationDefinition.modifierExtension:status, ObservationDefinition.category, ObservationDefinition.code, ObservationDefinition.identifier, ObservationDefinition.permittedDataType, ObservationDefinition.multipleResultsAllowed, ObservationDefinition.method, ObservationDefinition.preferredReportName, ObservationDefinition.quantitativeDetails, ObservationDefinition.quantitativeDetails.extension, ObservationDefinition.quantitativeDetails.modifierExtension, ObservationDefinition.quantitativeDetails.customaryUnit, ObservationDefinition.quantitativeDetails.unit, ObservationDefinition.quantitativeDetails.conversionFactor, ObservationDefinition.quantitativeDetails.decimalPrecision, ObservationDefinition.qualifiedInterval, ObservationDefinition.qualifiedInterval.extension, ObservationDefinition.qualifiedInterval.modifierExtension, ObservationDefinition.qualifiedInterval.category, ObservationDefinition.qualifiedInterval.range, ObservationDefinition.qualifiedInterval.context, ObservationDefinition.qualifiedInterval.appliesTo, ObservationDefinition.qualifiedInterval.gender, ObservationDefinition.qualifiedInterval.age, ObservationDefinition.qualifiedInterval.gestationalAge, ObservationDefinition.qualifiedInterval.condition, ObservationDefinition.validCodedValueSet, ObservationDefinition.validCodedValueSet.extension, ObservationDefinition.validCodedValueSet.extension:validCodedValueSet, ObservationDefinition.validCodedValueSet.reference, ObservationDefinition.validCodedValueSet.type, ObservationDefinition.validCodedValueSet.identifier, ObservationDefinition.validCodedValueSet.display, ObservationDefinition.normalCodedValueSet, ObservationDefinition.normalCodedValueSet.extension, ObservationDefinition.normalCodedValueSet.extension:normalCodedValueSet, ObservationDefinition.normalCodedValueSet.reference, ObservationDefinition.normalCodedValueSet.type, ObservationDefinition.normalCodedValueSet.identifier, ObservationDefinition.normalCodedValueSet.display, ObservationDefinition.abnormalCodedValueSet, ObservationDefinition.abnormalCodedValueSet.extension, ObservationDefinition.abnormalCodedValueSet.extension:abnormalCodedValueSet, ObservationDefinition.abnormalCodedValueSet.reference, ObservationDefinition.abnormalCodedValueSet.type, ObservationDefinition.abnormalCodedValueSet.identifier, ObservationDefinition.abnormalCodedValueSet.display, ObservationDefinition.criticalCodedValueSet, ObservationDefinition.criticalCodedValueSet.extension, ObservationDefinition.criticalCodedValueSet.extension:criticalCodedValueSet, ObservationDefinition.criticalCodedValueSet.reference, ObservationDefinition.criticalCodedValueSet.type, ObservationDefinition.criticalCodedValueSet.identifier, ObservationDefinition.criticalCodedValueSet.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ObservationDefinition.extension, ObservationDefinition.extension:url, ObservationDefinition.extension:version, ObservationDefinition.extension:versionAlgorithm, ObservationDefinition.extension:name, ObservationDefinition.extension:title, ObservationDefinition.extension:experimental, ObservationDefinition.extension:date, ObservationDefinition.extension:publisher, ObservationDefinition.extension:contact, ObservationDefinition.extension:description, ObservationDefinition.extension:useContext, ObservationDefinition.extension:jurisdiction, ObservationDefinition.extension:purpose, ObservationDefinition.extension:copyright, ObservationDefinition.extension:copyrightLabel, ObservationDefinition.extension:approvalDate, ObservationDefinition.extension:lastReviewDate, ObservationDefinition.extension:effectivePeriod, ObservationDefinition.extension:derivedFromCanonical, ObservationDefinition.extension:derivedFromUri, ObservationDefinition.extension:subject, ObservationDefinition.extension:performerType, ObservationDefinition.extension:bodySite, ObservationDefinition.extension:specimen, ObservationDefinition.extension:device, ObservationDefinition.extension:hasMember, ObservationDefinition.extension:component, ObservationDefinition.extension:qualifiedValue, ObservationDefinition.modifierExtension, ObservationDefinition.modifierExtension:status, ObservationDefinition.quantitativeDetails.extension, ObservationDefinition.quantitativeDetails.modifierExtension, ObservationDefinition.qualifiedInterval.extension, ObservationDefinition.qualifiedInterval.modifierExtension, ObservationDefinition.validCodedValueSet.extension, ObservationDefinition.validCodedValueSet.extension:validCodedValueSet, ObservationDefinition.normalCodedValueSet.extension, ObservationDefinition.normalCodedValueSet.extension:normalCodedValueSet, ObservationDefinition.abnormalCodedValueSet.extension, ObservationDefinition.abnormalCodedValueSet.extension:abnormalCodedValueSet, ObservationDefinition.criticalCodedValueSet.extension, ObservationDefinition.criticalCodedValueSet.extension:criticalCodedValueSet | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ObservationDefinition
Summary
Mandatory: 1 element
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
