This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Orders and Observations Work Group | Maturity Level: 1 | Informative | Use Context: Not Intended for Production use |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/cholesterol
Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride and Cholesterol fractions. Uses LOINC codes
This profile was published on Sat, May 12, 2012 00:00+1000 as a draft by Grahame Grieve.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Observation.
This structure is derived from Observation.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | |||
code | S | 1..1 | CodeableConcept | Cholesterol Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol [Moles/volume] in Serum or Plasma"}]} |
valueQuantity | S | 0..1 | Quantity | Cholesterol value |
value | S | 0..1 | decimal | Actual numerical value |
comparator | 0..0 | |||
unit | S | 1..1 | string | Fixed Value: mmol/L |
system | S | 1..1 | uri | Fixed Value: http://unitsofmeasure.org |
code | S | 1..1 | code | Fixed Value: mmol/L |
interpretation | S | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- |
comment | S | 0..1 | string | Comments about result |
referenceRange | S | 1..1 | BackboneElement | |
low | 0..0 | |||
high | 1..1 | SimpleQuantity | Fixed Value: {"value":4.5} | |
type | 0..0 | |||
appliesTo | 0..0 | |||
age | 0..0 | |||
hasMember | 0..0 | |||
derivedFrom | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 1..1 | Measurements and simple assertions | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business Identifier for observation |
basedOn | Σ | 0..* | Reference(CarePlan), Reference(DeviceRequest), Reference(ImmunizationRecommendation), Reference(MedicationRequest), Reference(NutritionOrder), Reference(ServiceRequest) | Fulfills plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration), Reference(MedicationDispense), Reference(MedicationStatement), Reference(Procedure), Reference(Immunization), Reference(ImagingStudy) | Part of referenced event |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (preferred) | |
code | SΣ | 1..1 | CodeableConcept | Cholesterol Binding: LOINC Codes (example) Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol [Moles/volume] in Serum or Plasma"}]} |
subject | Σ | 0..1 | Reference(Patient), Reference(Group), Reference(Device), Reference(Location) | Who and/or what this is about |
context | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Healthcare event during which this observation is made | |
effective[x] | Σ | 0..1 | dateTime, Period, Timing | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this version was made available |
performer | Σ | 0..* | Reference(Practitioner), Reference(PractitionerRole), Reference(Organization), Reference(CareTeam), Reference(Patient), Reference(RelatedPerson) | Who is responsible for the observation |
valueQuantity | SΣI | 0..1 | Quantity | Cholesterol value |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
value | SΣ | 0..1 | decimal | Actual numerical value |
unit | SΣ | 1..1 | string | Unit representation Fixed Value: mmol/L |
system | SΣI | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mmol/L |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | S | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- Binding: Observation Interpretation Codes (extensible) |
comment | S | 0..1 | string | Comments about result |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMED CT Body Structures (example) | |
method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device), Reference(DeviceComponent), Reference(DeviceMetric) | (Measurement) Device | |
referenceRange | SI | 1..1 | BackboneElement | Provides guide for interpretation |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
high | I | 1..1 | SimpleQuantity | High Range, if relevant Fixed Value: {"value":4.5} |
text | 0..1 | string | Text based reference range in an observation | |
component | ΣI | 0..* | BackboneElement | Component results |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | Σ | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
Documentation for this format |
<!-- Example Lipid Profile --> <Observation xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 0..* Identifier Business Identifier for observation --></identifier> <basedOn><!-- 0..* Reference(CarePlan)|Reference(DeviceRequest)|Reference(ImmunizationRecommendation)|Reference(MedicationRequest)| Reference(NutritionOrder)|Reference(ServiceRequest) Fulfills plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(MedicationAdministration)|Reference(MedicationDispense)|Reference(MedicationStatement)|Reference(Procedure)|Reference(Immunization)| Reference(ImagingStudy) Part of referenced event --></partOf> <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended + --> <category><!-- 0..* CodeableConcept Classification of type of observation --></category> <code><!-- 1..1 CodeableConcept Cholesterol --></code> <subject><!-- 0..1 Reference(Patient)|Reference(Group)|Reference(Device)|Reference(Location) Who and/or what this is about --></subject> <context><!-- 0..1 Reference(Encounter)|Reference(EpisodeOfCare) Healthcare event during which this observation is made --></context> <effective[x]><!-- 0..1 dateTime|Period|Timing Clinically relevant time/time-period for observation --></effective[x]> <issued value="[instant]"/><!-- 0..1 Date/Time this version was made available --> <performer><!-- 0..* Reference(Practitioner)|Reference(PractitionerRole)|Reference(Organization)|Reference(CareTeam)| Reference(Patient)|Reference(RelatedPerson) Who is responsible for the observation --></performer> <valueQuantity> 0..1 Quantity <!-- 0..1 Cholesterol value --> <value value="[decimal]"/><!-- 0..1 Actual numerical value --> <comparator value="[code]"/><!-- 0..0 < | <= | >= | > - how to understand the value --> <unit value="[string]"/><!-- 1..1 Unit representation --> <system value="[uri]"/><!-- 1..1 System that defines coded unit form --> <code value="[code]"/><!-- 1..1 Coded form of the unit --> </valueQuantity> <dataAbsentReason><!-- 0..1 CodeableConcept Why the result is missing --></dataAbsentReason> <interpretation><!-- 0..1 CodeableConcept + | ++ | +++ | - | -- | --- --></interpretation> <comment value="[string]"/><!-- 0..1 Comments about result --> <bodySite><!-- 0..1 CodeableConcept Observed body part --></bodySite> <method><!-- 0..1 CodeableConcept How it was done --></method> <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen> <device><!-- 0..1 Reference(Device)|Reference(DeviceComponent)|Reference(DeviceMetric) (Measurement) Device --></device> <referenceRange> 1..1 BackboneElement <!-- 1..1 Provides guide for interpretation --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <low><!-- 0..0 Quantity Low Range, if relevant --></low> <high><!-- 1..1 Quantity High Range, if relevant --></high> <type><!-- 0..0 CodeableConcept Reference range qualifier --></type> <appliesTo><!-- 0..0 CodeableConcept Reference range population --></appliesTo> <age><!-- 0..0 Range Applicable age range, if relevant --></age> <text value="[string]"/><!-- 0..1 Text based reference range in an observation --> </referenceRange> <hasMember><!-- 0..0 Reference(Observation)|Reference(QuestionnaireResponse)|Reference(Sequence) Related resource that belongs to the Observation group --></hasMember> <derivedFrom><!-- 0..0 Reference(DocumentReference)|Reference(ImagingStudy)|Reference(Media)|Reference(QuestionnaireResponse)| Reference(Observation)|Reference(Sequence) Related measurements the observation is made from --></derivedFrom> <component> 0..* BackboneElement <!-- 0..* Component results --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <code><!-- 1..1 CodeableConcept Type of component observation (code / type) --></code> <value[x]><!-- 0..1 Quantity|CodeableConcept|string| boolean|integer|Range|Ratio|SampledData|time|dateTime|Period Actual component result --></value[x]> <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation> <referenceRange><!-- See #Observation.referenceRange Provides guide for interpretation of component result --></referenceRange> </component> </Observation>
{ // Example Lipid Profile // from Element: extension "meta" : { Meta }, //Metadata about the resource "implicitRules" : "<uri>", //A set of rules under which this content was created "language" : "<code>", //Language of the resource content "text" : { Narrative }, //Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored "identifier" : [{ Identifier }], //Business Identifier for observation // value[x]: Fulfills plan, proposal or order. One of these 6: "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(DeviceRequest) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(ImmunizationRecommendation) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(MedicationRequest) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(NutritionOrder) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(ServiceRequest) }], //Fulfills plan, proposal or order // value[x]: Part of referenced event. One of these 6: "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event "partOf" : [{ Reference(MedicationDispense) }], //Part of referenced event "partOf" : [{ Reference(MedicationStatement) }], //Part of referenced event "partOf" : [{ Reference(Procedure) }], //Part of referenced event "partOf" : [{ Reference(Immunization) }], //Part of referenced event "partOf" : [{ Reference(ImagingStudy) }], //Part of referenced event "status" : "<code>", // R! registered | preliminary | final | amended + "category" : [{ CodeableConcept }], //Classification of type of observation "code" : { CodeableConcept }, // R! // value[x]: Who and/or what this is about. One of these 4: "subject" : { Reference(Patient) }, //Who and/or what this is about "subject" : { Reference(Group) }, //Who and/or what this is about "subject" : { Reference(Device) }, //Who and/or what this is about "subject" : { Reference(Location) }, //Who and/or what this is about // value[x]: Healthcare event during which this observation is made. One of these 2: "context" : { Reference(Encounter) }, //Healthcare event during which this observation is made "context" : { Reference(EpisodeOfCare) }, //Healthcare event during which this observation is made // value[x]: Clinically relevant time/time-period for observation. One of these 3: "effectiveDateTime" : "<dateTime>" //Clinically relevant time/time-period for observation "effectivePeriod" : { Period }, //Clinically relevant time/time-period for observation "effectiveTiming" : { Timing }, //Clinically relevant time/time-period for observation "issued" : "<instant>", //Date/Time this version was made available // value[x]: Who is responsible for the observation. One of these 6: "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation "performer" : [{ Reference(PractitionerRole) }], //Who is responsible for the observation "performer" : [{ Reference(Organization) }], //Who is responsible for the observation "performer" : [{ Reference(CareTeam) }], //Who is responsible for the observation "performer" : [{ Reference(Patient) }], //Who is responsible for the observation "performer" : [{ Reference(RelatedPerson) }], //Who is responsible for the observation "valueQuantity" : { Quantity }, //Cholesterol value "dataAbsentReason" : { CodeableConcept }, //Why the result is missing "interpretation" : { CodeableConcept }, //+ | ++ | +++ | - | -- | --- "comment" : "<string>", //Comments about result "bodySite" : { CodeableConcept }, //Observed body part "method" : { CodeableConcept }, //How it was done "specimen" : { Reference(Specimen) }, //Specimen used for this observation // value[x]: (Measurement) Device. One of these 3: "device" : { Reference(Device) }, //(Measurement) Device "device" : { Reference(DeviceComponent) }, //(Measurement) Device "device" : { Reference(DeviceMetric) }, //(Measurement) Device "referenceRange" : { BackboneElement }, // C? R! Provides guide for interpretation // value[x]: Related resource that belongs to the Observation group. One of these 3: // value[x]: Related measurements the observation is made from. One of these 6: "component" : [{ BackboneElement }], // C?Component results }
This structure is derived from Observation.
Differential View
This structure is derived from Observation.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | |||
code | S | 1..1 | CodeableConcept | Cholesterol Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol [Moles/volume] in Serum or Plasma"}]} |
valueQuantity | S | 0..1 | Quantity | Cholesterol value |
value | S | 0..1 | decimal | Actual numerical value |
comparator | 0..0 | |||
unit | S | 1..1 | string | Fixed Value: mmol/L |
system | S | 1..1 | uri | Fixed Value: http://unitsofmeasure.org |
code | S | 1..1 | code | Fixed Value: mmol/L |
interpretation | S | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- |
comment | S | 0..1 | string | Comments about result |
referenceRange | S | 1..1 | BackboneElement | |
low | 0..0 | |||
high | 1..1 | SimpleQuantity | Fixed Value: {"value":4.5} | |
type | 0..0 | |||
appliesTo | 0..0 | |||
age | 0..0 | |||
hasMember | 0..0 | |||
derivedFrom | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 1..1 | Measurements and simple assertions | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business Identifier for observation |
basedOn | Σ | 0..* | Reference(CarePlan), Reference(DeviceRequest), Reference(ImmunizationRecommendation), Reference(MedicationRequest), Reference(NutritionOrder), Reference(ServiceRequest) | Fulfills plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration), Reference(MedicationDispense), Reference(MedicationStatement), Reference(Procedure), Reference(Immunization), Reference(ImagingStudy) | Part of referenced event |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (preferred) | |
code | SΣ | 1..1 | CodeableConcept | Cholesterol Binding: LOINC Codes (example) Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol [Moles/volume] in Serum or Plasma"}]} |
subject | Σ | 0..1 | Reference(Patient), Reference(Group), Reference(Device), Reference(Location) | Who and/or what this is about |
context | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Healthcare event during which this observation is made | |
effective[x] | Σ | 0..1 | dateTime, Period, Timing | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this version was made available |
performer | Σ | 0..* | Reference(Practitioner), Reference(PractitionerRole), Reference(Organization), Reference(CareTeam), Reference(Patient), Reference(RelatedPerson) | Who is responsible for the observation |
valueQuantity | SΣI | 0..1 | Quantity | Cholesterol value |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
value | SΣ | 0..1 | decimal | Actual numerical value |
unit | SΣ | 1..1 | string | Unit representation Fixed Value: mmol/L |
system | SΣI | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mmol/L |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | S | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- Binding: Observation Interpretation Codes (extensible) |
comment | S | 0..1 | string | Comments about result |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMED CT Body Structures (example) | |
method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device), Reference(DeviceComponent), Reference(DeviceMetric) | (Measurement) Device | |
referenceRange | SI | 1..1 | BackboneElement | Provides guide for interpretation |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
high | I | 1..1 | SimpleQuantity | High Range, if relevant Fixed Value: {"value":4.5} |
text | 0..1 | string | Text based reference range in an observation | |
component | ΣI | 0..* | BackboneElement | Component results |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | Σ | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
Documentation for this format |
XML Template
<!-- Example Lipid Profile --> <Observation xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 0..* Identifier Business Identifier for observation --></identifier> <basedOn><!-- 0..* Reference(CarePlan)|Reference(DeviceRequest)|Reference(ImmunizationRecommendation)|Reference(MedicationRequest)| Reference(NutritionOrder)|Reference(ServiceRequest) Fulfills plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(MedicationAdministration)|Reference(MedicationDispense)|Reference(MedicationStatement)|Reference(Procedure)|Reference(Immunization)| Reference(ImagingStudy) Part of referenced event --></partOf> <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended + --> <category><!-- 0..* CodeableConcept Classification of type of observation --></category> <code><!-- 1..1 CodeableConcept Cholesterol --></code> <subject><!-- 0..1 Reference(Patient)|Reference(Group)|Reference(Device)|Reference(Location) Who and/or what this is about --></subject> <context><!-- 0..1 Reference(Encounter)|Reference(EpisodeOfCare) Healthcare event during which this observation is made --></context> <effective[x]><!-- 0..1 dateTime|Period|Timing Clinically relevant time/time-period for observation --></effective[x]> <issued value="[instant]"/><!-- 0..1 Date/Time this version was made available --> <performer><!-- 0..* Reference(Practitioner)|Reference(PractitionerRole)|Reference(Organization)|Reference(CareTeam)| Reference(Patient)|Reference(RelatedPerson) Who is responsible for the observation --></performer> <valueQuantity> 0..1 Quantity <!-- 0..1 Cholesterol value --> <value value="[decimal]"/><!-- 0..1 Actual numerical value --> <comparator value="[code]"/><!-- 0..0 < | <= | >= | > - how to understand the value --> <unit value="[string]"/><!-- 1..1 Unit representation --> <system value="[uri]"/><!-- 1..1 System that defines coded unit form --> <code value="[code]"/><!-- 1..1 Coded form of the unit --> </valueQuantity> <dataAbsentReason><!-- 0..1 CodeableConcept Why the result is missing --></dataAbsentReason> <interpretation><!-- 0..1 CodeableConcept + | ++ | +++ | - | -- | --- --></interpretation> <comment value="[string]"/><!-- 0..1 Comments about result --> <bodySite><!-- 0..1 CodeableConcept Observed body part --></bodySite> <method><!-- 0..1 CodeableConcept How it was done --></method> <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen> <device><!-- 0..1 Reference(Device)|Reference(DeviceComponent)|Reference(DeviceMetric) (Measurement) Device --></device> <referenceRange> 1..1 BackboneElement <!-- 1..1 Provides guide for interpretation --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <low><!-- 0..0 Quantity Low Range, if relevant --></low> <high><!-- 1..1 Quantity High Range, if relevant --></high> <type><!-- 0..0 CodeableConcept Reference range qualifier --></type> <appliesTo><!-- 0..0 CodeableConcept Reference range population --></appliesTo> <age><!-- 0..0 Range Applicable age range, if relevant --></age> <text value="[string]"/><!-- 0..1 Text based reference range in an observation --> </referenceRange> <hasMember><!-- 0..0 Reference(Observation)|Reference(QuestionnaireResponse)|Reference(Sequence) Related resource that belongs to the Observation group --></hasMember> <derivedFrom><!-- 0..0 Reference(DocumentReference)|Reference(ImagingStudy)|Reference(Media)|Reference(QuestionnaireResponse)| Reference(Observation)|Reference(Sequence) Related measurements the observation is made from --></derivedFrom> <component> 0..* BackboneElement <!-- 0..* Component results --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <code><!-- 1..1 CodeableConcept Type of component observation (code / type) --></code> <value[x]><!-- 0..1 Quantity|CodeableConcept|string| boolean|integer|Range|Ratio|SampledData|time|dateTime|Period Actual component result --></value[x]> <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc. --></interpretation> <referenceRange><!-- See #Observation.referenceRange Provides guide for interpretation of component result --></referenceRange> </component> </Observation>
JSON Template
{ // Example Lipid Profile // from Element: extension "meta" : { Meta }, //Metadata about the resource "implicitRules" : "<uri>", //A set of rules under which this content was created "language" : "<code>", //Language of the resource content "text" : { Narrative }, //Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored "identifier" : [{ Identifier }], //Business Identifier for observation // value[x]: Fulfills plan, proposal or order. One of these 6: "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(DeviceRequest) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(ImmunizationRecommendation) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(MedicationRequest) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(NutritionOrder) }], //Fulfills plan, proposal or order "basedOn" : [{ Reference(ServiceRequest) }], //Fulfills plan, proposal or order // value[x]: Part of referenced event. One of these 6: "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event "partOf" : [{ Reference(MedicationDispense) }], //Part of referenced event "partOf" : [{ Reference(MedicationStatement) }], //Part of referenced event "partOf" : [{ Reference(Procedure) }], //Part of referenced event "partOf" : [{ Reference(Immunization) }], //Part of referenced event "partOf" : [{ Reference(ImagingStudy) }], //Part of referenced event "status" : "<code>", // R! registered | preliminary | final | amended + "category" : [{ CodeableConcept }], //Classification of type of observation "code" : { CodeableConcept }, // R! // value[x]: Who and/or what this is about. One of these 4: "subject" : { Reference(Patient) }, //Who and/or what this is about "subject" : { Reference(Group) }, //Who and/or what this is about "subject" : { Reference(Device) }, //Who and/or what this is about "subject" : { Reference(Location) }, //Who and/or what this is about // value[x]: Healthcare event during which this observation is made. One of these 2: "context" : { Reference(Encounter) }, //Healthcare event during which this observation is made "context" : { Reference(EpisodeOfCare) }, //Healthcare event during which this observation is made // value[x]: Clinically relevant time/time-period for observation. One of these 3: "effectiveDateTime" : "<dateTime>" //Clinically relevant time/time-period for observation "effectivePeriod" : { Period }, //Clinically relevant time/time-period for observation "effectiveTiming" : { Timing }, //Clinically relevant time/time-period for observation "issued" : "<instant>", //Date/Time this version was made available // value[x]: Who is responsible for the observation. One of these 6: "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation "performer" : [{ Reference(PractitionerRole) }], //Who is responsible for the observation "performer" : [{ Reference(Organization) }], //Who is responsible for the observation "performer" : [{ Reference(CareTeam) }], //Who is responsible for the observation "performer" : [{ Reference(Patient) }], //Who is responsible for the observation "performer" : [{ Reference(RelatedPerson) }], //Who is responsible for the observation "valueQuantity" : { Quantity }, //Cholesterol value "dataAbsentReason" : { CodeableConcept }, //Why the result is missing "interpretation" : { CodeableConcept }, //+ | ++ | +++ | - | -- | --- "comment" : "<string>", //Comments about result "bodySite" : { CodeableConcept }, //Observed body part "method" : { CodeableConcept }, //How it was done "specimen" : { Reference(Specimen) }, //Specimen used for this observation // value[x]: (Measurement) Device. One of these 3: "device" : { Reference(Device) }, //(Measurement) Device "device" : { Reference(DeviceComponent) }, //(Measurement) Device "device" : { Reference(DeviceMetric) }, //(Measurement) Device "referenceRange" : { BackboneElement }, // C? R! Provides guide for interpretation // value[x]: Related resource that belongs to the Observation group. One of these 3: // value[x]: Related measurements the observation is made from. One of these 6: "component" : [{ BackboneElement }], // C?Component results }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Observation.language | Common Languages | extensible | Common Languages |
Observation.status | ObservationStatus | required | ObservationStatus |
Observation.category | Observation Category Codes | preferred | Observation Category Codes |
Observation.code | LOINC Codes | example | LOINC Codes |
Observation.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
Observation.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
Observation.bodySite | SNOMED CT Body Structures | example | SNOMED CT Body Structures |
Observation.method | Observation Methods | example | Observation Methods |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
Observation.component.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |