This page is part of the FHIR Specification (v3.5.0: R4 Ballot #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/hdlcholesterol
HDL Cholesterol Result
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 | HDL Cholesterol Result | ||
code | S | 1..1 | CodeableConcept | HDL Cholesterol Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]} |
valueQuantity | S | 0..1 | Quantity | HDL Cholesterol value |
interpretation | S | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- |
comment | S | 0..1 | string | Comments about result |
referenceRange | S | 1..1 | BackboneElement | |
low | 1..1 | SimpleQuantity | Fixed Value: {"value":1.5} | |
high | 0..0 | |||
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 | HDL Cholesterol Result | |
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: Language (preferred) | |
text | 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 | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | 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 | HDL Cholesterol Binding: LOINC Codes (example) Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]} |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
effective[x] | Σ | 0..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this version was made available |
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
valueQuantity | SΣI | 0..1 | Quantity | HDL Cholesterol value |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (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 | 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 if unrecognized |
low | I | 1..1 | SimpleQuantity | Low Range, if relevant Fixed Value: {"value":1.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 if unrecognized |
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: DataAbsentReason (extensible) |
interpretation | 0..* | 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) 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 HDL 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><!-- 0..1 Quantity HDL Cholesterol value --></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) (Measurement) Device --></device> <referenceRange> 1..1 BackboneElement <!-- 1..1 Provides guide for interpretation --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored if unrecognized --></modifierExtension> <low><!-- 1..1 Quantity Low Range, if relevant --></low> <high><!-- 0..0 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) 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 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 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 }, //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 "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event "status" : "<code>", // R! registered | preliminary | final | amended + "category" : [{ CodeableConcept }], //Classification of type of observation "code" : { CodeableConcept }, // R! "subject" : { Reference(Patient) }, //Who and/or what the observation is about "focus" : [{ Reference(Resource) }], //What the observation is about, when it is not about the subject of record "encounter" : { Reference(Encounter) }, //Healthcare event during which this observation is made // value[x]: Clinically relevant time/time-period for observation. One of these 4: "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 "effectiveInstant" : "<instant>", //Clinically relevant time/time-period for observation "issued" : "<instant>", //Date/Time this version was made available "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation "valueQuantity" : { Quantity }, //HDL 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 "device" : { Reference(Device) }, //(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 | HDL Cholesterol Result | ||
code | S | 1..1 | CodeableConcept | HDL Cholesterol Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]} |
valueQuantity | S | 0..1 | Quantity | HDL Cholesterol value |
interpretation | S | 0..1 | CodeableConcept | + | ++ | +++ | - | -- | --- |
comment | S | 0..1 | string | Comments about result |
referenceRange | S | 1..1 | BackboneElement | |
low | 1..1 | SimpleQuantity | Fixed Value: {"value":1.5} | |
high | 0..0 | |||
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 | HDL Cholesterol Result | |
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: Language (preferred) | |
text | 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 | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | 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 | HDL Cholesterol Binding: LOINC Codes (example) Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]} |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
effective[x] | Σ | 0..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this version was made available |
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
valueQuantity | SΣI | 0..1 | Quantity | HDL Cholesterol value |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (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 | 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 if unrecognized |
low | I | 1..1 | SimpleQuantity | Low Range, if relevant Fixed Value: {"value":1.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 if unrecognized |
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: DataAbsentReason (extensible) |
interpretation | 0..* | 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) 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 HDL 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><!-- 0..1 Quantity HDL Cholesterol value --></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) (Measurement) Device --></device> <referenceRange> 1..1 BackboneElement <!-- 1..1 Provides guide for interpretation --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored if unrecognized --></modifierExtension> <low><!-- 1..1 Quantity Low Range, if relevant --></low> <high><!-- 0..0 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) 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 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 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 }, //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 "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event "status" : "<code>", // R! registered | preliminary | final | amended + "category" : [{ CodeableConcept }], //Classification of type of observation "code" : { CodeableConcept }, // R! "subject" : { Reference(Patient) }, //Who and/or what the observation is about "focus" : [{ Reference(Resource) }], //What the observation is about, when it is not about the subject of record "encounter" : { Reference(Encounter) }, //Healthcare event during which this observation is made // value[x]: Clinically relevant time/time-period for observation. One of these 4: "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 "effectiveInstant" : "<instant>", //Clinically relevant time/time-period for observation "issued" : "<instant>", //Date/Time this version was made available "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation "valueQuantity" : { Quantity }, //HDL 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 "device" : { Reference(Device) }, //(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 | Language | preferred | Language |
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 |