Release 4 5 Preview #2
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
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/lipidprofile

Lipid Lab Report

This profile was published on Sat, May 12, 2012 00:00+1000 00:00+0000 as a draft by Grahame Grieve.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .

This structure is derived from DiagnosticReport .

Summary

This is a test summary lipids

Mandatory: 4 elements
Must-Support: 5 elements
Fixed Value: 1 element Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices :

  • The element DiagnosticReport.result is sliced based on the value of value:resolve().code (ordered, Closed)

This structure is derived from DiagnosticReport .

Name Flags Card. Type Description & Constraints doco
. . DiagnosticReport 1..1 DiagnosticReport Lipid Lab Report
. . . code 1..1 CodeableConcept LOINC Code for Lipid Panel with LDL
Fixed Value: Required Pattern: As shown At least the following
. . . . coding 1..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: 57698-3
. . . . . display 1..1 string Representation defined by the system
Fixed Value: Lipid panel with direct LDL - Serum or Plasma
. . . result 3 .. 4 (Slice Definition) Observations
Slice: Ordered, Closed by value:resolve().code
. . . . result:Cholesterol S 1..1 Reference ( Example Lipid Profile ) Cholesterol Result
. . . . result:Triglyceride S 1..1 Reference ( Example Lipid Profile ) Triglyceride Result
. . . . result:HDLCholesterol S 1..1 Reference ( Example Lipid Profile ) HDL Cholesterol Result
. . . . result:LDLCholesterol S 0..1 Reference ( Example Lipid Profile ) LDL Cholesterol result, if reported
. . . conclusion S 0..1 string Clinical Interpretation of Lipid Panel

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DiagnosticReport I 1..1 DiagnosticReport Lipid Lab Report
. . . id Σ 0..1 string 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
. . . 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 report
. . . basedOn I 0..* Reference ( CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) What was requested
. . . status ?! Σ I 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus ( required )
. . . category Σ I 0..* CodeableConcept Service category
Binding: Diagnostic Service Section Codes ( example )
. . . code Σ I 1..1 CodeableConcept LOINC Code for Lipid Panel with LDL
Binding: LOINC Diagnostic Report Codes ( preferred )
Fixed Value: Required Pattern: As shown At least the following
. . . . id 0..0 0..1 string Unique id for inter-element referencing
. . . . extension 0..0 0..* Extension Additional content defined by implementations
. . . . coding 1..1 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . id 0..0 0..1 string Unique id for inter-element referencing
. . . . . extension 0..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 0..1 string Version of the system - if relevant
. . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: 57698-3
. . . . . display 1..1 string Representation defined by the system
Fixed Value: Lipid panel with direct LDL - Serum or Plasma
. . . . . userSelected 0..0 0..1 boolean If this coding was chosen directly by the user
. . . . text 0..0 0..1 string Plain text representation of the concept
. . . subject Σ I 0..1 Reference ( Patient | Group | Device | Location ) The subject of the report - usually, but not always, the patient
. . . encounter Σ I 0..1 Reference ( Encounter ) Health care event when test ordered
. . . effective[x] Σ I 0..1 Clinically relevant time/time-period for report
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . issued Σ I 0..1 instant DateTime this version was made
. . . performer Σ I 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam ) Responsible Diagnostic Service
. . . resultsInterpreter Σ I 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam ) Primary result interpreter
. . . specimen I 0..* Reference ( Specimen ) Specimens this report is based on
. . . result I 3 .. 4 (Slice Definition) Observations
Slice: Ordered, Closed by value:resolve().code
. . . . result:Cholesterol S I 1..1 Reference ( Example Lipid Profile ) Cholesterol Result
. . . . result:Triglyceride S I 1..1 Reference ( Example Lipid Profile ) Triglyceride Result
. . . . result:HDLCholesterol S I 1..1 Reference ( Example Lipid Profile ) HDL Cholesterol Result
. . . . result:LDLCholesterol S I 0..1 Reference ( Example Lipid Profile ) LDL Cholesterol result, if reported
. . . imagingStudy I 0..* Reference ( ImagingStudy ) Reference to full details of imaging associated with the diagnostic report
. . . media Σ I 0..* BackboneElement Key images associated with this report
. . . . id 0..1 string 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
. . . . comment I 0..1 string Comment about the image (e.g. explanation)
. . . . link Σ I 1..1 Reference ( Media DocumentReference ) Reference to the image source
. . . conclusion S I 0..1 string Clinical Interpretation of Lipid Panel
. . . presentedForm I 0..* Attachment Entire report as issued

doco Documentation for this format
<!-- Example Lipid Profile -->doco
<DiagnosticReport xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <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 report --></identifier>
 <basedOn><!-- ?? 0..* Reference(CarePlan) What was requested --></basedOn>
 <status value="[code]"/><!-- ?? 1..1 registered | partial | preliminary | final +   -->
 <category><!-- ?? 0..* CodeableConcept Service category   --></category>
 <code><!-- ?? 1..1 CodeableConcept LOINC Code for Lipid Panel with LDL   --></code>
 <subject><!-- ?? 0..1 Reference(Patient) 
     The subject of the report - usually, but not always, the patient --></subject>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Health care event when test ordered --></encounter>
 <effective[x]><!-- ?? 0..1 dateTime|Period 
     Clinically relevant time/time-period for report --></effective[x]>
 <issued value="[instant]"/><!-- ?? 0..1 DateTime this version was made -->
 <performer><!-- ?? 0..* Reference(Practitioner) 
     Responsible Diagnostic Service --></performer>
 <resultsInterpreter><!-- ?? 0..* Reference(Practitioner) 
     Primary result interpreter --></resultsInterpreter>
 <specimen><!-- ?? 0..* Reference(Specimen) 
     Specimens this report is based on --></specimen>
 <-- result sliced by value:resolve().code  in any order-->
 <result><!-- ?? 1..1 Reference(Example Lipid Profile) Cholesterol Result --></result>
 <result><!-- ?? 1..1 Reference(Example Lipid Profile) Triglyceride Result --></result>
 <result><!-- ?? 1..1 Reference(Example Lipid Profile) HDL Cholesterol Result --></result>
 <result><!-- ?? 0..1 Reference(Example Lipid Profile) 
     LDL Cholesterol result, if reported --></result>
 <imagingStudy><!-- ?? 0..* Reference(ImagingStudy) 
     Reference to full details of imaging associated with the diagnostic report --></imagingStudy>
 <

 <media> ?? 0..* BackboneElement  <!-- ?? 0..* Key images associated with this report -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <comment value="[string]"/><!-- ?? 0..1 Comment about the image (e.g. explanation) -->
  <

  <link><!-- ?? 1..1 Reference(DocumentReference) 

      Reference to the image source --></link>
 </media>
 <conclusion value="[string]"/><!-- ?? 0..1 Clinical Interpretation of Lipid Panel -->
 <conclusionCode><!-- ?? 0..0 CodeableConcept No codes for a lipid panel   --></conclusionCode>
 <presentedForm><!-- ?? 0..* Attachment 
     Entire report as issued --></presentedForm>
</DiagnosticReport>
{ // 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 report
    "basedOn" : [{ Reference(CarePlan) }], // C?What was requested
    "status" : "<code>", // C? R! registered | partial | preliminary | final +
    "category" : [{ CodeableConcept }], // C?Service category
    " 

    "code" : { CodeableConcept }, // C? R! LOINC Code for Lipid Panel with LDL

    "subject" : { Reference(Patient) }, // C?The subject of the report - usually, but not always, the patient
    "encounter" : { Reference(Encounter) }, // C?Health care event when test ordered
// value[x]: Clinically relevant time/time-period for report. One of these 2:
    "effectiveDateTime" : "<dateTime>", // C?Clinically relevant time/time-period for report
    "effectivePeriod" : { Period }, // C?Clinically relevant time/time-period for report
    "issued" : "<instant>", // C?DateTime this version was made
    "performer" : [{ Reference(Practitioner) }], // C?Responsible Diagnostic Service
    "resultsInterpreter" : [{ Reference(Practitioner) }], // C?Primary result interpreter
    "specimen" : [{ Reference(Specimen) }], // C?Specimens this report is based on
    "result" : [ //  sliced by value:resolve().code  in any order,  
      { // Cholesterol Result // C? R! 
        // from Element: extension
      },
      { // Triglyceride Result // C? R! 
        // from Element: extension
      },
      { // HDL Cholesterol Result // C? R! 
        // from Element: extension
      },
      { // LDL Cholesterol result, if reported // C?
        // from Element: extension
      }
    ],
    "imagingStudy" : [{ Reference(ImagingStudy) }], // C?Reference to full details of imaging associated with the diagnostic report
    "

    "media" : [{ BackboneElement }], // C?Key images associated with this report

    "conclusion" : "<string>", // C?Clinical Interpretation of Lipid Panel
    "presentedForm" : [{ Attachment }], // C?Entire report as issued
  }

This structure is derived from DiagnosticReport .

Summary

This is a test summary lipids

Mandatory: 4 elements
Must-Support: 5 elements
Fixed Value: 1 element Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices :

  • The element DiagnosticReport.result is sliced based on the value of value:resolve().code (ordered, Closed)

Differential View

This structure is derived from DiagnosticReport .

Name Flags Card. Type Description & Constraints doco
. . DiagnosticReport 1..1 DiagnosticReport Lipid Lab Report
. . . code 1..1 CodeableConcept LOINC Code for Lipid Panel with LDL
Fixed Value: Required Pattern: As shown At least the following
. . . . coding 1..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: 57698-3
. . . . . display 1..1 string Representation defined by the system
Fixed Value: Lipid panel with direct LDL - Serum or Plasma
. . . result 3 .. 4 (Slice Definition) Observations
Slice: Ordered, Closed by value:resolve().code
. . . . result:Cholesterol S 1..1 Reference ( Example Lipid Profile ) Cholesterol Result
. . . . result:Triglyceride S 1..1 Reference ( Example Lipid Profile ) Triglyceride Result
. . . . result:HDLCholesterol S 1..1 Reference ( Example Lipid Profile ) HDL Cholesterol Result
. . . . result:LDLCholesterol S 0..1 Reference ( Example Lipid Profile ) LDL Cholesterol result, if reported
. . . conclusion S 0..1 string Clinical Interpretation of Lipid Panel

doco Documentation for this format

Snapshot View

Name Flags Card. Type Description & Constraints doco
. . DiagnosticReport I 1..1 DiagnosticReport Lipid Lab Report
. . . id Σ 0..1 string 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
. . . 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 report
. . . basedOn I 0..* Reference ( CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) What was requested
. . . status ?! Σ I 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus ( required )
. . . category Σ I 0..* CodeableConcept Service category
Binding: Diagnostic Service Section Codes ( example )
. . . code Σ I 1..1 CodeableConcept LOINC Code for Lipid Panel with LDL
Binding: LOINC Diagnostic Report Codes ( preferred )
Fixed Value: Required Pattern: As shown At least the following
. . . . id 0..0 0..1 string Unique id for inter-element referencing
. . . . extension 0..0 0..* Extension Additional content defined by implementations
. . . . coding 1..1 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . id 0..0 0..1 string Unique id for inter-element referencing
. . . . . extension 0..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 0..1 string Version of the system - if relevant
. . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: 57698-3
. . . . . display 1..1 string Representation defined by the system
Fixed Value: Lipid panel with direct LDL - Serum or Plasma
. . . . . userSelected 0..0 0..1 boolean If this coding was chosen directly by the user
. . . . text 0..0 0..1 string Plain text representation of the concept
. . . subject Σ I 0..1 Reference ( Patient | Group | Device | Location ) The subject of the report - usually, but not always, the patient
. . . encounter Σ I 0..1 Reference ( Encounter ) Health care event when test ordered
. . . effective[x] Σ I 0..1 Clinically relevant time/time-period for report
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . issued Σ I 0..1 instant DateTime this version was made
. . . performer Σ I 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam ) Responsible Diagnostic Service
. . . resultsInterpreter Σ I 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam ) Primary result interpreter
. . . specimen I 0..* Reference ( Specimen ) Specimens this report is based on
. . . result I 3 .. 4 (Slice Definition) Observations
Slice: Ordered, Closed by value:resolve().code
. . . . result:Cholesterol S I 1..1 Reference ( Example Lipid Profile ) Cholesterol Result
. . . . result:Triglyceride S I 1..1 Reference ( Example Lipid Profile ) Triglyceride Result
. . . . result:HDLCholesterol S I 1..1 Reference ( Example Lipid Profile ) HDL Cholesterol Result
. . . . result:LDLCholesterol S I 0..1 Reference ( Example Lipid Profile ) LDL Cholesterol result, if reported
. . . imagingStudy I 0..* Reference ( ImagingStudy ) Reference to full details of imaging associated with the diagnostic report
. . . media Σ I 0..* BackboneElement Key images associated with this report
. . . . id 0..1 string 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
. . . . comment I 0..1 string Comment about the image (e.g. explanation)
. . . . link Σ I 1..1 Reference ( Media DocumentReference ) Reference to the image source
. . . conclusion S I 0..1 string Clinical Interpretation of Lipid Panel
. . . presentedForm I 0..* Attachment Entire report as issued

doco Documentation for this format

XML Template

<!-- Example Lipid Profile -->doco
<DiagnosticReport xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <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 report --></identifier>
 <basedOn><!-- ?? 0..* Reference(CarePlan) What was requested --></basedOn>
 <status value="[code]"/><!-- ?? 1..1 registered | partial | preliminary | final +   -->
 <category><!-- ?? 0..* CodeableConcept Service category   --></category>
 <code><!-- ?? 1..1 CodeableConcept LOINC Code for Lipid Panel with LDL   --></code>
 <subject><!-- ?? 0..1 Reference(Patient) 
     The subject of the report - usually, but not always, the patient --></subject>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Health care event when test ordered --></encounter>
 <effective[x]><!-- ?? 0..1 dateTime|Period 
     Clinically relevant time/time-period for report --></effective[x]>
 <issued value="[instant]"/><!-- ?? 0..1 DateTime this version was made -->
 <performer><!-- ?? 0..* Reference(Practitioner) 
     Responsible Diagnostic Service --></performer>
 <resultsInterpreter><!-- ?? 0..* Reference(Practitioner) 
     Primary result interpreter --></resultsInterpreter>
 <specimen><!-- ?? 0..* Reference(Specimen) 
     Specimens this report is based on --></specimen>
 <-- result sliced by value:resolve().code  in any order-->
 <result><!-- ?? 1..1 Reference(Example Lipid Profile) Cholesterol Result --></result>
 <result><!-- ?? 1..1 Reference(Example Lipid Profile) Triglyceride Result --></result>
 <result><!-- ?? 1..1 Reference(Example Lipid Profile) HDL Cholesterol Result --></result>
 <result><!-- ?? 0..1 Reference(Example Lipid Profile) 
     LDL Cholesterol result, if reported --></result>
 <imagingStudy><!-- ?? 0..* Reference(ImagingStudy) 
     Reference to full details of imaging associated with the diagnostic report --></imagingStudy>
 <

 <media> ?? 0..* BackboneElement  <!-- ?? 0..* Key images associated with this report -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <comment value="[string]"/><!-- ?? 0..1 Comment about the image (e.g. explanation) -->
  <

  <link><!-- ?? 1..1 Reference(DocumentReference) 

      Reference to the image source --></link>
 </media>
 <conclusion value="[string]"/><!-- ?? 0..1 Clinical Interpretation of Lipid Panel -->
 <conclusionCode><!-- ?? 0..0 CodeableConcept No codes for a lipid panel   --></conclusionCode>
 <presentedForm><!-- ?? 0..* Attachment 
     Entire report as issued --></presentedForm>
</DiagnosticReport>

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 report
    "basedOn" : [{ Reference(CarePlan) }], // C?What was requested
    "status" : "<code>", // C? R! registered | partial | preliminary | final +
    "category" : [{ CodeableConcept }], // C?Service category
    " 

    "code" : { CodeableConcept }, // C? R! LOINC Code for Lipid Panel with LDL

    "subject" : { Reference(Patient) }, // C?The subject of the report - usually, but not always, the patient
    "encounter" : { Reference(Encounter) }, // C?Health care event when test ordered
// value[x]: Clinically relevant time/time-period for report. One of these 2:
    "effectiveDateTime" : "<dateTime>", // C?Clinically relevant time/time-period for report
    "effectivePeriod" : { Period }, // C?Clinically relevant time/time-period for report
    "issued" : "<instant>", // C?DateTime this version was made
    "performer" : [{ Reference(Practitioner) }], // C?Responsible Diagnostic Service
    "resultsInterpreter" : [{ Reference(Practitioner) }], // C?Primary result interpreter
    "specimen" : [{ Reference(Specimen) }], // C?Specimens this report is based on
    "result" : [ //  sliced by value:resolve().code  in any order,  
      { // Cholesterol Result // C? R! 
        // from Element: extension
      },
      { // Triglyceride Result // C? R! 
        // from Element: extension
      },
      { // HDL Cholesterol Result // C? R! 
        // from Element: extension
      },
      { // LDL Cholesterol result, if reported // C?
        // from Element: extension
      }
    ],
    "imagingStudy" : [{ Reference(ImagingStudy) }], // C?Reference to full details of imaging associated with the diagnostic report
    "

    "media" : [{ BackboneElement }], // C?Key images associated with this report

    "conclusion" : "<string>", // C?Clinical Interpretation of Lipid Panel
    "presentedForm" : [{ Attachment }], // C?Entire report as issued
  }

 

Alternate definitions: Master Definition ( XML , JSON ), Schematron

Path Name Conformance ValueSet
DiagnosticReport.language Common Languages preferred Common Languages
DiagnosticReport.status DiagnosticReportStatus required DiagnosticReportStatus
DiagnosticReport.category Diagnostic Service Section Codes example Diagnostic Service Section Codes
DiagnosticReport.code LOINC Diagnostic Report Codes preferred LOINC Diagnostic Report Codes
.