R4 Draft for Comment

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

10.3.11.2 StructureDefinition: LipidProfile

Orders and Observations Work Group Maturity Level: 1Informative Use Context: Not Intended 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 as a draft by Grahame Grieve.

10.3.11.2.1 Formal Views of Profile Content

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 1..1Lipid Lab Report
... code 1..1CodeableConceptLOINC Code for Lipid Panel with LDL
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"57698-3","display":"Lipid panel with direct LDL - Serum or Plasma"}]}
... result Reference(Observation)Slice: Ordered, Closed by value:resolve().code
... result S1..1Reference(Example Lipid Profile)Cholesterol Result
... result S1..1Reference(Example Lipid Profile)Triglyceride Result
... result S1..1Reference(Example Lipid Profile)HDL Cholesterol Result
... result S0..1Reference(Example Lipid Profile)LDL Cholesterol result, if reported
... conclusion S0..1stringClinical Interpretation of Lipid Panel
... codedDiagnosis 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I1..1Lipid Lab Report
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for report
... basedOn 0..*Reference(CarePlan), Reference(ImmunizationRecommendation), Reference(MedicationRequest), Reference(NutritionOrder), Reference(ServiceRequest)What was requested
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... category Σ0..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (example)
... code Σ1..1CodeableConceptLOINC Code for Lipid Panel with LDL
Binding: LOINC Diagnostic Report Codes (preferred)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"57698-3","display":"Lipid panel with direct LDL - Serum or Plasma"}]}
... subject Σ0..1Reference(Patient), Reference(Group), Reference(Device), Reference(Location)The subject of the report - usually, but not always, the patient
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)Health care event when test ordered
... effective[x] Σ0..1dateTime, PeriodClinically relevant time/time-period for report
... issued Σ0..1instantDateTime this version was made
... performer Σ0..*Reference(Practitioner), Reference(PractitionerRole), Reference(Organization), Reference(CareTeam)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner), Reference(PractitionerRole), Reference(Organization), Reference(CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result Reference(Observation)Observations - simple, or complex nested groups
Slice: Ordered, Closed by value:resolve().code
... result S1..1Reference(Example Lipid Profile)Cholesterol Result
... result S1..1Reference(Example Lipid Profile)Triglyceride Result
... result S1..1Reference(Example Lipid Profile)HDL Cholesterol Result
... result S0..1Reference(Example Lipid Profile)LDL Cholesterol result, if reported
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media ΣI0..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical Interpretation of Lipid Panel
... presentedForm 0..*AttachmentEntire report as issued

doco Documentation for this format
<!-- Example Lipid Profile -->doco

<DiagnosticReport 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 report --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan)|Reference(ImmunizationRecommendation)|Reference(MedicationRequest)|Reference(NutritionOrder)|
   Reference(ServiceRequest) What was requested --></basedOn>
 <status value="[code]"/><!-- 1..1 registered | partial | preliminary | final +  -->
 <category><!-- 0..1 CodeableConcept Service category  --></category>
 <code><!-- 1..1 CodeableConcept LOINC Code for Lipid Panel with LDL  --></code>
 <subject><!-- 0..1 Reference(Patient)|Reference(Group)|Reference(Device)|Reference(Location) 
     The subject of the report - usually, but not always, the patient --></subject>
 <context><!-- 0..1 Reference(Encounter)|Reference(EpisodeOfCare) 
     Health care event when test ordered --></context>
 <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)|Reference(PractitionerRole)|Reference(Organization)|Reference(CareTeam) 
     Responsible Diagnostic Service --></performer>
 <resultsInterpreter><!-- 0..* Reference(Practitioner)|Reference(PractitionerRole)|Reference(Organization)|
   Reference(CareTeam) 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  --></modifierExtension>
  <comment value="[string]"/><!-- 0..1 Comment about the image (e.g. explanation) -->
  <link><!-- 1..1 Reference(Media) 
      Reference to the image source --></link>
 </media>
 <conclusion value="[string]"/><!-- 0..1 Clinical Interpretation of Lipid Panel -->
 <codedDiagnosis><!-- 0..0 CodeableConcept No codes for a lipid panel  --></codedDiagnosis>
 <presentedForm><!-- 0..* Attachment 
     Entire report as issued --></presentedForm>
</DiagnosticReport>

{ // 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 report
// value[x]: What was requested. One of these 5:
    "basedOn" : [{ Reference(CarePlan) }], //What was requested
    "basedOn" : [{ Reference(ImmunizationRecommendation) }], //What was requested
    "basedOn" : [{ Reference(MedicationRequest) }], //What was requested
    "basedOn" : [{ Reference(NutritionOrder) }], //What was requested
    "basedOn" : [{ Reference(ServiceRequest) }], //What was requested
    "status" : "<code>", // R! registered | partial | preliminary | final + 
    "category" : { CodeableConcept }, //Service category 
    "code" : { CodeableConcept }, // R! 
// value[x]: The subject of the report - usually, but not always, the patient. One of these 4:
    "subject" : { Reference(Patient) }, //The subject of the report - usually, but not always, the patient
    "subject" : { Reference(Group) }, //The subject of the report - usually, but not always, the patient
    "subject" : { Reference(Device) }, //The subject of the report - usually, but not always, the patient
    "subject" : { Reference(Location) }, //The subject of the report - usually, but not always, the patient
// value[x]: Health care event when test ordered. One of these 2:
    "context" : { Reference(Encounter) }, //Health care event when test ordered
    "context" : { Reference(EpisodeOfCare) }, //Health care event when test ordered
// value[x]: Clinically relevant time/time-period for report. One of these 2:
    "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for report
    "effectivePeriod" : { Period }, //Clinically relevant time/time-period for report
    "issued" : "<instant>", //DateTime this version was made
// value[x]: Responsible Diagnostic Service. One of these 4:
    "performer" : [{ Reference(Practitioner) }], //Responsible Diagnostic Service
    "performer" : [{ Reference(PractitionerRole) }], //Responsible Diagnostic Service
    "performer" : [{ Reference(Organization) }], //Responsible Diagnostic Service
    "performer" : [{ Reference(CareTeam) }] //Responsible Diagnostic Service
// value[x]: Primary result interpreter. One of these 4:
    "resultsInterpreter" : [{ Reference(Practitioner) }], //Primary result interpreter
    "resultsInterpreter" : [{ Reference(PractitionerRole) }], //Primary result interpreter
    "resultsInterpreter" : [{ Reference(Organization) }], //Primary result interpreter
    "resultsInterpreter" : [{ Reference(CareTeam) }], //Primary result interpreter
    "specimen" : [{ Reference(Specimen) }], //Specimens this report is based on
    "result" : [ //  sliced by value:resolve().code  in any order,  
      { // Cholesterol Result // R! 
        // from Element: extension
      },
      { // Triglyceride Result // R! 
        // from Element: extension
      },
      { // HDL Cholesterol Result // R! 
        // from Element: extension
      },
      { // LDL Cholesterol result, if reported //
        // from Element: extension
      }
    ],
    "imagingStudy" : [{ Reference(ImagingStudy) }], //Reference to full details of imaging associated with the diagnostic report
    "media" : [{ BackboneElement }], // C?Key images associated with this report
    "conclusion" : "<string>", //Clinical Interpretation of Lipid Panel
    "presentedForm" : [{ Attachment }], //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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 1..1Lipid Lab Report
... code 1..1CodeableConceptLOINC Code for Lipid Panel with LDL
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"57698-3","display":"Lipid panel with direct LDL - Serum or Plasma"}]}
... result Reference(Observation)Slice: Ordered, Closed by value:resolve().code
... result S1..1Reference(Example Lipid Profile)Cholesterol Result
... result S1..1Reference(Example Lipid Profile)Triglyceride Result
... result S1..1Reference(Example Lipid Profile)HDL Cholesterol Result
... result S0..1Reference(Example Lipid Profile)LDL Cholesterol result, if reported
... conclusion S0..1stringClinical Interpretation of Lipid Panel
... codedDiagnosis 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I1..1Lipid Lab Report
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for report
... basedOn 0..*Reference(CarePlan), Reference(ImmunizationRecommendation), Reference(MedicationRequest), Reference(NutritionOrder), Reference(ServiceRequest)What was requested
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... category Σ0..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (example)
... code Σ1..1CodeableConceptLOINC Code for Lipid Panel with LDL
Binding: LOINC Diagnostic Report Codes (preferred)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"57698-3","display":"Lipid panel with direct LDL - Serum or Plasma"}]}
... subject Σ0..1Reference(Patient), Reference(Group), Reference(Device), Reference(Location)The subject of the report - usually, but not always, the patient
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)Health care event when test ordered
... effective[x] Σ0..1dateTime, PeriodClinically relevant time/time-period for report
... issued Σ0..1instantDateTime this version was made
... performer Σ0..*Reference(Practitioner), Reference(PractitionerRole), Reference(Organization), Reference(CareTeam)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner), Reference(PractitionerRole), Reference(Organization), Reference(CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result Reference(Observation)Observations - simple, or complex nested groups
Slice: Ordered, Closed by value:resolve().code
... result S1..1Reference(Example Lipid Profile)Cholesterol Result
... result S1..1Reference(Example Lipid Profile)Triglyceride Result
... result S1..1Reference(Example Lipid Profile)HDL Cholesterol Result
... result S0..1Reference(Example Lipid Profile)LDL Cholesterol result, if reported
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media ΣI0..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical Interpretation of Lipid Panel
... presentedForm 0..*AttachmentEntire report as issued

doco Documentation for this format

XML Template

<!-- Example Lipid Profile -->doco

<DiagnosticReport 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 report --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan)|Reference(ImmunizationRecommendation)|Reference(MedicationRequest)|Reference(NutritionOrder)|
   Reference(ServiceRequest) What was requested --></basedOn>
 <status value="[code]"/><!-- 1..1 registered | partial | preliminary | final +  -->
 <category><!-- 0..1 CodeableConcept Service category  --></category>
 <code><!-- 1..1 CodeableConcept LOINC Code for Lipid Panel with LDL  --></code>
 <subject><!-- 0..1 Reference(Patient)|Reference(Group)|Reference(Device)|Reference(Location) 
     The subject of the report - usually, but not always, the patient --></subject>
 <context><!-- 0..1 Reference(Encounter)|Reference(EpisodeOfCare) 
     Health care event when test ordered --></context>
 <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)|Reference(PractitionerRole)|Reference(Organization)|Reference(CareTeam) 
     Responsible Diagnostic Service --></performer>
 <resultsInterpreter><!-- 0..* Reference(Practitioner)|Reference(PractitionerRole)|Reference(Organization)|
   Reference(CareTeam) 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  --></modifierExtension>
  <comment value="[string]"/><!-- 0..1 Comment about the image (e.g. explanation) -->
  <link><!-- 1..1 Reference(Media) 
      Reference to the image source --></link>
 </media>
 <conclusion value="[string]"/><!-- 0..1 Clinical Interpretation of Lipid Panel -->
 <codedDiagnosis><!-- 0..0 CodeableConcept No codes for a lipid panel  --></codedDiagnosis>
 <presentedForm><!-- 0..* Attachment 
     Entire report as issued --></presentedForm>
</DiagnosticReport>

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 report
// value[x]: What was requested. One of these 5:
    "basedOn" : [{ Reference(CarePlan) }], //What was requested
    "basedOn" : [{ Reference(ImmunizationRecommendation) }], //What was requested
    "basedOn" : [{ Reference(MedicationRequest) }], //What was requested
    "basedOn" : [{ Reference(NutritionOrder) }], //What was requested
    "basedOn" : [{ Reference(ServiceRequest) }], //What was requested
    "status" : "<code>", // R! registered | partial | preliminary | final + 
    "category" : { CodeableConcept }, //Service category 
    "code" : { CodeableConcept }, // R! 
// value[x]: The subject of the report - usually, but not always, the patient. One of these 4:
    "subject" : { Reference(Patient) }, //The subject of the report - usually, but not always, the patient
    "subject" : { Reference(Group) }, //The subject of the report - usually, but not always, the patient
    "subject" : { Reference(Device) }, //The subject of the report - usually, but not always, the patient
    "subject" : { Reference(Location) }, //The subject of the report - usually, but not always, the patient
// value[x]: Health care event when test ordered. One of these 2:
    "context" : { Reference(Encounter) }, //Health care event when test ordered
    "context" : { Reference(EpisodeOfCare) }, //Health care event when test ordered
// value[x]: Clinically relevant time/time-period for report. One of these 2:
    "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for report
    "effectivePeriod" : { Period }, //Clinically relevant time/time-period for report
    "issued" : "<instant>", //DateTime this version was made
// value[x]: Responsible Diagnostic Service. One of these 4:
    "performer" : [{ Reference(Practitioner) }], //Responsible Diagnostic Service
    "performer" : [{ Reference(PractitionerRole) }], //Responsible Diagnostic Service
    "performer" : [{ Reference(Organization) }], //Responsible Diagnostic Service
    "performer" : [{ Reference(CareTeam) }] //Responsible Diagnostic Service
// value[x]: Primary result interpreter. One of these 4:
    "resultsInterpreter" : [{ Reference(Practitioner) }], //Primary result interpreter
    "resultsInterpreter" : [{ Reference(PractitionerRole) }], //Primary result interpreter
    "resultsInterpreter" : [{ Reference(Organization) }], //Primary result interpreter
    "resultsInterpreter" : [{ Reference(CareTeam) }], //Primary result interpreter
    "specimen" : [{ Reference(Specimen) }], //Specimens this report is based on
    "result" : [ //  sliced by value:resolve().code  in any order,  
      { // Cholesterol Result // R! 
        // from Element: extension
      },
      { // Triglyceride Result // R! 
        // from Element: extension
      },
      { // HDL Cholesterol Result // R! 
        // from Element: extension
      },
      { // LDL Cholesterol result, if reported //
        // from Element: extension
      }
    ],
    "imagingStudy" : [{ Reference(ImagingStudy) }], //Reference to full details of imaging associated with the diagnostic report
    "media" : [{ BackboneElement }], // C?Key images associated with this report
    "conclusion" : "<string>", //Clinical Interpretation of Lipid Panel
    "presentedForm" : [{ Attachment }], //Entire report as issued
  }

 

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

10.3.11.2.2 Terminology Bindings

PathNameConformanceValueSet
DiagnosticReport.languageCommon LanguagesextensibleCommon Languages
DiagnosticReport.statusDiagnosticReportStatusrequiredDiagnosticReportStatus
DiagnosticReport.categoryDiagnostic Service Section CodesexampleDiagnostic Service Section Codes
DiagnosticReport.codeLOINC Diagnostic Report CodespreferredLOINC Diagnostic Report Codes
.