Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-Observation | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R2_Observation_R4B | ||
This cross-version profile allows DSTU2 Observation content to be represented via FHIR R4B Observation resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Observation |
C | 0..* | Observation(4.3.0) | Measurements and simple assertions Constraints: obs-6, obs-7 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:value |
0..1 | Range, Ratio, SampledData, Attachment, Period | DSTU2: value additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.value Constraints: ext-1 | |
| extension:type |
0..1 | code | DSTU2: has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.related.type Binding: R2ObservationRelationshiptypesForR4B (0.1.0) (required): Codes specifying how two observations are related. Constraints: ext-1 | |
 extension:target |
1..1 | Reference(Resource) | DSTU2: Resource that is related to this one additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
 extension:status |
0..1 | code | DSTU2: status additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.status Binding: R2ObservationStatusForR4B (0.1.0) (required): Codes providing the status of an observation. Constraints: ext-1 | |
  code |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.3.0 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Observation.implicitRules, Observation.extension, Observation.extension:value, Observation.extension:type, Observation.extension:target, Observation.modifierExtension, Observation.status, Observation.status.extension, Observation.status.extension:status, Observation.code | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Observation.extension, Observation.extension:value, Observation.extension:type, Observation.extension:target, Observation.modifierExtension, Observation.status.extension, Observation.status.extension:status | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation(4.3.0) | Measurements and simple assertions Constraints: obs-6, obs-7 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:value |
0..1 | Range, Ratio, SampledData, Attachment, Period | DSTU2: value additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.value Constraints: ext-1 | |||||
| extension:type |
0..1 | code | DSTU2: has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.related.type Binding: R2ObservationRelationshiptypesForR4B (0.1.0) (required): Codes specifying how two observations are related. Constraints: ext-1 | |||||
| extension:target |
1..1 | Reference(Resource) | DSTU2: Resource that is related to this one additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | DSTU2: Unique Id for this particular observation additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | DSTU2: status additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.status Binding: R2ObservationStatusForR4B (0.1.0) (required): Codes providing the status of an observation. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| category |
0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| subject |
Σ | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance) | Who and/or what the observation is about | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | DSTU2: Who and/or what this is about URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:encounter |
0..1 | Reference(Resource) | DSTU2: encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
 effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| effectiveTiming |
Timing | |||||||
| effectiveInstant |
instant | |||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:performer |
0..1 | Reference(Resource) | DSTU2: performer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| value[x] |
ΣC | 0..1 | Actual result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:comments |
0..1 | string | DSTU2: Comments about result additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.comments Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:specimen |
0..1 | Reference(Resource) | DSTU2: specimen additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:device |
0..1 | Reference(Resource) | DSTU2: device additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| low |
C | 0..1 | SimpleQuantity(4.3.0) | Low Range, if relevant | ||||
| high |
C | 0..1 | SimpleQuantity(4.3.0) | High Range, if relevant | ||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:age |
0..1 | Range | DSTU2: age additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.referenceRange.age Constraints: ext-1 | |||||
| low |
Σ | 0..1 | SimpleQuantity(4.3.0) | Low limit | ||||
| high |
Σ | 0..1 | SimpleQuantity(4.3.0) | High limit | ||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||
| 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:value |
0..1 | Range, Ratio, SampledData, Attachment, Period | DSTU2: value additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.component.value Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] |
Σ | 0..1 | Actual component result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
 referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Observation.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Observation.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Observation.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Observation.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.3.0 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.3.0 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.3.0 | FHIR Std. |
| Observation.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.performer.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.3.0 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.3.0 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.3.0 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍4.3.0 | FHIR Std. |
| Observation.specimen.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.device.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.3.0 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.3.0 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.3.0 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.3.0 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Observation.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Observation.meta, Observation.meta.extension, Observation.meta.extension:meta, Observation.meta.versionId, Observation.meta.lastUpdated, Observation.meta.source, Observation.meta.profile, Observation.meta.security, Observation.meta.tag, Observation.implicitRules, Observation.language, Observation.text, Observation.text.extension, Observation.text.extension:text, Observation.text.status, Observation.text.div, Observation.extension, Observation.extension:value, Observation.extension:type, Observation.extension:target, Observation.modifierExtension, Observation.identifier, Observation.identifier.extension, Observation.identifier.extension:identifier, Observation.identifier.use, Observation.identifier.type, Observation.identifier.system, Observation.identifier.value, Observation.identifier.period, Observation.identifier.assigner, Observation.basedOn, Observation.partOf, Observation.status, Observation.status.extension, Observation.status.extension:status, Observation.category, Observation.code, Observation.subject, Observation.subject.extension, Observation.subject.extension:subject, Observation.subject.reference, Observation.subject.type, Observation.subject.identifier, Observation.subject.display, Observation.focus, Observation.encounter, Observation.encounter.extension, Observation.encounter.extension:encounter, Observation.encounter.reference, Observation.encounter.type, Observation.encounter.identifier, Observation.encounter.display, Observation.effective[x], Observation.issued, Observation.performer, Observation.performer.extension, Observation.performer.extension:performer, Observation.performer.reference, Observation.performer.type, Observation.performer.identifier, Observation.performer.display, Observation.value[x], Observation.dataAbsentReason, Observation.interpretation, Observation.note, Observation.note.extension, Observation.note.extension:comments, Observation.note.author[x], Observation.note.time, Observation.note.text, Observation.bodySite, Observation.method, Observation.specimen, Observation.specimen.extension, Observation.specimen.extension:specimen, Observation.specimen.reference, Observation.specimen.type, Observation.specimen.identifier, Observation.specimen.display, Observation.device, Observation.device.extension, Observation.device.extension:device, Observation.device.reference, Observation.device.type, Observation.device.identifier, Observation.device.display, Observation.referenceRange, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.type, Observation.referenceRange.appliesTo, Observation.referenceRange.age, Observation.referenceRange.age.extension, Observation.referenceRange.age.extension:age, Observation.referenceRange.age.low, Observation.referenceRange.age.high, Observation.referenceRange.text, Observation.hasMember, Observation.derivedFrom, Observation.component, Observation.component.extension, Observation.component.extension:value, Observation.component.modifierExtension, Observation.component.code, Observation.component.value[x], Observation.component.dataAbsentReason, Observation.component.interpretation, Observation.component.referenceRange | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Observation.meta.extension, Observation.meta.extension:meta, Observation.text.extension, Observation.text.extension:text, Observation.extension, Observation.extension:value, Observation.extension:type, Observation.extension:target, Observation.modifierExtension, Observation.identifier.extension, Observation.identifier.extension:identifier, Observation.status.extension, Observation.status.extension:status, Observation.subject.extension, Observation.subject.extension:subject, Observation.encounter.extension, Observation.encounter.extension:encounter, Observation.performer.extension, Observation.performer.extension:performer, Observation.note.extension, Observation.note.extension:comments, Observation.specimen.extension, Observation.specimen.extension:specimen, Observation.device.extension, Observation.device.extension:device, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.age.extension, Observation.referenceRange.age.extension:age, Observation.component.extension, Observation.component.extension:value, Observation.component.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| txt-1 | error | Observation.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Observation.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Observation
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation(4.3.0) | Measurements and simple assertions Constraints: obs-6, obs-7 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:value |
0..1 | Range, Ratio, SampledData, Attachment, Period | DSTU2: value additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.value Constraints: ext-1 | |
| extension:type |
0..1 | code | DSTU2: has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.related.type Binding: R2ObservationRelationshiptypesForR4B (0.1.0) (required): Codes specifying how two observations are related. Constraints: ext-1 | |
| extension:target |
1..1 | Reference(Resource) | DSTU2: Resource that is related to this one additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:status |
0..1 | code | DSTU2: status additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.status Binding: R2ObservationStatusForR4B (0.1.0) (required): Codes providing the status of an observation. Constraints: ext-1 | |
| code |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.3.0 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Observation.implicitRules, Observation.extension, Observation.extension:value, Observation.extension:type, Observation.extension:target, Observation.modifierExtension, Observation.status, Observation.status.extension, Observation.status.extension:status, Observation.code | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Observation.extension, Observation.extension:value, Observation.extension:type, Observation.extension:target, Observation.modifierExtension, Observation.status.extension, Observation.status.extension:status | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
Differential View
This structure is derived from Observation
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation(4.3.0) | Measurements and simple assertions Constraints: obs-6, obs-7 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:value |
0..1 | Range, Ratio, SampledData, Attachment, Period | DSTU2: value additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.value Constraints: ext-1 | |||||
| extension:type |
0..1 | code | DSTU2: has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.related.type Binding: R2ObservationRelationshiptypesForR4B (0.1.0) (required): Codes specifying how two observations are related. Constraints: ext-1 | |||||
| extension:target |
1..1 | Reference(Resource) | DSTU2: Resource that is related to this one additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | DSTU2: Unique Id for this particular observation additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | DSTU2: status additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.status Binding: R2ObservationStatusForR4B (0.1.0) (required): Codes providing the status of an observation. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| category |
0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| subject |
Σ | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance) | Who and/or what the observation is about | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | DSTU2: Who and/or what this is about URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:encounter |
0..1 | Reference(Resource) | DSTU2: encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| effectiveTiming |
Timing | |||||||
| effectiveInstant |
instant | |||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:performer |
0..1 | Reference(Resource) | DSTU2: performer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| value[x] |
ΣC | 0..1 | Actual result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:comments |
0..1 | string | DSTU2: Comments about result additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.comments Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:specimen |
0..1 | Reference(Resource) | DSTU2: specimen additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:device |
0..1 | Reference(Resource) | DSTU2: device additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference 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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| low |
C | 0..1 | SimpleQuantity(4.3.0) | Low Range, if relevant | ||||
| high |
C | 0..1 | SimpleQuantity(4.3.0) | High Range, if relevant | ||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:age |
0..1 | Range | DSTU2: age additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.referenceRange.age Constraints: ext-1 | |||||
| low |
Σ | 0..1 | SimpleQuantity(4.3.0) | Low limit | ||||
| high |
Σ | 0..1 | SimpleQuantity(4.3.0) | High limit | ||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||
| 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:value |
0..1 | Range, Ratio, SampledData, Attachment, Period | DSTU2: value additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Observation.component.value Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] |
Σ | 0..1 | Actual component result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Observation.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Observation.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Observation.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Observation.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.3.0 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.3.0 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.3.0 | FHIR Std. |
| Observation.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.performer.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.3.0 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.3.0 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.3.0 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍4.3.0 | FHIR Std. |
| Observation.specimen.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.device.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.3.0 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.3.0 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.3.0 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.3.0 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Observation.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Observation.meta, Observation.meta.extension, Observation.meta.extension:meta, Observation.meta.versionId, Observation.meta.lastUpdated, Observation.meta.source, Observation.meta.profile, Observation.meta.security, Observation.meta.tag, Observation.implicitRules, Observation.language, Observation.text, Observation.text.extension, Observation.text.extension:text, Observation.text.status, Observation.text.div, Observation.extension, Observation.extension:value, Observation.extension:type, Observation.extension:target, Observation.modifierExtension, Observation.identifier, Observation.identifier.extension, Observation.identifier.extension:identifier, Observation.identifier.use, Observation.identifier.type, Observation.identifier.system, Observation.identifier.value, Observation.identifier.period, Observation.identifier.assigner, Observation.basedOn, Observation.partOf, Observation.status, Observation.status.extension, Observation.status.extension:status, Observation.category, Observation.code, Observation.subject, Observation.subject.extension, Observation.subject.extension:subject, Observation.subject.reference, Observation.subject.type, Observation.subject.identifier, Observation.subject.display, Observation.focus, Observation.encounter, Observation.encounter.extension, Observation.encounter.extension:encounter, Observation.encounter.reference, Observation.encounter.type, Observation.encounter.identifier, Observation.encounter.display, Observation.effective[x], Observation.issued, Observation.performer, Observation.performer.extension, Observation.performer.extension:performer, Observation.performer.reference, Observation.performer.type, Observation.performer.identifier, Observation.performer.display, Observation.value[x], Observation.dataAbsentReason, Observation.interpretation, Observation.note, Observation.note.extension, Observation.note.extension:comments, Observation.note.author[x], Observation.note.time, Observation.note.text, Observation.bodySite, Observation.method, Observation.specimen, Observation.specimen.extension, Observation.specimen.extension:specimen, Observation.specimen.reference, Observation.specimen.type, Observation.specimen.identifier, Observation.specimen.display, Observation.device, Observation.device.extension, Observation.device.extension:device, Observation.device.reference, Observation.device.type, Observation.device.identifier, Observation.device.display, Observation.referenceRange, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.type, Observation.referenceRange.appliesTo, Observation.referenceRange.age, Observation.referenceRange.age.extension, Observation.referenceRange.age.extension:age, Observation.referenceRange.age.low, Observation.referenceRange.age.high, Observation.referenceRange.text, Observation.hasMember, Observation.derivedFrom, Observation.component, Observation.component.extension, Observation.component.extension:value, Observation.component.modifierExtension, Observation.component.code, Observation.component.value[x], Observation.component.dataAbsentReason, Observation.component.interpretation, Observation.component.referenceRange | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Observation.meta.extension, Observation.meta.extension:meta, Observation.text.extension, Observation.text.extension:text, Observation.extension, Observation.extension:value, Observation.extension:type, Observation.extension:target, Observation.modifierExtension, Observation.identifier.extension, Observation.identifier.extension:identifier, Observation.status.extension, Observation.status.extension:status, Observation.subject.extension, Observation.subject.extension:subject, Observation.encounter.extension, Observation.encounter.extension:encounter, Observation.performer.extension, Observation.performer.extension:performer, Observation.note.extension, Observation.note.extension:comments, Observation.specimen.extension, Observation.specimen.extension:specimen, Observation.device.extension, Observation.device.extension:device, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.age.extension, Observation.referenceRange.age.extension:age, Observation.component.extension, Observation.component.extension:value, Observation.component.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| txt-1 | error | Observation.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Observation.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Observation
Summary
Mandatory: 2 elements
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-r2.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change