Work in progress.
This section of the Implementation Guide is subject to change.

Profile EEBaseObservation


Profile Purpose

Observation represents one of the most important and central units of healthcare data exchange - different kinds of observations varying from clinical findings and measurements to social history. The resource is designed to cover a wide variety of use cases and as a result, at its simplest, a resource instance can consist of only a code, value, and status flag. The granularity of instance highly depends on the use case, therefore the minimal viable data considered is a decision that needs to be made during profiling process.

Example usage scenarios

  • Query for observations based on type of observation using the query parameter on Observation.code
  • Query for observations based on value of the observation, if the value is a CodeableConcept on Observation.value
  • Exchange Observation information within a FHIR document or message


Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ I0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ I0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
statusS Σ ?!1..1codeBinding
categoryS0..*CodeableConceptBinding
codeS Σ1..1CodeableConcept
subjectS Σ I0..1Reference(Group | Device | EEBase Location | EEBase Patient)
focusΣ I0..*Reference(Resource)
encounterS Σ I0..1Reference(EEBase Encounter)
effectiveDateTimedateTime
effectivePeriodPeriod
effectiveTimingTiming
effectiveInstantinstant
issuedΣ0..1instant
performerS Σ I0..*Reference(CareTeam | EEBase RelatedPerson | EEBase Patient | EEBase Organization | EEBase Practitioner | EEBase PractitionerRole)
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonS I0..1CodeableConceptBinding
interpretationS0..*CodeableConceptBinding
note0..*Annotation
bodySiteS0..1CodeableConceptBinding
method0..1CodeableConceptBinding
specimenS I0..1Reference(Specimen)
deviceI0..1Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
hasMemberΣ I0..*Reference(QuestionnaireResponse | MolecularSequence | EEBase Observation)
derivedFromΣ I0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | EEBase Observation)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1CodeableConcept
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Differential View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ I0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ I0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
statusS Σ ?!1..1codeBinding
categoryS0..*CodeableConceptBinding
codeS Σ1..1CodeableConcept
subjectS Σ I0..1Reference(Group | Device | EEBase Location | EEBase Patient)
focusΣ I0..*Reference(Resource)
encounterS Σ I0..1Reference(EEBase Encounter)
effectiveDateTimedateTime
effectivePeriodPeriod
effectiveTimingTiming
effectiveInstantinstant
issuedΣ0..1instant
performerS Σ I0..*Reference(CareTeam | EEBase RelatedPerson | EEBase Patient | EEBase Organization | EEBase Practitioner | EEBase PractitionerRole)
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonS I0..1CodeableConceptBinding
interpretationS0..*CodeableConceptBinding
note0..*Annotation
bodySiteS0..1CodeableConceptBinding
method0..1CodeableConceptBinding
specimenS I0..1Reference(Specimen)
deviceI0..1Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
hasMemberΣ I0..*Reference(QuestionnaireResponse | MolecularSequence | EEBase Observation)
derivedFromΣ I0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | EEBase Observation)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1CodeableConcept
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ I0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ I0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
statusS Σ ?!1..1codeBinding
categoryS0..*CodeableConceptBinding
codeS Σ1..1CodeableConcept
subjectS Σ I0..1Reference(Group | Device | EEBase Location | EEBase Patient)
focusΣ I0..*Reference(Resource)
encounterS Σ I0..1Reference(EEBase Encounter)
effectiveDateTimedateTime
effectivePeriodPeriod
effectiveTimingTiming
effectiveInstantinstant
issuedΣ0..1instant
performerS Σ I0..*Reference(CareTeam | EEBase RelatedPerson | EEBase Patient | EEBase Organization | EEBase Practitioner | EEBase PractitionerRole)
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonS I0..1CodeableConceptBinding
interpretationS0..*CodeableConceptBinding
note0..*Annotation
bodySiteS0..1CodeableConceptBinding
method0..1CodeableConceptBinding
specimenS I0..1Reference(Specimen)
deviceI0..1Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
hasMemberΣ I0..*Reference(QuestionnaireResponse | MolecularSequence | EEBase Observation)
derivedFromΣ I0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | EEBase Observation)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1CodeableConcept
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Table View

Observation..
Observation.status..
Observation.category..
Observation.code..
Observation.subjectReference(Group | Device | EEBase Location | EEBase Patient)..
Observation.encounterReference(EEBase Encounter)..
Observation.effective[x]..
Observation.performerReference(CareTeam | EEBase RelatedPerson | EEBase Patient | EEBase Organization | EEBase Practitioner | EEBase PractitionerRole)..
Observation.value[x]..
Observation.dataAbsentReason..
Observation.interpretation..
Observation.bodySite..
Observation.method..
Observation.specimen..
Observation.hasMemberReference(QuestionnaireResponse | MolecularSequence | EEBase Observation)..
Observation.derivedFromReference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | EEBase Observation)..
Observation.component..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="EEBase-Observation" />
    <url value="https://hl7.ee/fhir/StructureDefinition/EEBase-Observation" />
    <version value="1.0.0" />
    <name value="EEBaseObservation" />
    <title value="EEBase Observation" />
    <status value="draft" />
    <date value="2022-11-03T14:56:40.4598428+00:00" />
    <publisher value="HL7 EE" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Observation" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Observation" />
    <derivation value="constraint" />
    <differential>
        <element id="Observation.status">
            <path value="Observation.status" />
            <mustSupport value="true" />
        </element>
        <element id="Observation.category">
            <path value="Observation.category" />
            <mustSupport value="true" />
        </element>
        <element id="Observation.code">
            <path value="Observation.code" />
            <mustSupport value="true" />
        </element>
        <element id="Observation.subject">
            <path value="Observation.subject" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Location" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Patient" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Observation.encounter">
            <path value="Observation.encounter" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Encounter" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Observation.effective[x]">
            <path value="Observation.effective[x]" />
            <mustSupport value="true" />
        </element>
        <element id="Observation.performer">
            <path value="Observation.performer" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-RelatedPerson" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Patient" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Organization" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Practitioner" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-PractitionerRole" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Observation.value[x]">
            <path value="Observation.value[x]" />
            <mustSupport value="true" />
        </element>
        <element id="Observation.dataAbsentReason">
            <path value="Observation.dataAbsentReason" />
            <mustSupport value="true" />
        </element>
        <element id="Observation.interpretation">
            <path value="Observation.interpretation" />
            <mustSupport value="true" />
        </element>
        <element id="Observation.bodySite">
            <path value="Observation.bodySite" />
            <mustSupport value="true" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="BodySite" />
                </extension>
                <strength value="preferred" />
            </binding>
        </element>
        <element id="Observation.method">
            <path value="Observation.method" />
            <mustSupport value="false" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="ObservationMethod" />
                </extension>
                <strength value="preferred" />
            </binding>
        </element>
        <element id="Observation.specimen">
            <path value="Observation.specimen" />
            <mustSupport value="true" />
        </element>
        <element id="Observation.hasMember">
            <path value="Observation.hasMember" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/MolecularSequence" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Observation" />
            </type>
        </element>
        <element id="Observation.derivedFrom">
            <path value="Observation.derivedFrom" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImagingStudy" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Media" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/MolecularSequence" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Observation" />
            </type>
        </element>
        <element id="Observation.component">
            <path value="Observation.component" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "EEBase-Observation",
    "url": "https://hl7.ee/fhir/StructureDefinition/EEBase-Observation",
    "version": "1.0.0",
    "name": "EEBaseObservation",
    "title": "EEBase Observation",
    "status": "draft",
    "date": "2022-11-03T14:56:40.4598428+00:00",
    "publisher": "HL7 EE",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Observation",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Observation.status",
                "path": "Observation.status",
                "mustSupport": true
            },
            {
                "id": "Observation.category",
                "path": "Observation.category",
                "mustSupport": true
            },
            {
                "id": "Observation.code",
                "path": "Observation.code",
                "mustSupport": true
            },
            {
                "id": "Observation.subject",
                "path": "Observation.subject",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Group",
                            "http://hl7.org/fhir/StructureDefinition/Device",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Location",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Observation.encounter",
                "path": "Observation.encounter",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Encounter"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Observation.effective[x]",
                "path": "Observation.effective[x]",
                "mustSupport": true
            },
            {
                "id": "Observation.performer",
                "path": "Observation.performer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/CareTeam",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-RelatedPerson",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Patient",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Organization",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Practitioner",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-PractitionerRole"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Observation.value[x]",
                "path": "Observation.value[x]",
                "mustSupport": true
            },
            {
                "id": "Observation.dataAbsentReason",
                "path": "Observation.dataAbsentReason",
                "mustSupport": true
            },
            {
                "id": "Observation.interpretation",
                "path": "Observation.interpretation",
                "mustSupport": true
            },
            {
                "id": "Observation.bodySite",
                "path": "Observation.bodySite",
                "mustSupport": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "BodySite"
                        }
                    ],
                    "strength": "preferred"
                }
            },
            {
                "id": "Observation.method",
                "path": "Observation.method",
                "mustSupport": false,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "ObservationMethod"
                        }
                    ],
                    "strength": "preferred"
                }
            },
            {
                "id": "Observation.specimen",
                "path": "Observation.specimen",
                "mustSupport": true
            },
            {
                "id": "Observation.hasMember",
                "path": "Observation.hasMember",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
                            "http://hl7.org/fhir/StructureDefinition/MolecularSequence",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Observation"
                        ]
                    }
                ]
            },
            {
                "id": "Observation.derivedFrom",
                "path": "Observation.derivedFrom",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/DocumentReference",
                            "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
                            "http://hl7.org/fhir/StructureDefinition/Media",
                            "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
                            "http://hl7.org/fhir/StructureDefinition/MolecularSequence",
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Observation"
                        ]
                    }
                ]
            },
            {
                "id": "Observation.component",
                "path": "Observation.component",
                "mustSupport": true
            }
        ]
    }
}


extension:episodeOfCare

Please note that this extension should be used in case of ... only.
An extension created for instances where referring to Encounter is not possible due to technical reasons (which are??), so the observation resource at hand could be bound with relevant EpisodeOfCare instead.

identifier

Business identifier(s) for which this specific observation is known.


basedOn

Please note that this data element includes references to CarePlan, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, and ServiceRequest resources which have not been covered (profiled) in this Implementation Guide.
The plan, proposal or order that is being fulfilled (in part or in whole) by this observation, by reference to CarePlan, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, or ServiceRequest.

partOf

Please note that this data element includes references to MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Immunization, and ImagingStudy resources which have not been covered (profiled) in this Implementation Guide.
The event this observation is part of by reference to MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Immunization, and ImagingStudy. This type of reference should be used with certain use cases only (read on Workflow Resource Patterns for guidance on building a workflow based on aformentioned resources), however, the use cases are higly dependent on jurisdiction, organizational practice (including clinical processes), and context. There is a separate element encounter for linking observation resource to a relevant encounter.

status (Must Support)

This is a mandatory data element.

A coded status attributed to the result value (value[x]) of this observation.
The required ValueSet used in this case is observation-status, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.


HTML View

This code system http://hl7.org/fhir/observation-status defines the following codes:

LvlCodeDisplayDefinition
1registeredRegisteredThe existence of the observation is registered, but there is no result yet available.
1preliminaryPreliminaryThis is an initial or interim observation: data may be incomplete or unverified.
1finalFinalThe observation is complete and there are no further actions needed. Additional information such "released", "signed", etc would be represented using [Provenance](provenance.html) which provides not only the act but also the actors and dates and other related data. These act states would be associated with an observation status of `preliminary` until they are all completed and then a status of `final` would be applied.
1amendedAmendedSubsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections.
2  correctedCorrectedSubsequent to being Final, the observation has been modified to correct an error in the test result.
1cancelledCancelledThe observation is unavailable because the measurement was not started or not completed (also sometimes called "aborted").
1entered-in-errorEntered in ErrorThe observation has been withdrawn following previous final release. This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".).
1unknownUnknownThe authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which.

Table View

CodeSystem.id[0]observation-status
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].value[0]cds
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].value[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].value[0]5
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[3].value[0]4.0.0
CodeSystem.url[0]http://hl7.org/fhir/observation-status
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.401
CodeSystem.version[0]4.0.1
CodeSystem.name[0]ObservationStatus
CodeSystem.title[0]ObservationStatus
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]Codes providing the status of an observation.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/observation-status
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]registered
CodeSystem.concept[0].display[0]Registered
CodeSystem.concept[0].definition[0]The existence of the observation is registered, but there is no result yet available.
CodeSystem.concept[1].code[0]preliminary
CodeSystem.concept[1].display[0]Preliminary
CodeSystem.concept[1].definition[0]This is an initial or interim observation: data may be incomplete or unverified.
CodeSystem.concept[2].code[0]final
CodeSystem.concept[2].display[0]Final
CodeSystem.concept[2].definition[0]The observation is complete and there are no further actions needed. Additional information such "released", "signed", etc would be represented using [Provenance](provenance.html) which provides not only the act but also the actors and dates and other related data. These act states would be associated with an observation status of `preliminary` until they are all completed and then a status of `final` would be applied.
CodeSystem.concept[3].code[0]amended
CodeSystem.concept[3].display[0]Amended
CodeSystem.concept[3].definition[0]Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections.
CodeSystem.concept[3].concept[0].code[0]corrected
CodeSystem.concept[3].concept[0].display[0]Corrected
CodeSystem.concept[3].concept[0].definition[0]Subsequent to being Final, the observation has been modified to correct an error in the test result.
CodeSystem.concept[4].code[0]cancelled
CodeSystem.concept[4].display[0]Cancelled
CodeSystem.concept[4].definition[0]The observation is unavailable because the measurement was not started or not completed (also sometimes called "aborted").
CodeSystem.concept[5].code[0]entered-in-error
CodeSystem.concept[5].display[0]Entered in Error
CodeSystem.concept[5].definition[0]The observation has been withdrawn following previous final release. This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".).
CodeSystem.concept[6].code[0]unknown
CodeSystem.concept[6].display[0]Unknown
CodeSystem.concept[6].definition[0]The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="observation-status" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="cds" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <url value="http://hl7.org/fhir/observation-status" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.401" />
    </identifier>
    <version value="4.0.1" />
    <name value="ObservationStatus" />
    <title value="ObservationStatus" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="Codes providing the status of an observation." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/observation-status" />
    <content value="complete" />
    <concept>
        <code value="registered" />
        <display value="Registered" />
        <definition value="The existence of the observation is registered, but there is no result yet available." />
    </concept>
    <concept>
        <code value="preliminary" />
        <display value="Preliminary" />
        <definition value="This is an initial or interim observation: data may be incomplete or unverified." />
    </concept>
    <concept>
        <code value="final" />
        <display value="Final" />
        <definition value="The observation is complete and there are no further actions needed. Additional information such &quot;released&quot;, &quot;signed&quot;, etc would be represented using [Provenance](provenance.html) which provides not only the act but also the actors and dates and other related data. These act states would be associated with an observation status of `preliminary` until they are all completed and then a status of `final` would be applied." />
    </concept>
    <concept>
        <code value="amended" />
        <display value="Amended" />
        <definition value="Subsequent to being Final, the observation has been modified subsequent.  This includes updates/new information and corrections." />
        <concept>
            <code value="corrected" />
            <display value="Corrected" />
            <definition value="Subsequent to being Final, the observation has been modified to correct an error in the test result." />
        </concept>
    </concept>
    <concept>
        <code value="cancelled" />
        <display value="Cancelled" />
        <definition value="The observation is unavailable because the measurement was not started or not completed (also sometimes called &quot;aborted&quot;)." />
    </concept>
    <concept>
        <code value="entered-in-error" />
        <display value="Entered in Error" />
        <definition value="The observation has been withdrawn following previous final release.  This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be &quot;cancelled&quot; rather than &quot;entered-in-error&quot;.)." />
    </concept>
    <concept>
        <code value="unknown" />
        <display value="Unknown" />
        <definition value="The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for &quot;other&quot; - one of the listed statuses is presumed to apply, but the authoring/source system does not know which." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "observation-status",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "cds"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        }
    ],
    "url": "http://hl7.org/fhir/observation-status",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.401"
        }
    ],
    "version": "4.0.1",
    "name": "ObservationStatus",
    "title": "ObservationStatus",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "Codes providing the status of an observation.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/observation-status",
    "content": "complete",
    "concept":  [
        {
            "code": "registered",
            "display": "Registered",
            "definition": "The existence of the observation is registered, but there is no result yet available."
        },
        {
            "code": "preliminary",
            "display": "Preliminary",
            "definition": "This is an initial or interim observation: data may be incomplete or unverified."
        },
        {
            "code": "final",
            "display": "Final",
            "definition": "The observation is complete and there are no further actions needed. Additional information such \"released\", \"signed\", etc would be represented using [Provenance](provenance.html) which provides not only the act but also the actors and dates and other related data. These act states would be associated with an observation status of `preliminary` until they are all completed and then a status of `final` would be applied."
        },
        {
            "code": "amended",
            "display": "Amended",
            "definition": "Subsequent to being Final, the observation has been modified subsequent.  This includes updates/new information and corrections.",
            "concept":  [
                {
                    "code": "corrected",
                    "display": "Corrected",
                    "definition": "Subsequent to being Final, the observation has been modified to correct an error in the test result."
                }
            ]
        },
        {
            "code": "cancelled",
            "display": "Cancelled",
            "definition": "The observation is unavailable because the measurement was not started or not completed (also sometimes called \"aborted\")."
        },
        {
            "code": "entered-in-error",
            "display": "Entered in Error",
            "definition": "The observation has been withdrawn following previous final release.  This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be \"cancelled\" rather than \"entered-in-error\".)."
        },
        {
            "code": "unknown",
            "display": "Unknown",
            "definition": "The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for \"other\" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which."
        }
    ]
}


category (Must Support)

Classification of the general type of observation (laboratory, procedure, survey etc.).
The preferred ValueSet used in this case is observation-category, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to observation-category by using the ConceptMap resource is encouraged.


HTML View

This code system http://terminology.hl7.org/CodeSystem/observation-category defines the following codes:

CodeDisplayDefinition
social-historySocial HistorySocial History Observations define the patient's occupational, personal (e.g., lifestyle), social, familial, and environmental history and health risk factors that may impact the patient's health.
vital-signsVital Signs Clinical observations measure the body's basic functions such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area.
imagingImagingObservations generated by imaging. The scope includes observations regarding plain x-ray, ultrasound, CT, MRI, angiography, echocardiography, and nuclear medicine.
laboratoryLaboratoryThe results of observations generated by laboratories. Laboratory results are typically generated by laboratories providing analytic services in areas such as chemistry, hematology, serology, histology, cytology, anatomic pathology (including digital pathology), microbiology, and/or virology. These observations are based on analysis of specimens obtained from the patient and submitted to the laboratory.
procedureProcedureObservations generated by other procedures. This category includes observations resulting from interventional and non-interventional procedures excluding laboratory and imaging (e.g., cardiology catheterization, endoscopy, electrodiagnostics, etc.). Procedure results are typically generated by a clinician to provide more granular information about component observations made during a procedure. An example would be when a gastroenterologist reports the size of a polyp observed during a colonoscopy.
surveySurveyAssessment tool/survey instrument observations (e.g., Apgar Scores, Montreal Cognitive Assessment (MoCA)).
examExamObservations generated by physical exam findings including direct observations made by a clinician and use of simple instruments and the result of simple maneuvers performed directly on the patient's body.
therapyTherapyObservations generated by non-interventional treatment protocols (e.g. occupational, physical, radiation, nutritional and medication therapy)
activityActivityObservations that measure or record any bodily activity that enhances or maintains physical fitness and overall health and wellness. Not under direct supervision of practitioner such as a physical therapist. (e.g., laps swum, steps, sleep data)

Table View

CodeSystem.id[0]observation-category
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.meta[0].profile[0]http://hl7.org/fhir/StructureDefinition/shareablecodesystem
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].value[0]oo
CodeSystem.url[0]http://terminology.hl7.org/CodeSystem/observation-category
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.1125
CodeSystem.version[0]4.0.1
CodeSystem.name[0]ObservationCategoryCodes
CodeSystem.title[0]Observation Category Codes
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.publisher[0]FHIR Project team
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.description[0]Observation Category codes.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/observation-category
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]social-history
CodeSystem.concept[0].display[0]Social History
CodeSystem.concept[0].definition[0]Social History Observations define the patient's occupational, personal (e.g., lifestyle), social, familial, and environmental history and health risk factors that may impact the patient's health.
CodeSystem.concept[1].code[0]vital-signs
CodeSystem.concept[1].display[0]Vital Signs
CodeSystem.concept[1].definition[0] Clinical observations measure the body's basic functions such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area.
CodeSystem.concept[2].code[0]imaging
CodeSystem.concept[2].display[0]Imaging
CodeSystem.concept[2].definition[0]Observations generated by imaging. The scope includes observations regarding plain x-ray, ultrasound, CT, MRI, angiography, echocardiography, and nuclear medicine.
CodeSystem.concept[3].code[0]laboratory
CodeSystem.concept[3].display[0]Laboratory
CodeSystem.concept[3].definition[0]The results of observations generated by laboratories. Laboratory results are typically generated by laboratories providing analytic services in areas such as chemistry, hematology, serology, histology, cytology, anatomic pathology (including digital pathology), microbiology, and/or virology. These observations are based on analysis of specimens obtained from the patient and submitted to the laboratory.
CodeSystem.concept[4].code[0]procedure
CodeSystem.concept[4].display[0]Procedure
CodeSystem.concept[4].definition[0]Observations generated by other procedures. This category includes observations resulting from interventional and non-interventional procedures excluding laboratory and imaging (e.g., cardiology catheterization, endoscopy, electrodiagnostics, etc.). Procedure results are typically generated by a clinician to provide more granular information about component observations made during a procedure. An example would be when a gastroenterologist reports the size of a polyp observed during a colonoscopy.
CodeSystem.concept[5].code[0]survey
CodeSystem.concept[5].display[0]Survey
CodeSystem.concept[5].definition[0]Assessment tool/survey instrument observations (e.g., Apgar Scores, Montreal Cognitive Assessment (MoCA)).
CodeSystem.concept[6].code[0]exam
CodeSystem.concept[6].display[0]Exam
CodeSystem.concept[6].definition[0]Observations generated by physical exam findings including direct observations made by a clinician and use of simple instruments and the result of simple maneuvers performed directly on the patient's body.
CodeSystem.concept[7].code[0]therapy
CodeSystem.concept[7].display[0]Therapy
CodeSystem.concept[7].definition[0]Observations generated by non-interventional treatment protocols (e.g. occupational, physical, radiation, nutritional and medication therapy)
CodeSystem.concept[8].code[0]activity
CodeSystem.concept[8].display[0]Activity
CodeSystem.concept[8].definition[0]Observations that measure or record any bodily activity that enhances or maintains physical fitness and overall health and wellness. Not under direct supervision of practitioner such as a physical therapist. (e.g., laps swum, steps, sleep data)

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="observation-category" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
        <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="oo" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/observation-category" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.1125" />
    </identifier>
    <version value="4.0.1" />
    <name value="ObservationCategoryCodes" />
    <title value="Observation Category Codes" />
    <status value="draft" />
    <experimental value="false" />
    <publisher value="FHIR Project team" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <description value="Observation Category codes." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/observation-category" />
    <content value="complete" />
    <concept>
        <code value="social-history" />
        <display value="Social History" />
        <definition value="Social History Observations define the patient&#39;s occupational, personal (e.g., lifestyle), social, familial, and environmental history and health risk factors that may impact the patient&#39;s health." />
    </concept>
    <concept>
        <code value="vital-signs" />
        <display value="Vital Signs" />
        <definition value="Clinical observations measure the body&#39;s basic functions such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area." />
    </concept>
    <concept>
        <code value="imaging" />
        <display value="Imaging" />
        <definition value="Observations generated by imaging. The scope includes observations regarding plain x-ray, ultrasound, CT, MRI, angiography, echocardiography, and nuclear medicine." />
    </concept>
    <concept>
        <code value="laboratory" />
        <display value="Laboratory" />
        <definition value="The results of observations generated by laboratories.  Laboratory results are typically generated by laboratories providing analytic services in areas such as chemistry, hematology, serology, histology, cytology, anatomic pathology (including digital pathology), microbiology, and/or virology. These observations are based on analysis of specimens obtained from the patient and submitted to the laboratory." />
    </concept>
    <concept>
        <code value="procedure" />
        <display value="Procedure" />
        <definition value="Observations generated by other procedures.  This category includes observations resulting from interventional and non-interventional procedures excluding laboratory and imaging (e.g., cardiology catheterization, endoscopy, electrodiagnostics, etc.).  Procedure results are typically generated by a clinician to provide more granular information about component observations made during a procedure.  An example would be when a gastroenterologist reports the size of a polyp observed during a colonoscopy." />
    </concept>
    <concept>
        <code value="survey" />
        <display value="Survey" />
        <definition value="Assessment tool/survey instrument observations (e.g., Apgar Scores, Montreal Cognitive Assessment (MoCA))." />
    </concept>
    <concept>
        <code value="exam" />
        <display value="Exam" />
        <definition value="Observations generated by physical exam findings including direct observations made by a clinician and use of simple instruments and the result of simple maneuvers performed directly on the patient&#39;s body." />
    </concept>
    <concept>
        <code value="therapy" />
        <display value="Therapy" />
        <definition value="Observations generated by non-interventional treatment protocols (e.g. occupational, physical, radiation, nutritional and medication therapy)" />
    </concept>
    <concept>
        <code value="activity" />
        <display value="Activity" />
        <definition value="Observations that measure or record any bodily activity that enhances or maintains physical fitness and overall health and wellness.  Not under direct supervision of practitioner such as a physical therapist. (e.g., laps swum, steps, sleep data)" />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "observation-category",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00",
        "profile":  [
            "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
        ]
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "oo"
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/observation-category",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.1125"
        }
    ],
    "version": "4.0.1",
    "name": "ObservationCategoryCodes",
    "title": "Observation Category Codes",
    "status": "draft",
    "experimental": false,
    "publisher": "FHIR Project team",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        }
    ],
    "description": "Observation Category codes.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/observation-category",
    "content": "complete",
    "concept":  [
        {
            "code": "social-history",
            "display": "Social History",
            "definition": "Social History Observations define the patient's occupational, personal (e.g., lifestyle), social, familial, and environmental history and health risk factors that may impact the patient's health."
        },
        {
            "code": "vital-signs",
            "display": "Vital Signs",
            "definition": " Clinical observations measure the body's basic functions such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area."
        },
        {
            "code": "imaging",
            "display": "Imaging",
            "definition": "Observations generated by imaging. The scope includes observations regarding plain x-ray, ultrasound, CT, MRI, angiography, echocardiography, and nuclear medicine."
        },
        {
            "code": "laboratory",
            "display": "Laboratory",
            "definition": "The results of observations generated by laboratories.  Laboratory results are typically generated by laboratories providing analytic services in areas such as chemistry, hematology, serology, histology, cytology, anatomic pathology (including digital pathology), microbiology, and/or virology. These observations are based on analysis of specimens obtained from the patient and submitted to the laboratory."
        },
        {
            "code": "procedure",
            "display": "Procedure",
            "definition": "Observations generated by other procedures.  This category includes observations resulting from interventional and non-interventional procedures excluding laboratory and imaging (e.g., cardiology catheterization, endoscopy, electrodiagnostics, etc.).  Procedure results are typically generated by a clinician to provide more granular information about component observations made during a procedure.  An example would be when a gastroenterologist reports the size of a polyp observed during a colonoscopy."
        },
        {
            "code": "survey",
            "display": "Survey",
            "definition": "Assessment tool/survey instrument observations (e.g., Apgar Scores, Montreal Cognitive Assessment (MoCA))."
        },
        {
            "code": "exam",
            "display": "Exam",
            "definition": "Observations generated by physical exam findings including direct observations made by a clinician and use of simple instruments and the result of simple maneuvers performed directly on the patient's body."
        },
        {
            "code": "therapy",
            "display": "Therapy",
            "definition": "Observations generated by non-interventional treatment protocols (e.g. occupational, physical, radiation, nutritional and medication therapy)"
        },
        {
            "code": "activity",
            "display": "Activity",
            "definition": "Observations that measure or record any bodily activity that enhances or maintains physical fitness and overall health and wellness.  Not under direct supervision of practitioner such as a physical therapist. (e.g., laps swum, steps, sleep data)"
        }
    ]
}


code (Must Support)

This is a mandatory data element.
Coded value describing what exactly was observed.

The ValueSet used in this case is observation-codes based on LOINC. As a value set with Example binding, using this value set is not strictly expected.

subject (Must Support)

Please note that this data element includes references to Group and Device resources which have not been covered (profiled) in this Implementation Guide.
The patient (or group of patients), location, practitioner, or device subject to this observation by reference to EEBasePatient, EEBaseLocation, Group, or Device.

focus

An additional data element used in case where the subject of an observation is not the patient. Focus element COULD refer to any resource as long as it's consistent with the use case(s) covered by the profile this observation is based on.


encounter (Must Support)

This is a mandatory data element.
The encounter during which this observation was made, by reference to EEBaseEncounter.

effective[x] (Must Support)

The time/period on which the observed value (value[x]) is deemed as being true. This element should be populated with at least a date (unless this observation is a historical report).


issued

An instant in date and time this version of the observation was made available to be used by the providers. It is possible that the value of this data element will be exactly the same as the one in .lastUpdated element included in resource metadata in specific cases.


performer (Must Support)

Please note that this data element includes reference to CareTeam resource which has not been covered (profiled) in this Implementation Guide.
The subject responsible for deeming the observed value (value[x]) to be true by reference to EEBasePractitioner, EEBasePractitionerRole, EEBaseOrganization, CareTeam, EEBasePatient, or EEBaseRelatedPerson.

value[x] (Must Support)

The value which represents the result of the observation being made. There are a number of data types available for this data element and the choice on that should be made on the basis of the code attributed to code element.


dataAbsentReason (Must Support)

Data element reserved for null or exceptional values (e.g the value[x] is not the same as expected). Arguments for why and how to populate this element are highly use-case-dependent and should be analysed in the process of profiling EEBaseObservation.

The ValueSet used in this case is data-absent-reason (Binding Strength = Extended), meaning these values SHOULD be exchanged, however, using additional concepts is allowed if necessary.

HTML View

This code system http://terminology.hl7.org/CodeSystem/data-absent-reason defines the following codes:

LvlCodeDisplayDefinition
1unknownUnknownThe value is expected to exist but is not known.
2  asked-unknownAsked But UnknownThe source was asked but does not know the value.
2  temp-unknownTemporarily UnknownThere is reason to expect (from the workflow) that the value may become known.
2  not-askedNot AskedThe workflow didn't lead to this value being known.
2  asked-declinedAsked But DeclinedThe source was asked but declined to answer.
1maskedMaskedThe information is not available due to security, privacy or related reasons.
1not-applicableNot ApplicableThere is no proper value for this element (e.g. last menstrual period for a male).
1unsupportedUnsupportedThe source system wasn't capable of supporting this element.
1as-textAs TextThe content of the data is represented in the resource narrative.
1errorErrorSome system or workflow process error means that the information is not available.
2  not-a-numberNot a Number (NaN)The numeric value is undefined or unrepresentable due to a floating point processing error.
2  negative-infinityNegative Infinity (NINF)The numeric value is excessively low and unrepresentable due to a floating point processing error.
2  positive-infinityPositive Infinity (PINF)The numeric value is excessively high and unrepresentable due to a floating point processing error.
1not-performedNot PerformedThe value is not available because the observation procedure (test, etc.) was not performed.
1not-permittedNot PermittedThe value is not permitted in this context (e.g. due to profiles, or the base data types).

Table View

CodeSystem.id[0]data-absent-reason
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].value[0]oo
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].value[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[2].value[0]4.0.0
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[3].value[0]5
CodeSystem.url[0]http://terminology.hl7.org/CodeSystem/data-absent-reason
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.1048
CodeSystem.version[0]4.0.1
CodeSystem.name[0]DataAbsentReason
CodeSystem.title[0]DataAbsentReason
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.description[0]Used to specify why the normally expected content of the data element is missing.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/data-absent-reason
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]unknown
CodeSystem.concept[0].display[0]Unknown
CodeSystem.concept[0].definition[0]The value is expected to exist but is not known.
CodeSystem.concept[0].concept[0].code[0]asked-unknown
CodeSystem.concept[0].concept[0].display[0]Asked But Unknown
CodeSystem.concept[0].concept[0].definition[0]The source was asked but does not know the value.
CodeSystem.concept[0].concept[1].code[0]temp-unknown
CodeSystem.concept[0].concept[1].display[0]Temporarily Unknown
CodeSystem.concept[0].concept[1].definition[0]There is reason to expect (from the workflow) that the value may become known.
CodeSystem.concept[0].concept[2].code[0]not-asked
CodeSystem.concept[0].concept[2].display[0]Not Asked
CodeSystem.concept[0].concept[2].definition[0]The workflow didn't lead to this value being known.
CodeSystem.concept[0].concept[3].code[0]asked-declined
CodeSystem.concept[0].concept[3].display[0]Asked But Declined
CodeSystem.concept[0].concept[3].definition[0]The source was asked but declined to answer.
CodeSystem.concept[1].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[1].extension[0].value[0]Using "masked" may be breach of security or confidentiality, but there are times when its use is required to support alternate workflows for gaining access to denied information.
CodeSystem.concept[1].code[0]masked
CodeSystem.concept[1].display[0]Masked
CodeSystem.concept[1].definition[0]The information is not available due to security, privacy or related reasons.
CodeSystem.concept[2].code[0]not-applicable
CodeSystem.concept[2].display[0]Not Applicable
CodeSystem.concept[2].definition[0]There is no proper value for this element (e.g. last menstrual period for a male).
CodeSystem.concept[3].code[0]unsupported
CodeSystem.concept[3].display[0]Unsupported
CodeSystem.concept[3].definition[0]The source system wasn't capable of supporting this element.
CodeSystem.concept[4].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[4].extension[0].value[0]It may be linked by internal references (e.g. xml:id). This usually implies that the value could not be represented in the correct format - this may be due to system limitations, or this particular data value.
CodeSystem.concept[4].code[0]as-text
CodeSystem.concept[4].display[0]As Text
CodeSystem.concept[4].definition[0]The content of the data is represented in the resource narrative.
CodeSystem.concept[5].code[0]error
CodeSystem.concept[5].display[0]Error
CodeSystem.concept[5].definition[0]Some system or workflow process error means that the information is not available.
CodeSystem.concept[5].concept[0].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[5].concept[0].extension[0].value[0]This is sometimes an output value from measuring devices.
CodeSystem.concept[5].concept[0].code[0]not-a-number
CodeSystem.concept[5].concept[0].display[0]Not a Number (NaN)
CodeSystem.concept[5].concept[0].definition[0]The numeric value is undefined or unrepresentable due to a floating point processing error.
CodeSystem.concept[5].concept[1].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[5].concept[1].extension[0].value[0]This is sometimes an output value from measuring devices.
CodeSystem.concept[5].concept[1].code[0]negative-infinity
CodeSystem.concept[5].concept[1].display[0]Negative Infinity (NINF)
CodeSystem.concept[5].concept[1].definition[0]The numeric value is excessively low and unrepresentable due to a floating point processing error.
CodeSystem.concept[5].concept[2].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[5].concept[2].extension[0].value[0]This is sometimes an output value from measuring devices.
CodeSystem.concept[5].concept[2].code[0]positive-infinity
CodeSystem.concept[5].concept[2].display[0]Positive Infinity (PINF)
CodeSystem.concept[5].concept[2].definition[0]The numeric value is excessively high and unrepresentable due to a floating point processing error.
CodeSystem.concept[6].code[0]not-performed
CodeSystem.concept[6].display[0]Not Performed
CodeSystem.concept[6].definition[0]The value is not available because the observation procedure (test, etc.) was not performed.
CodeSystem.concept[7].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[7].extension[0].value[0]This is most often associated with required bindings that do not include the actual code used, but may be used with other data types.
CodeSystem.concept[7].code[0]not-permitted
CodeSystem.concept[7].display[0]Not Permitted
CodeSystem.concept[7].definition[0]The value is not permitted in this context (e.g. due to profiles, or the base data types).

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="data-absent-reason" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="oo" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/data-absent-reason" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.1048" />
    </identifier>
    <version value="4.0.1" />
    <name value="DataAbsentReason" />
    <title value="DataAbsentReason" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <description value="Used to specify why the normally expected content of the data element is missing." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/data-absent-reason" />
    <content value="complete" />
    <concept>
        <code value="unknown" />
        <display value="Unknown" />
        <definition value="The value is expected to exist but is not known." />
        <concept>
            <code value="asked-unknown" />
            <display value="Asked But Unknown" />
            <definition value="The source was asked but does not know the value." />
        </concept>
        <concept>
            <code value="temp-unknown" />
            <display value="Temporarily Unknown" />
            <definition value="There is reason to expect (from the workflow) that the value may become known." />
        </concept>
        <concept>
            <code value="not-asked" />
            <display value="Not Asked" />
            <definition value="The workflow didn&#39;t lead to this value being known." />
        </concept>
        <concept>
            <code value="asked-declined" />
            <display value="Asked But Declined" />
            <definition value="The source was asked but declined to answer." />
        </concept>
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Using &quot;masked&quot; may be breach of security or confidentiality, but there are times when its use is required to support alternate workflows for gaining access to denied information." />
        </extension>
        <code value="masked" />
        <display value="Masked" />
        <definition value="The information is not available due to security, privacy or related reasons." />
    </concept>
    <concept>
        <code value="not-applicable" />
        <display value="Not Applicable" />
        <definition value="There is no proper value for this element (e.g. last menstrual period for a male)." />
    </concept>
    <concept>
        <code value="unsupported" />
        <display value="Unsupported" />
        <definition value="The source system wasn&#39;t capable of supporting this element." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="It may be linked by internal references (e.g. xml:id). This usually implies that the value could not be represented in the correct format - this may be due to system limitations, or this particular data value." />
        </extension>
        <code value="as-text" />
        <display value="As Text" />
        <definition value="The content of the data is represented in the resource narrative." />
    </concept>
    <concept>
        <code value="error" />
        <display value="Error" />
        <definition value="Some system or workflow process error means that the information is not available." />
        <concept>
            <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
                <valueString value="This is sometimes an output value from measuring devices." />
            </extension>
            <code value="not-a-number" />
            <display value="Not a Number (NaN)" />
            <definition value="The numeric value is undefined or unrepresentable due to a floating point processing error." />
        </concept>
        <concept>
            <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
                <valueString value="This is sometimes an output value from measuring devices." />
            </extension>
            <code value="negative-infinity" />
            <display value="Negative Infinity (NINF)" />
            <definition value="The numeric value is excessively low and unrepresentable due to a floating point processing error." />
        </concept>
        <concept>
            <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
                <valueString value="This is sometimes an output value from measuring devices." />
            </extension>
            <code value="positive-infinity" />
            <display value="Positive Infinity (PINF)" />
            <definition value="The numeric value is excessively high and unrepresentable due to a floating point processing error." />
        </concept>
    </concept>
    <concept>
        <code value="not-performed" />
        <display value="Not Performed" />
        <definition value="The value is not available because the observation procedure (test, etc.) was not performed." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="This is most often associated with required bindings that do not include the actual code used, but may be used with other data types." />
        </extension>
        <code value="not-permitted" />
        <display value="Not Permitted" />
        <definition value="The value is not permitted in this context (e.g. due to profiles, or the base data types)." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "data-absent-reason",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "oo"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.1048"
        }
    ],
    "version": "4.0.1",
    "name": "DataAbsentReason",
    "title": "DataAbsentReason",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "description": "Used to specify why the normally expected content of the data element is missing.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason",
    "content": "complete",
    "concept":  [
        {
            "code": "unknown",
            "display": "Unknown",
            "definition": "The value is expected to exist but is not known.",
            "concept":  [
                {
                    "code": "asked-unknown",
                    "display": "Asked But Unknown",
                    "definition": "The source was asked but does not know the value."
                },
                {
                    "code": "temp-unknown",
                    "display": "Temporarily Unknown",
                    "definition": "There is reason to expect (from the workflow) that the value may become known."
                },
                {
                    "code": "not-asked",
                    "display": "Not Asked",
                    "definition": "The workflow didn't lead to this value being known."
                },
                {
                    "code": "asked-declined",
                    "display": "Asked But Declined",
                    "definition": "The source was asked but declined to answer."
                }
            ]
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Using \"masked\" may be breach of security or confidentiality, but there are times when its use is required to support alternate workflows for gaining access to denied information."
                }
            ],
            "code": "masked",
            "display": "Masked",
            "definition": "The information is not available due to security, privacy or related reasons."
        },
        {
            "code": "not-applicable",
            "display": "Not Applicable",
            "definition": "There is no proper value for this element (e.g. last menstrual period for a male)."
        },
        {
            "code": "unsupported",
            "display": "Unsupported",
            "definition": "The source system wasn't capable of supporting this element."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "It may be linked by internal references (e.g. xml:id). This usually implies that the value could not be represented in the correct format - this may be due to system limitations, or this particular data value."
                }
            ],
            "code": "as-text",
            "display": "As Text",
            "definition": "The content of the data is represented in the resource narrative."
        },
        {
            "code": "error",
            "display": "Error",
            "definition": "Some system or workflow process error means that the information is not available.",
            "concept":  [
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                            "valueString": "This is sometimes an output value from measuring devices."
                        }
                    ],
                    "code": "not-a-number",
                    "display": "Not a Number (NaN)",
                    "definition": "The numeric value is undefined or unrepresentable due to a floating point processing error."
                },
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                            "valueString": "This is sometimes an output value from measuring devices."
                        }
                    ],
                    "code": "negative-infinity",
                    "display": "Negative Infinity (NINF)",
                    "definition": "The numeric value is excessively low and unrepresentable due to a floating point processing error."
                },
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                            "valueString": "This is sometimes an output value from measuring devices."
                        }
                    ],
                    "code": "positive-infinity",
                    "display": "Positive Infinity (PINF)",
                    "definition": "The numeric value is excessively high and unrepresentable due to a floating point processing error."
                }
            ]
        },
        {
            "code": "not-performed",
            "display": "Not Performed",
            "definition": "The value is not available because the observation procedure (test, etc.) was not performed."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "This is most often associated with required bindings that do not include the actual code used, but may be used with other data types."
                }
            ],
            "code": "not-permitted",
            "display": "Not Permitted",
            "definition": "The value is not permitted in this context (e.g. due to profiles, or the base data types)."
        }
    ]
}


interpretation(Must Support)

Coded value intended for categorizing the 'meaning' of the value[x] within context of the use case.
The ValueSet used in this case is observation-interpretation (Binding Strength = Extended), meaning these values SHOULD be exchanged, however, using additional concepts is allowed if necessary.


note

Annotation-type data element for further comments about the observation.


bodySite (Must Support)

Coded value of the site on the subject's body where the observation was made. The preferred ValueSet used in this case is body-site, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to body-site by using the ConceptMap resource is encouraged.


method

Coded value describing the method used to execute the observation. This data element is used only if the method could not be inferred from the value of code element.

The preferred ValueSet used in this case is observation-methods, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to observation-methods by using the ConceptMap resource is encouraged.


specimen (Must Support)

Please note that this data element includes reference to Specimen resource which has not been covered (profiled) in this Implementation Guide.
The specimen used for this observation, by reference to Specimen. This data element is used only if the method could not be inferred from the value of code element.

device

Please note that this data element includes references to Device and DeviceMetric resources which have not been covered (profiled) in this Implementation Guide.
The device used for generating observation data, by reference to Device or DeviceMetric.


referenceRange

Guidance on how to interpret value[x] in comparison to normal/recommended range.


hasMember

Please note that this data element includes references to QuestionnaireResponse and MolecularSequence resources which have not been covered (profiled) in this Implementation Guide.
Reference element used for grouping observations if needed, by reference to EEBaseObservation, QuestionnaireResponse, or MolecularSequence.

derivedFrom

Please note that this data element includes references to DocumentReference, ImagingStudy, Media, QuestionnaireResponse, and MolecularSequence resources which have not been covered (profiled) in this Implementation Guide.
Reference element used in case where observation value (value[x]) has been derived from other resources, by reference to EEBaseObservation, DocumentReference, ImagingStudy, Media, QuestionnaireResponse, or MolecularSequence.

component (Must Support)

Element used for documenting observations that are considered a part of the primary observation. If populated, Observation.component.code MUST include a coded value from respective ValueSet as well. See Observation Grouping on FHIR website for more details.