This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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 | Trial Use | Use Context: Not yet ready 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 | Observation | Measurements and simple assertions | |
code | S | 1..1 | CodeableConcept | Cholesterol Fixed Value: As shown |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 35200-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: 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 | Unit representation Fixed Value: mmol/L |
system | S | 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 |
interpretation | S | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- |
note | S | 0..* | Annotation | Comments about result |
referenceRange | S | 1..1 | BackboneElement | Provides guide for interpretation |
low | 0..0 | |||
high | 1..1 | SimpleQuantity | A fixed quantity (no comparator) Fixed Value: As shown | |
value | 1..1 | decimal | Numerical value (with implicit precision) Fixed 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 | Observation | Measurements and simple assertions |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Business Identifier for observation |
basedOn | ΣI | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
partOf | ΣI | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationUsage | Procedure | Immunization | ImagingStudy) | Part of referenced event |
status | ?!ΣI | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | I | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (preferred) |
code | SΣI | 1..1 | CodeableConcept | Cholesterol Binding: LOINC Codes (example) Fixed Value: As shown |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
version | 0..0 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 35200-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Cholesterol [Moles/volume] in Serum or Plasma | |
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
text | 0..0 | string | Plain text representation of the concept | |
subject | ΣI | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
focus | ΣI | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
encounter | ΣI | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
effective[x] | ΣI | 0..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
issued | ΣI | 0..1 | instant | Date/Time this version was made available |
performer | ΣI | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | ΣI | 0..1 | (Slice Definition) | Actual result Slice: Unordered, Closed by type:$this |
value[x]:valueQuantity | SΣI | 0..1 | Quantity | Cholesterol value |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
value | SΣI | 0..1 | decimal | Actual numerical value |
unit | SΣI | 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ΣI | 1..1 | code | Coded form of the unit Fixed Value: mmol/L |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible) |
interpretation | SI | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- Binding: Observation Interpretation Codes (extensible) |
note | SI | 0..* | Annotation | Comments about result |
bodySite | I | 0..1 | CodeableConcept | Observed body part Binding: SNOMED CT Body Structures (example) |
method | I | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) |
specimen | I | 0..1 | Reference(Specimen) | Specimen used for this observation |
device | I | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device |
referenceRange | SI | 1..1 | BackboneElement | Provides guide for interpretation |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
high | I | 1..1 | SimpleQuantity | A fixed quantity (no comparator) Fixed Value: As shown |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
value | 1..1 | decimal | Numerical value (with implicit precision) Fixed Value: 4.5 | |
comparator | 0..0 | code | < | <= | >= | > - how to understand the value | |
unit | 0..0 | string | Unit representation | |
system | 0..0 | uri | System that defines coded unit form | |
code | 0..0 | code | Coded form of the unit | |
text | I | 0..1 | string | Text based reference range in an observation |
component | ΣI | 0..* | BackboneElement | Component results |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | ΣI | 0..1 | Actual component result | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueSampledData | SampledData | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueAttachment | Attachment | |||
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
interpretation | I | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) |
referenceRange | I | 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) Fulfills plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(MedicationAdministration) 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) Who and/or what the observation is about --></subject> <focus><!-- 0..* Reference(Resource) What the observation is about, when it is not about the subject of record --></focus> <encounter><!-- 0..1 Reference(Encounter) Healthcare event during which this observation is made --></encounter> <effective[x]><!-- 0..1 dateTime|Period|Timing|instant 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) Who is responsible for the observation --></performer> <-- valueQuantity sliced by type:$this in the specified orderClosed--> <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> <note><!-- 0..* Annotation Comments about result --></note> <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) (Measurement) Device --></device> <referenceRange> 1..1 BackboneElement <!-- 1..1 Provides guide for interpretation --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <low><!-- 0..0 Quantity Low Range, if relevant --></low> <high><!-- 1..1 Quantity A fixed quantity (no comparator) --></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) Related resource that belongs to the Observation group --></hasMember> <derivedFrom><!-- 0..0 Reference(DocumentReference) Related measurements the observation is made from --></derivedFrom> <component> 0..* BackboneElement <!-- 0..* Component results --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></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|Attachment Actual component result --></value[x]> <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!-- 0..* 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 }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "identifier" : [{ Identifier }], // C?Business Identifier for observation "basedOn" : [{ Reference(CarePlan) }], // C?Fulfills plan, proposal or order "partOf" : [{ Reference(MedicationAdministration) }], // C?Part of referenced event "status" : "<code>", // C? R! registered | preliminary | final | amended + "category" : [{ CodeableConcept }], // C?Classification of type of observation "code" : { CodeableConcept }, // C? R! "subject" : { Reference(Patient) }, // C?Who and/or what the observation is about "focus" : [{ Reference(Resource) }], // C?What the observation is about, when it is not about the subject of record "encounter" : { Reference(Encounter) }, // C?Healthcare event during which this observation is made // value[x]: Clinically relevant time/time-period for observation. One of these 4: "effectiveDateTime" : "<dateTime>", // C?Clinically relevant time/time-period for observation "effectivePeriod" : { Period }, // C?Clinically relevant time/time-period for observation "effectiveTiming" : { Timing }, // C?Clinically relevant time/time-period for observation "effectiveInstant" : "<instant>", // C?Clinically relevant time/time-period for observation "issued" : "<instant>", // C?Date/Time this version was made available "performer" : [{ Reference(Practitioner) }], // C?Who is responsible for the observation "valueQuantity" : [ // sliced by type:$this in the specified order, Closed { // Cholesterol value // C? // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "value" : <decimal>, // C?Actual numerical value "unit" : "mmol/L", // C? R! "system" : "http://unitsofmeasure.org", // C? R! "code" : "mmol/L" // C? R! } ], "dataAbsentReason" : { CodeableConcept }, // C?Why the result is missing "interpretation" : { CodeableConcept }, // C?+ | ++ | +++ | - | -- | --- "note" : [{ Annotation }], // C?Comments about result "bodySite" : { CodeableConcept }, // C?Observed body part "method" : { CodeableConcept }, // C?How it was done "specimen" : { Reference(Specimen) }, // C?Specimen used for this observation "device" : { Reference(Device) }, // C?(Measurement) Device "referenceRange" : { BackboneElement }, // C? R! Provides guide for interpretation "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 | Observation | Measurements and simple assertions | |
code | S | 1..1 | CodeableConcept | Cholesterol Fixed Value: As shown |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 35200-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: 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 | Unit representation Fixed Value: mmol/L |
system | S | 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 |
interpretation | S | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- |
note | S | 0..* | Annotation | Comments about result |
referenceRange | S | 1..1 | BackboneElement | Provides guide for interpretation |
low | 0..0 | |||
high | 1..1 | SimpleQuantity | A fixed quantity (no comparator) Fixed Value: As shown | |
value | 1..1 | decimal | Numerical value (with implicit precision) Fixed 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 | Observation | Measurements and simple assertions |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Business Identifier for observation |
basedOn | ΣI | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
partOf | ΣI | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationUsage | Procedure | Immunization | ImagingStudy) | Part of referenced event |
status | ?!ΣI | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | I | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (preferred) |
code | SΣI | 1..1 | CodeableConcept | Cholesterol Binding: LOINC Codes (example) Fixed Value: As shown |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
version | 0..0 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 35200-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Cholesterol [Moles/volume] in Serum or Plasma | |
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
text | 0..0 | string | Plain text representation of the concept | |
subject | ΣI | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
focus | ΣI | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
encounter | ΣI | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
effective[x] | ΣI | 0..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
issued | ΣI | 0..1 | instant | Date/Time this version was made available |
performer | ΣI | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | ΣI | 0..1 | (Slice Definition) | Actual result Slice: Unordered, Closed by type:$this |
value[x]:valueQuantity | SΣI | 0..1 | Quantity | Cholesterol value |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
value | SΣI | 0..1 | decimal | Actual numerical value |
unit | SΣI | 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ΣI | 1..1 | code | Coded form of the unit Fixed Value: mmol/L |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible) |
interpretation | SI | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- Binding: Observation Interpretation Codes (extensible) |
note | SI | 0..* | Annotation | Comments about result |
bodySite | I | 0..1 | CodeableConcept | Observed body part Binding: SNOMED CT Body Structures (example) |
method | I | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) |
specimen | I | 0..1 | Reference(Specimen) | Specimen used for this observation |
device | I | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device |
referenceRange | SI | 1..1 | BackboneElement | Provides guide for interpretation |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
high | I | 1..1 | SimpleQuantity | A fixed quantity (no comparator) Fixed Value: As shown |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
value | 1..1 | decimal | Numerical value (with implicit precision) Fixed Value: 4.5 | |
comparator | 0..0 | code | < | <= | >= | > - how to understand the value | |
unit | 0..0 | string | Unit representation | |
system | 0..0 | uri | System that defines coded unit form | |
code | 0..0 | code | Coded form of the unit | |
text | I | 0..1 | string | Text based reference range in an observation |
component | ΣI | 0..* | BackboneElement | Component results |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | ΣI | 0..1 | Actual component result | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueSampledData | SampledData | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
valueAttachment | Attachment | |||
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
interpretation | I | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) |
referenceRange | I | 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) Fulfills plan, proposal or order --></basedOn> <partOf><!-- 0..* Reference(MedicationAdministration) 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) Who and/or what the observation is about --></subject> <focus><!-- 0..* Reference(Resource) What the observation is about, when it is not about the subject of record --></focus> <encounter><!-- 0..1 Reference(Encounter) Healthcare event during which this observation is made --></encounter> <effective[x]><!-- 0..1 dateTime|Period|Timing|instant 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) Who is responsible for the observation --></performer> <-- valueQuantity sliced by type:$this in the specified orderClosed--> <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> <note><!-- 0..* Annotation Comments about result --></note> <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) (Measurement) Device --></device> <referenceRange> 1..1 BackboneElement <!-- 1..1 Provides guide for interpretation --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <low><!-- 0..0 Quantity Low Range, if relevant --></low> <high><!-- 1..1 Quantity A fixed quantity (no comparator) --></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) Related resource that belongs to the Observation group --></hasMember> <derivedFrom><!-- 0..0 Reference(DocumentReference) Related measurements the observation is made from --></derivedFrom> <component> 0..* BackboneElement <!-- 0..* Component results --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></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|Attachment Actual component result --></value[x]> <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing --></dataAbsentReason> <interpretation><!-- 0..* 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 }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "identifier" : [{ Identifier }], // C?Business Identifier for observation "basedOn" : [{ Reference(CarePlan) }], // C?Fulfills plan, proposal or order "partOf" : [{ Reference(MedicationAdministration) }], // C?Part of referenced event "status" : "<code>", // C? R! registered | preliminary | final | amended + "category" : [{ CodeableConcept }], // C?Classification of type of observation "code" : { CodeableConcept }, // C? R! "subject" : { Reference(Patient) }, // C?Who and/or what the observation is about "focus" : [{ Reference(Resource) }], // C?What the observation is about, when it is not about the subject of record "encounter" : { Reference(Encounter) }, // C?Healthcare event during which this observation is made // value[x]: Clinically relevant time/time-period for observation. One of these 4: "effectiveDateTime" : "<dateTime>", // C?Clinically relevant time/time-period for observation "effectivePeriod" : { Period }, // C?Clinically relevant time/time-period for observation "effectiveTiming" : { Timing }, // C?Clinically relevant time/time-period for observation "effectiveInstant" : "<instant>", // C?Clinically relevant time/time-period for observation "issued" : "<instant>", // C?Date/Time this version was made available "performer" : [{ Reference(Practitioner) }], // C?Who is responsible for the observation "valueQuantity" : [ // sliced by type:$this in the specified order, Closed { // Cholesterol value // C? // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "value" : <decimal>, // C?Actual numerical value "unit" : "mmol/L", // C? R! "system" : "http://unitsofmeasure.org", // C? R! "code" : "mmol/L" // C? R! } ], "dataAbsentReason" : { CodeableConcept }, // C?Why the result is missing "interpretation" : { CodeableConcept }, // C?+ | ++ | +++ | - | -- | --- "note" : [{ Annotation }], // C?Comments about result "bodySite" : { CodeableConcept }, // C?Observed body part "method" : { CodeableConcept }, // C?How it was done "specimen" : { Reference(Specimen) }, // C?Specimen used for this observation "device" : { Reference(Device) }, // C?(Measurement) Device "referenceRange" : { BackboneElement }, // C? R! Provides guide for interpretation "component" : [{ BackboneElement }], // C?Component results }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Observation.language | Common Languages | preferred | 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 | DataAbsentReason | extensible | DataAbsentReason |
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 | DataAbsentReason | extensible | DataAbsentReason |
Observation.component.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |