Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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.13.2 StructureDefinition: Example Lipid Profile

Orders and Observations Work Group Maturity Level: 0Trial 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, Feb 21, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - FHIR WG.

10.3.13.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
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..1DiagnosticReportLipid Lab Report
... code 1..1CodeableConceptLOINC Code for Lipid Panel with LDL
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 57698-3
..... display1..1stringRepresentation 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 S1..1Reference(Example Lipid Profile)Cholesterol Result
.... result:Triglyceride S1..1Reference(Example Lipid Profile)Triglyceride Result
.... result:HDLCholesterol S1..1Reference(Example Lipid Profile)HDL Cholesterol Result
.... result:LDLCholesterol S0..1Reference(Example Lipid Profile)LDL Cholesterol result, if reported
... conclusion S0..1stringClinical Interpretation of Lipid Panel

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I1..1DiagnosticReportLipid 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
... text 0..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 | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)What was requested
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.

... category Σ0..*CodeableConceptService category
Binding: Diagnostic Service Section Codes (example): HL7 V2 table 0074


... code Σ1..1CodeableConceptLOINC Code for Lipid Panel with LDL
Binding: LOINC Diagnostic Report Codes (preferred): LOINC Codes for Diagnostic Reports


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 57698-3
..... display1..1stringRepresentation defined by the system
Fixed Value: Lipid panel with direct LDL - Serum or Plasma
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance)The subject of the report - usually, but not always, the patient
... encounter Σ0..1Reference(Encounter)Health care event when test ordered
... effective[x] Σ0..1Clinically relevant time/time-period for report
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDateTime this version was made
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result 3..4(Slice Definition)Observations
Slice: Ordered, Closed by value:resolve().code
.... result:Cholesterol S1..1Reference(Example Lipid Profile)Cholesterol Result
.... result:Triglyceride S1..1Reference(Example Lipid Profile)Triglyceride Result
.... result:HDLCholesterol S1..1Reference(Example Lipid Profile)HDL Cholesterol Result
.... result:LDLCholesterol 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 Σ0..*BackboneElementKey images associated with this report
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(DocumentReference)Reference to the image source
... composition 0..1Reference(Composition)Reference to a Composition resource for the DiagnosticReport structure
... 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) 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>
 <composition><!-- ?? 0..1 Reference(Composition) 
     Reference to a Composition resource for the DiagnosticReport structure --></composition>
 <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
    "composition" : { Reference(Composition) }, // C?Reference to a Composition resource for the DiagnosticReport structure
    "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
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..1DiagnosticReportLipid Lab Report
... code 1..1CodeableConceptLOINC Code for Lipid Panel with LDL
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 57698-3
..... display1..1stringRepresentation 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 S1..1Reference(Example Lipid Profile)Cholesterol Result
.... result:Triglyceride S1..1Reference(Example Lipid Profile)Triglyceride Result
.... result:HDLCholesterol S1..1Reference(Example Lipid Profile)HDL Cholesterol Result
.... result:LDLCholesterol S0..1Reference(Example Lipid Profile)LDL Cholesterol result, if reported
... conclusion S0..1stringClinical Interpretation of Lipid Panel

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I1..1DiagnosticReportLipid 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
... text 0..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 | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)What was requested
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.

... category Σ0..*CodeableConceptService category
Binding: Diagnostic Service Section Codes (example): HL7 V2 table 0074


... code Σ1..1CodeableConceptLOINC Code for Lipid Panel with LDL
Binding: LOINC Diagnostic Report Codes (preferred): LOINC Codes for Diagnostic Reports


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 57698-3
..... display1..1stringRepresentation defined by the system
Fixed Value: Lipid panel with direct LDL - Serum or Plasma
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance)The subject of the report - usually, but not always, the patient
... encounter Σ0..1Reference(Encounter)Health care event when test ordered
... effective[x] Σ0..1Clinically relevant time/time-period for report
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDateTime this version was made
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result 3..4(Slice Definition)Observations
Slice: Ordered, Closed by value:resolve().code
.... result:Cholesterol S1..1Reference(Example Lipid Profile)Cholesterol Result
.... result:Triglyceride S1..1Reference(Example Lipid Profile)Triglyceride Result
.... result:HDLCholesterol S1..1Reference(Example Lipid Profile)HDL Cholesterol Result
.... result:LDLCholesterol 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 Σ0..*BackboneElementKey images associated with this report
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(DocumentReference)Reference to the image source
... composition 0..1Reference(Composition)Reference to a Composition resource for the DiagnosticReport structure
... 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) 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>
 <composition><!-- ?? 0..1 Reference(Composition) 
     Reference to a Composition resource for the DiagnosticReport structure --></composition>
 <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
    "composition" : { Reference(Composition) }, // C?Reference to a Composition resource for the DiagnosticReport structure
    "conclusion" : "<string>", // C?Clinical Interpretation of Lipid Panel
    "presentedForm" : [{ Attachment }], // C?Entire report as issued
  }

 

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

10.3.13.2.2 Terminology Bindings

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