Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 Ballot United States of America flag

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: RR Reportability Information Observation

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-reportability-information-observation Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: RRReportabilityInformationObservation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.24

This profile represents reportability information based on the PHA in which is located the patient's home, the provider facility, or both locations.

This profile contains the Responsible Agency, the Rules Authoring Agency, and the Routing Entity.

Also contained in this profile are the Determination of Reportability, Reporting Timeframe, and External Resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Reportability Information Observation
Constraints: obs-6, obs-7
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:determinationOfReportability This element must be supported. 1..1 CodeableConcept US Public Health Determination of Reportability Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension
Binding: Determination of Reportability (eCR) (extensible): Determination of Reportability
Observation.Slices for extension.extension:determinationOfReportabilityReason This element must be supported. 0..* string, CodeableConcept US Public Health Determination of Reportability Reason
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-reason-extension
Observation.Slices for extension.extension:determinationOfReportabilityRule This element must be supported. 0..* string US Public Health Determination of Reportability Rule Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-rule-extension
Observation.Slices for extension.extension:externalResourceExtension This element must be supported. 0..* Reference(RR DocumentReference) External resources pertaining to the condition
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-extension
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Location Relevance
Binding: Location Relevance (eCR) (required): Location Relevance
Observation.Slices for performer This element must be supported. This element is included in summaries. 2..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for performer.performer:rulesAuthoringAgency This element must be supported. This element is included in summaries. 1..* Reference(RRRules Authoring Agency Organization) Who is responsible for the observation
Observation.Slices for performer.performer:routingEntity This element must be supported. This element is included in summaries. 1..* Reference(RRRouting Entity Organization) Who is responsible for the observation
Observation.Slices for performer.performer:responsibleAgency This element must be supported. This element is included in summaries. 0..* Reference(RR Responsible Agency Organization) Who is responsible for the observation
Observation.Slices for component This element must be supported. This element is included in summaries. 1..* BackboneElement Reporting timeframe
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for component.component:All Slices Content/Rules for all slices
Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.Slices for component.component:All Slices.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.Slices for component.component:sliceReportingTimeframe This element must be supported. This element is included in summaries. 0..* BackboneElement Component results
Observation.Slices for component.component:sliceReportingTimeframe.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.Slices for component.component:sliceReportingTimeframe.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Timeframe to report (urgency)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR4"
    }
  ]
}
Observation.Slices for component.component:sliceReportingTimeframe.value[x] This element must be supported. This element is included in summaries. 1..1 Quantity Actual component result
Observation.Slices for component.component:sliceReportingTimeframe.value[x].value This element must be supported. This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
Observation.Slices for component.component:sliceReportingTimeframe.value[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Observation.Slices for component.component:sliceReportingTimeframe.value[x].unit This element must be supported. This element is included in summaries. 1..1 string Unit representation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.code Base required Location Relevance (eCR) 📦1 us.cdc.phinvads v0.12
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error 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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* Observation Reportability Information Observation
Observation.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:determinationOfReportability This element must be supported. 1..1 CodeableConcept US Public Health Determination of Reportability Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension
Binding: Determination of Reportability (eCR) (extensible): Determination of Reportability
Observation.Slices for extension.extension:determinationOfReportabilityReason This element must be supported. 0..* string, CodeableConcept US Public Health Determination of Reportability Reason
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-reason-extension
Observation.Slices for extension.extension:determinationOfReportabilityRule This element must be supported. 0..* string US Public Health Determination of Reportability Rule Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-rule-extension
Observation.Slices for extension.extension:externalResourceExtension This element must be supported. 0..* Reference(RR DocumentReference) External resources pertaining to the condition
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-extension
Observation.status This element must be supported. 1..1 code registered | preliminary | final | amended +
Observation.code This element must be supported. 1..1 CodeableConcept Location Relevance
Binding: Location Relevance (eCR) (required): Location Relevance
Observation.Slices for performer.performer:rulesAuthoringAgency This element must be supported. 1..* Reference(RRRules Authoring Agency Organization) Who is responsible for the observation
Observation.Slices for performer.performer:routingEntity This element must be supported. 1..* Reference(RRRouting Entity Organization) Who is responsible for the observation
Observation.Slices for performer.performer:responsibleAgency This element must be supported. 0..* Reference(RR Responsible Agency Organization) Who is responsible for the observation
Observation.Slices for component This element must be supported. 1..* BackboneElement Reporting timeframe
Slice: Unordered, Open by value:code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for component.component:sliceReportingTimeframe This element must be supported. 0..* BackboneElement Component results
Observation.Slices for component.component:sliceReportingTimeframe.code This element must be supported. 1..1 CodeableConcept Timeframe to report (urgency)
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR4"
    }
  ]
}
Observation.Slices for component.component:sliceReportingTimeframe.value[x] This element must be supported. 1..1 Quantity Actual component result
Observation.Slices for component.component:sliceReportingTimeframe.value[x].value This element must be supported. 1..1 decimal Numerical value (with implicit precision)
Observation.Slices for component.component:sliceReportingTimeframe.value[x].unit This element must be supported. 1..1 string Unit representation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base required Location Relevance (eCR) 📦1 us.cdc.phinvads v0.12
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Reportability Information Observation
Constraints: obs-6, obs-7
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.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
Observation.contained 0..* Resource Contained, inline Resources
Observation.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:determinationOfReportability This element must be supported. 1..1 CodeableConcept US Public Health Determination of Reportability Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension
Binding: Determination of Reportability (eCR) (extensible): Determination of Reportability
Observation.Slices for extension.extension:determinationOfReportabilityReason This element must be supported. 0..* string, CodeableConcept US Public Health Determination of Reportability Reason
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-reason-extension
Observation.Slices for extension.extension:determinationOfReportabilityRule This element must be supported. 0..* string US Public Health Determination of Reportability Rule Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-rule-extension
Observation.Slices for extension.extension:externalResourceExtension This element must be supported. 0..* Reference(RR DocumentReference) External resources pertaining to the condition
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-extension
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Location Relevance
Binding: Location Relevance (eCR) (required): Location Relevance
Observation.subject This element is included in summaries. 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.effective[x] This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
Observation.effective[x].effectiveDateTime dateTime
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.Slices for performer This element must be supported. This element is included in summaries. 2..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for performer.performer:rulesAuthoringAgency This element must be supported. This element is included in summaries. 1..* Reference(RRRules Authoring Agency Organization) Who is responsible for the observation
Observation.Slices for performer.performer:routingEntity This element must be supported. This element is included in summaries. 1..* Reference(RRRouting Entity Organization) Who is responsible for the observation
Observation.Slices for performer.performer:responsibleAgency This element must be supported. This element is included in summaries. 0..* Reference(RR Responsible Agency Organization) Who is responsible for the observation
Observation.value[x] This element is included in summaries. C 0..1 Actual result
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueCodeableConcept CodeableConcept
Observation.value[x].valueString string
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Observation.Slices for component This element must be supported. This element is included in summaries. 1..* BackboneElement Reporting timeframe
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for component.component:All Slices Content/Rules for all slices
Observation.Slices for component.component:All Slices.id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:All Slices.extension 0..* Extension Additional content defined by implementations
Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.Slices for component.component:All Slices.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.Slices for component.component:All Slices.value[x] This element is included in summaries. 0..1 Actual component result
Observation.Slices for component.component:All Slices.value[x].valueQuantity Quantity
Observation.Slices for component.component:All Slices.value[x].valueCodeableConcept CodeableConcept
Observation.Slices for component.component:All Slices.value[x].valueString string
Observation.Slices for component.component:All Slices.value[x].valueBoolean boolean
Observation.Slices for component.component:All Slices.value[x].valueInteger integer
Observation.Slices for component.component:All Slices.value[x].valueRange Range
Observation.Slices for component.component:All Slices.value[x].valueRatio Ratio
Observation.Slices for component.component:All Slices.value[x].valueSampledData SampledData
Observation.Slices for component.component:All Slices.value[x].valueTime time
Observation.Slices for component.component:All Slices.value[x].valueDateTime dateTime
Observation.Slices for component.component:All Slices.value[x].valuePeriod Period
Observation.Slices for component.component:All Slices.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.Slices for component.component:All Slices.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.Slices for component.component:All Slices.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
Observation.Slices for component.component:sliceReportingTimeframe This element must be supported. This element is included in summaries. 0..* BackboneElement Component results
Observation.Slices for component.component:sliceReportingTimeframe.id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:sliceReportingTimeframe.extension 0..* Extension Additional content defined by implementations
Observation.Slices for component.component:sliceReportingTimeframe.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.Slices for component.component:sliceReportingTimeframe.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Timeframe to report (urgency)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR4"
    }
  ]
}
Observation.Slices for component.component:sliceReportingTimeframe.value[x] This element must be supported. This element is included in summaries. 1..1 Quantity Actual component result
Observation.Slices for component.component:sliceReportingTimeframe.value[x].id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:sliceReportingTimeframe.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.Slices for component.component:sliceReportingTimeframe.value[x].value This element must be supported. This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
Observation.Slices for component.component:sliceReportingTimeframe.value[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Observation.Slices for component.component:sliceReportingTimeframe.value[x].unit This element must be supported. This element is included in summaries. 1..1 string Unit representation
Observation.Slices for component.component:sliceReportingTimeframe.value[x].system This element is included in summaries. C 0..1 uri System that defines coded unit form
Observation.Slices for component.component:sliceReportingTimeframe.value[x].code This element is included in summaries. 0..1 code Coded form of the unit
Observation.Slices for component.component:sliceReportingTimeframe.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.Slices for component.component:sliceReportingTimeframe.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.Slices for component.component:sliceReportingTimeframe.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base required Location Relevance (eCR) 📦1 us.cdc.phinvads v0.12
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error 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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Reportability Information Observation
Constraints: obs-6, obs-7
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:determinationOfReportability This element must be supported. 1..1 CodeableConcept US Public Health Determination of Reportability Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension
Binding: Determination of Reportability (eCR) (extensible): Determination of Reportability
Observation.Slices for extension.extension:determinationOfReportabilityReason This element must be supported. 0..* string, CodeableConcept US Public Health Determination of Reportability Reason
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-reason-extension
Observation.Slices for extension.extension:determinationOfReportabilityRule This element must be supported. 0..* string US Public Health Determination of Reportability Rule Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-rule-extension
Observation.Slices for extension.extension:externalResourceExtension This element must be supported. 0..* Reference(RR DocumentReference) External resources pertaining to the condition
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-extension
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Location Relevance
Binding: Location Relevance (eCR) (required): Location Relevance
Observation.Slices for performer This element must be supported. This element is included in summaries. 2..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for performer.performer:rulesAuthoringAgency This element must be supported. This element is included in summaries. 1..* Reference(RRRules Authoring Agency Organization) Who is responsible for the observation
Observation.Slices for performer.performer:routingEntity This element must be supported. This element is included in summaries. 1..* Reference(RRRouting Entity Organization) Who is responsible for the observation
Observation.Slices for performer.performer:responsibleAgency This element must be supported. This element is included in summaries. 0..* Reference(RR Responsible Agency Organization) Who is responsible for the observation
Observation.Slices for component This element must be supported. This element is included in summaries. 1..* BackboneElement Reporting timeframe
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for component.component:All Slices Content/Rules for all slices
Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.Slices for component.component:All Slices.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.Slices for component.component:sliceReportingTimeframe This element must be supported. This element is included in summaries. 0..* BackboneElement Component results
Observation.Slices for component.component:sliceReportingTimeframe.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.Slices for component.component:sliceReportingTimeframe.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Timeframe to report (urgency)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR4"
    }
  ]
}
Observation.Slices for component.component:sliceReportingTimeframe.value[x] This element must be supported. This element is included in summaries. 1..1 Quantity Actual component result
Observation.Slices for component.component:sliceReportingTimeframe.value[x].value This element must be supported. This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
Observation.Slices for component.component:sliceReportingTimeframe.value[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Observation.Slices for component.component:sliceReportingTimeframe.value[x].unit This element must be supported. This element is included in summaries. 1..1 string Unit representation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.code Base required Location Relevance (eCR) 📦1 us.cdc.phinvads v0.12
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error 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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* Observation Reportability Information Observation
Observation.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:determinationOfReportability This element must be supported. 1..1 CodeableConcept US Public Health Determination of Reportability Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension
Binding: Determination of Reportability (eCR) (extensible): Determination of Reportability
Observation.Slices for extension.extension:determinationOfReportabilityReason This element must be supported. 0..* string, CodeableConcept US Public Health Determination of Reportability Reason
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-reason-extension
Observation.Slices for extension.extension:determinationOfReportabilityRule This element must be supported. 0..* string US Public Health Determination of Reportability Rule Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-rule-extension
Observation.Slices for extension.extension:externalResourceExtension This element must be supported. 0..* Reference(RR DocumentReference) External resources pertaining to the condition
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-extension
Observation.status This element must be supported. 1..1 code registered | preliminary | final | amended +
Observation.code This element must be supported. 1..1 CodeableConcept Location Relevance
Binding: Location Relevance (eCR) (required): Location Relevance
Observation.Slices for performer This element must be supported. 2..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by profile:resolve()
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for performer.performer:rulesAuthoringAgency This element must be supported. 1..* Reference(RRRules Authoring Agency Organization) Who is responsible for the observation
Observation.Slices for performer.performer:routingEntity This element must be supported. 1..* Reference(RRRouting Entity Organization) Who is responsible for the observation
Observation.Slices for performer.performer:responsibleAgency This element must be supported. 0..* Reference(RR Responsible Agency Organization) Who is responsible for the observation
Observation.Slices for component This element must be supported. 1..* BackboneElement Reporting timeframe
Slice: Unordered, Open by value:code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for component.component:sliceReportingTimeframe This element must be supported. 0..* BackboneElement Component results
Observation.Slices for component.component:sliceReportingTimeframe.code This element must be supported. 1..1 CodeableConcept Timeframe to report (urgency)
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR4"
    }
  ]
}
Observation.Slices for component.component:sliceReportingTimeframe.value[x] This element must be supported. 1..1 Quantity Actual component result
Observation.Slices for component.component:sliceReportingTimeframe.value[x].value This element must be supported. 1..1 decimal Numerical value (with implicit precision)
Observation.Slices for component.component:sliceReportingTimeframe.value[x].unit This element must be supported. 1..1 string Unit representation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base required Location Relevance (eCR) 📦1 us.cdc.phinvads v0.12

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Reportability Information Observation
Constraints: obs-6, obs-7
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.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
Observation.contained 0..* Resource Contained, inline Resources
Observation.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:determinationOfReportability This element must be supported. 1..1 CodeableConcept US Public Health Determination of Reportability Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-extension
Binding: Determination of Reportability (eCR) (extensible): Determination of Reportability
Observation.Slices for extension.extension:determinationOfReportabilityReason This element must be supported. 0..* string, CodeableConcept US Public Health Determination of Reportability Reason
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-reason-extension
Observation.Slices for extension.extension:determinationOfReportabilityRule This element must be supported. 0..* string US Public Health Determination of Reportability Rule Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-determination-of-reportability-rule-extension
Observation.Slices for extension.extension:externalResourceExtension This element must be supported. 0..* Reference(RR DocumentReference) External resources pertaining to the condition
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-extension
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Location Relevance
Binding: Location Relevance (eCR) (required): Location Relevance
Observation.subject This element is included in summaries. 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.effective[x] This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
Observation.effective[x].effectiveDateTime dateTime
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.Slices for performer This element must be supported. This element is included in summaries. 2..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for performer.performer:rulesAuthoringAgency This element must be supported. This element is included in summaries. 1..* Reference(RRRules Authoring Agency Organization) Who is responsible for the observation
Observation.Slices for performer.performer:routingEntity This element must be supported. This element is included in summaries. 1..* Reference(RRRouting Entity Organization) Who is responsible for the observation
Observation.Slices for performer.performer:responsibleAgency This element must be supported. This element is included in summaries. 0..* Reference(RR Responsible Agency Organization) Who is responsible for the observation
Observation.value[x] This element is included in summaries. C 0..1 Actual result
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueCodeableConcept CodeableConcept
Observation.value[x].valueString string
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Observation.Slices for component This element must be supported. This element is included in summaries. 1..* BackboneElement Reporting timeframe
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for component.component:All Slices Content/Rules for all slices
Observation.Slices for component.component:All Slices.id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:All Slices.extension 0..* Extension Additional content defined by implementations
Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.Slices for component.component:All Slices.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.Slices for component.component:All Slices.value[x] This element is included in summaries. 0..1 Actual component result
Observation.Slices for component.component:All Slices.value[x].valueQuantity Quantity
Observation.Slices for component.component:All Slices.value[x].valueCodeableConcept CodeableConcept
Observation.Slices for component.component:All Slices.value[x].valueString string
Observation.Slices for component.component:All Slices.value[x].valueBoolean boolean
Observation.Slices for component.component:All Slices.value[x].valueInteger integer
Observation.Slices for component.component:All Slices.value[x].valueRange Range
Observation.Slices for component.component:All Slices.value[x].valueRatio Ratio
Observation.Slices for component.component:All Slices.value[x].valueSampledData SampledData
Observation.Slices for component.component:All Slices.value[x].valueTime time
Observation.Slices for component.component:All Slices.value[x].valueDateTime dateTime
Observation.Slices for component.component:All Slices.value[x].valuePeriod Period
Observation.Slices for component.component:All Slices.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.Slices for component.component:All Slices.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.Slices for component.component:All Slices.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
Observation.Slices for component.component:sliceReportingTimeframe This element must be supported. This element is included in summaries. 0..* BackboneElement Component results
Observation.Slices for component.component:sliceReportingTimeframe.id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:sliceReportingTimeframe.extension 0..* Extension Additional content defined by implementations
Observation.Slices for component.component:sliceReportingTimeframe.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.Slices for component.component:sliceReportingTimeframe.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Timeframe to report (urgency)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR4"
    }
  ]
}
Observation.Slices for component.component:sliceReportingTimeframe.value[x] This element must be supported. This element is included in summaries. 1..1 Quantity Actual component result
Observation.Slices for component.component:sliceReportingTimeframe.value[x].id 0..1 string Unique id for inter-element referencing
Observation.Slices for component.component:sliceReportingTimeframe.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.Slices for component.component:sliceReportingTimeframe.value[x].value This element must be supported. This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
Observation.Slices for component.component:sliceReportingTimeframe.value[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Observation.Slices for component.component:sliceReportingTimeframe.value[x].unit This element must be supported. This element is included in summaries. 1..1 string Unit representation
Observation.Slices for component.component:sliceReportingTimeframe.value[x].system This element is included in summaries. C 0..1 uri System that defines coded unit form
Observation.Slices for component.component:sliceReportingTimeframe.value[x].code This element is included in summaries. 0..1 code Coded form of the unit
Observation.Slices for component.component:sliceReportingTimeframe.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.Slices for component.component:sliceReportingTimeframe.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.Slices for component.component:sliceReportingTimeframe.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base required Location Relevance (eCR) 📦1 us.cdc.phinvads v0.12
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:sliceReportingTimeframe.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error 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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron