International Patient Access, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ipa/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation | Version: 1.1.0 | |||
Standards status: Trial-use | Computable Name: IPAObservation | |||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
Minimum expectations for an Observation resource when accessed via a International Patient Access API
The following data elements must always be present (in other words, mandatory resource properties where the minimum cardinality is 1) or must be supported (Must Support definition). Servers cannot restrict access to mandatory elements when authorizing an application. However, servers may choose to provide additional information or may be required to do so by national or other profiles that apply to the server's context.
Each Observation SHALL have:
Applications must also support:
Note that the base FHIR specification defines a profile on the Observation resource used to specifically represent vitals signs. To adhere to IPA as well as the base FHIR specifications, implementers SHALL support the FHIR Core Vitals Signs profile.
The IPA-Observation profile defined here SHALL be used to represent Observations other than vital signs such as:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions ipa-obs-1: If there is no component or hasMember element then either a value[x] or a data absent reason must be present | ||||||
status | SO | 1..1 | code | registered | preliminary | final | amended +
| ||||||
category | SO | 0..* | CodeableConcept | Classification of type of observation
| ||||||
code | SO | 1..1 | CodeableConcept | Type of observation (code / type)
| ||||||
subject | SO | 1..1 | Reference(IPA-Patient) | Who and/or what the observation is about
| ||||||
effective[x] | SO | 0..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation
| ||||||
value[x] | SOC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result
| ||||||
dataAbsentReason | SOC | 0..1 | CodeableConcept | Why the result is missing
| ||||||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ipa-obs-1 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason or value) |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present ipa-obs-1: If there is no component or hasMember element then either a value[x] or a data absent reason must be present | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
status | ?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| ||||||
category | SO | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||
code | SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||
subject | SOΣ | 1..1 | Reference(IPA-Patient) | Who and/or what the observation is about
| ||||||
effective[x] | SOΣ | 0..1 | Clinically relevant time/time-period for observation
| |||||||
effectiveDateTime | dateTime | |||||||||
effectivePeriod | Period | |||||||||
effectiveTiming | Timing | |||||||||
effectiveInstant | instant | |||||||||
value[x] | SOΣ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 | SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ipa-obs-1 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason or value) |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present ipa-obs-1: If there is no component or hasMember element then either a value[x] or a data absent reason must be present | ||||||
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 | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||||
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||||
status | ?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| ||||||
category | SO | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||
code | SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||
subject | SOΣ | 1..1 | Reference(IPA-Patient) | Who and/or what the observation is about
| ||||||
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||||
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||||
effective[x] | SOΣ | 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 | ||||||
value[x] | SOΣ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 | SOC | 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 | |||||||
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||||
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 | |||||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||||
high | C | 0..1 | SimpleQuantity | 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 | |||||||
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 | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
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 | Conformance | ValueSet | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ipa-obs-1 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason or value) |
This structure is derived from Observation
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions ipa-obs-1: If there is no component or hasMember element then either a value[x] or a data absent reason must be present | ||||||
status | SO | 1..1 | code | registered | preliminary | final | amended +
| ||||||
category | SO | 0..* | CodeableConcept | Classification of type of observation
| ||||||
code | SO | 1..1 | CodeableConcept | Type of observation (code / type)
| ||||||
subject | SO | 1..1 | Reference(IPA-Patient) | Who and/or what the observation is about
| ||||||
effective[x] | SO | 0..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation
| ||||||
value[x] | SOC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result
| ||||||
dataAbsentReason | SOC | 0..1 | CodeableConcept | Why the result is missing
| ||||||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ipa-obs-1 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason or value) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present ipa-obs-1: If there is no component or hasMember element then either a value[x] or a data absent reason must be present | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
status | ?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| ||||||
category | SO | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||
code | SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||
subject | SOΣ | 1..1 | Reference(IPA-Patient) | Who and/or what the observation is about
| ||||||
effective[x] | SOΣ | 0..1 | Clinically relevant time/time-period for observation
| |||||||
effectiveDateTime | dateTime | |||||||||
effectivePeriod | Period | |||||||||
effectiveTiming | Timing | |||||||||
effectiveInstant | instant | |||||||||
value[x] | SOΣ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 | SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ipa-obs-1 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason or value) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present ipa-obs-1: If there is no component or hasMember element then either a value[x] or a data absent reason must be present | ||||||
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 | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||||
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||||
status | ?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| ||||||
category | SO | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||
code | SOΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| ||||||
subject | SOΣ | 1..1 | Reference(IPA-Patient) | Who and/or what the observation is about
| ||||||
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||||
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||||
effective[x] | SOΣ | 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 | ||||||
value[x] | SOΣ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 | SOC | 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 | |||||||
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||||
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 | |||||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||||
high | C | 0..1 | SimpleQuantity | 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 | |||||||
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 | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
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 | Conformance | ValueSet | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ipa-obs-1 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason or value) |
This structure is derived from Observation
Other representations of profile: CSV, Excel, Schematron