STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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.2.12.2 StructureDefinition: LipidProfile

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.2.12.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 reference.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 reference.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
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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..*IdentifierId for external references to this report
... status ?!∑1..1coderegistered | partial | final | corrected | appended | cancelled | entered-in-error
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 ∑1..1Reference(Patient | Group | Device | Location)The subject of the report, usually, but not always, the patient
... encounter ∑0..1Reference(Encounter)Health care event when test ordered
... effective[x] ∑1..1dateTime, PeriodClinically Relevant time/time-period for report
... issued ∑1..1instantDateTime this version was released
... performer ∑1..*Reference(Practitioner | Organization)Responsible Diagnostic Service
... request 0..*Reference(DiagnosticRequest | ProcedureRequest | ReferralRequest)What was requested
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result Reference(Observation)Observations - simple, or complex nested groups
Slice: Ordered, Closed, by reference.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 | ImagingManifest)Reference to full details of imaging associated with the diagnostic report
... image ∑0..*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

todo

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 reference.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 reference.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
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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..*IdentifierId for external references to this report
... status ?!∑1..1coderegistered | partial | final | corrected | appended | cancelled | entered-in-error
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 ∑1..1Reference(Patient | Group | Device | Location)The subject of the report, usually, but not always, the patient
... encounter ∑0..1Reference(Encounter)Health care event when test ordered
... effective[x] ∑1..1dateTime, PeriodClinically Relevant time/time-period for report
... issued ∑1..1instantDateTime this version was released
... performer ∑1..*Reference(Practitioner | Organization)Responsible Diagnostic Service
... request 0..*Reference(DiagnosticRequest | ProcedureRequest | ReferralRequest)What was requested
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result Reference(Observation)Observations - simple, or complex nested groups
Slice: Ordered, Closed, by reference.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 | ImagingManifest)Reference to full details of imaging associated with the diagnostic report
... image ∑0..*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

JSON Template

todo

 

Other representations of profile: Schematron

10.2.12.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

10.2.12.2.3 Constraints

IdPathDetailsRequirements
dom-2DiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1DiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4DiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3DiagnosticReportIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.