The official URL for this profile is:
http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Observation
A statement that asserts the value of a property (observable) of the subject. The subject is often the patient, but may be a condition, a physical structure, or another clinical statement. For example, an interpretation is a finding about an observation.
This profile builds on Observation.
This profile was published on Fri Aug 17 00:00:00 EDT 2018 as a draft by HL7 Patient Care and Clinical Information Modeling Initiative Work Groups.
View the corresponding ObservationModel logical model.
Summary
Mandatory: 0 element (2 nested mandatory elements)
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
SW Mapping Source
This structure represents the following SW mapping definition:
shr.base.Observation maps to Observation: constrain component to 0..0 constrain related to 0..0 constrain bodySite to 0..0 ObservableCode maps to code ResultValue maps to value[x] RelevantTime maps to effective[x] FindingStatus maps to status
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | SW Observation Profile | |||
extension | 1..* | |||
shr-base-FindingMethod-extension | 0..1 | CodeableConcept | SW FindingMethod Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-FindingMethod-extension | |
shr-base-Subject-extension | 1..1 | Reference(DomainResource) | SW Subject Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Subject-extension | |
shr-base-Qualifier-extension | 0..* | CodeableConcept | SW Qualifier Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Qualifier-extension | |
value[x] | Quantity, CodeableConcept, string, boolean, Range, RatioProfile, Attachment, time, dateTime, Period | |||
bodySite | 0..0 | |||
related | 0..0 | |||
component | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | SW Observation Profile obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not 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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 1..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
shr-base-FindingMethod-extension | 0..1 | CodeableConcept | SW FindingMethod Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-FindingMethod-extension | |
shr-base-Subject-extension | 1..1 | Reference(DomainResource) | SW Subject Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Subject-extension | |
shr-base-Qualifier-extension | 0..* | CodeableConcept | SW Qualifier Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Qualifier-extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business Identifier for observation |
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | Fulfills plan, proposal or order |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (preferred) | |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what this is about |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Healthcare event during which this observation is made | |
effective[x] | Σ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this was made available |
performer | Σ | 0..* | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | ΣI | 0..1 | Quantity, CodeableConcept, string, boolean, Range, RatioProfile, Attachment, time, dateTime, Period | Actual result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
comment | 0..1 | string | Comments about result | |
method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
type | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
appliesTo | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
Documentation for this format |
Summary
Mandatory: 0 element (2 nested mandatory elements)
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
SW Mapping Source
This structure represents the following SW mapping definition:
shr.base.Observation maps to Observation: constrain component to 0..0 constrain related to 0..0 constrain bodySite to 0..0 ObservableCode maps to code ResultValue maps to value[x] RelevantTime maps to effective[x] FindingStatus maps to status
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | SW Observation Profile | |||
extension | 1..* | |||
shr-base-FindingMethod-extension | 0..1 | CodeableConcept | SW FindingMethod Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-FindingMethod-extension | |
shr-base-Subject-extension | 1..1 | Reference(DomainResource) | SW Subject Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Subject-extension | |
shr-base-Qualifier-extension | 0..* | CodeableConcept | SW Qualifier Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Qualifier-extension | |
value[x] | Quantity, CodeableConcept, string, boolean, Range, RatioProfile, Attachment, time, dateTime, Period | |||
bodySite | 0..0 | |||
related | 0..0 | |||
component | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | SW Observation Profile obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not 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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 1..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
shr-base-FindingMethod-extension | 0..1 | CodeableConcept | SW FindingMethod Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-FindingMethod-extension | |
shr-base-Subject-extension | 1..1 | Reference(DomainResource) | SW Subject Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Subject-extension | |
shr-base-Qualifier-extension | 0..* | CodeableConcept | SW Qualifier Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Qualifier-extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business Identifier for observation |
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | Fulfills plan, proposal or order |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (preferred) | |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what this is about |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Healthcare event during which this observation is made | |
effective[x] | Σ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this was made available |
performer | Σ | 0..* | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | ΣI | 0..1 | Quantity, CodeableConcept, string, boolean, Range, RatioProfile, Attachment, time, dateTime, Period | Actual result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
comment | 0..1 | string | Comments about result | |
method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
type | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
appliesTo | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Name | Conformance | ValueSet |
Observation.language | Common Languages | extensible | Common Languages |
Observation.status | ObservationStatus | required | ObservationStatus |
Observation.category | Observation Category Codes | preferred | Observation Category Codes |
Observation.code | LOINC Codes | example | LOINC Codes |
Observation.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
Observation.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
Observation.method | Observation Methods | example | Observation Methods |
Observation.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
Observation.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
Observation.related.type | ObservationRelationshipType | required | ObservationRelationshipType |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
Observation.component.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
Id | Path | Details | Requirements |
dom-2 | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Observation | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | 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-3 | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
obs-7 | Observation | If code is the same as a component code then the value element associated with the code SHALL NOT be present : value.empty() or code!=component.code | |
obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
ele-1 | Observation.referenceRange | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
obs-3 | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |